Skip to content

Commit 705371e

Browse files
committed
docs: subtle rewording for better clarity
Signed-off-by: heitorlessa <[email protected]>
1 parent 44db087 commit 705371e

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs/content/core/metrics.mdx

+7-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ description: Core utility
55

66
import Note from "../../src/components/Note"
77

8-
Metrics creates custom metrics asynchronously via logging metrics to standard output following Amazon CloudWatch Embedded Metric Format (EMF).
8+
Metrics creates custom metrics asynchronously by logging metrics to standard output following Amazon CloudWatch Embedded Metric Format (EMF).
9+
10+
These metrics can be visualized through [Amazon CloudWatch Console](https://console.aws.amazon.com/cloudwatch/).
911

1012
**Key features**
1113

@@ -32,7 +34,9 @@ Resources:
3234
```
3335

3436
We recommend you use your application or main service as a metric namespace.
35-
You can explicitly set a namespace name via `namespace` param or via `POWERTOOLS_METRICS_NAMESPACE` env var. This sets **namespace** key that will be used for all metrics.
37+
You can explicitly set a namespace name via `namespace` param or via `POWERTOOLS_METRICS_NAMESPACE` env var.
38+
39+
This sets **namespace** key that will be used for all metrics.
3640
You can also pass a service name via `service` param or `POWERTOOLS_SERVICE_NAME` env var. This will create a dimension with the service name.
3741

3842
```python:title=app.py
@@ -67,7 +71,7 @@ metrics.add_metric(name="SuccessfulBooking", unit=MetricUnit.Count, value=1)
6771

6872
`MetricUnit` enum facilitate finding a supported metric unit by CloudWatch. Alternatively, you can pass the value as a string if you already know them e.g. "Count".
6973

70-
CloudWatch EMF supports a max of 100 metrics. Metrics will automatically flush all metrics when adding the 100th metric, where subsequent metrics will be aggregated into a new EMF object.
74+
CloudWatch EMF supports a max of 100 metrics. Metrics utility will flush all metrics when adding the 100th metric while subsequent metrics will be aggregated into a new EMF object, for your convenience.
7175

7276
## Creating a metric with a different dimension
7377

0 commit comments

Comments
 (0)