Skip to content

Commit 6c31cc6

Browse files
author
Michael Brewer
authored
docs(metrics): Correct code examples in markdown (#316)
1 parent 5ff76b7 commit 6c31cc6

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

Diff for: docs/core/metrics.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ This decorator also **validates**, **serializes**, and **flushes** all your metr
114114

115115
@metrics.log_metrics
116116
def lambda_handler(evt, ctx):
117-
metrics.add_metric(name="BookingConfirmation", unit="Count", value=1)
117+
metrics.add_metric(name="BookingConfirmation", unit=MetricUnit.Count, value=1)
118118
...
119119
```
120120
=== "Example CloudWatch Logs excerpt"
@@ -162,6 +162,8 @@ If you want to ensure that at least one metric is emitted, you can pass `raise_o
162162
```python hl_lines="3"
163163
from aws_lambda_powertools.metrics import Metrics
164164

165+
metrics = Metrics()
166+
165167
@metrics.log_metrics(raise_on_empty_metrics=True)
166168
def lambda_handler(evt, ctx):
167169
...
@@ -183,12 +185,12 @@ When using multiple middlewares, use `log_metrics` as your **last decorator** wr
183185
tracer = Tracer(service="booking")
184186
metrics = Metrics(namespace="ExampleApplication", service="booking")
185187

186-
metrics.add_metric(name="ColdStart", unit="Count", value=1)
188+
metrics.add_metric(name="ColdStart", unit=MetricUnit.Count, value=1)
187189

188190
@metrics.log_metrics
189191
@tracer.capture_lambda_handler
190192
def lambda_handler(evt, ctx):
191-
metrics.add_metric(name="BookingConfirmation", unit="Count", value=1)
193+
metrics.add_metric(name="BookingConfirmation", unit=MetricUnit.Count, value=1)
192194
...
193195
```
194196

@@ -200,7 +202,6 @@ You can optionally capture cold start metrics with `log_metrics` decorator via `
200202

201203
```python hl_lines="6"
202204
from aws_lambda_powertools import Metrics
203-
from aws_lambda_powertools.metrics import MetricUnit
204205

205206
metrics = Metrics(service="ExampleService")
206207

@@ -300,7 +301,7 @@ If you prefer not to use `log_metrics` because you might want to encapsulate add
300301
from aws_lambda_powertools.metrics import MetricUnit
301302

302303
metrics = Metrics(namespace="ExampleApplication", service="booking")
303-
metrics.add_metric(name="ColdStart", unit="Count", value=1)
304+
metrics.add_metric(name="ColdStart", unit=MetricUnit.Count, value=1)
304305

305306
your_metrics_object = metrics.serialize_metric_set()
306307
metrics.clear_metrics()

0 commit comments

Comments
 (0)