Skip to content

docs(metrics): Correct code examples in markdown #316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 7, 2021
Merged

docs(metrics): Correct code examples in markdown #316

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8cf29d9
docs(metrics): Correct code examples in markdown
michaelbrewer Mar 7, 2021
b2e801b
Merge branch 'develop' into docs-metrics-md
michaelbrewer Mar 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/core/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ This decorator also **validates**, **serializes**, and **flushes** all your metr

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

metrics = Metrics()

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

metrics.add_metric(name="ColdStart", unit="Count", value=1)
metrics.add_metric(name="ColdStart", unit=MetricUnit.Count, value=1)

@metrics.log_metrics
@tracer.capture_lambda_handler
def lambda_handler(evt, ctx):
metrics.add_metric(name="BookingConfirmation", unit="Count", value=1)
metrics.add_metric(name="BookingConfirmation", unit=MetricUnit.Count, value=1)
...
```

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

```python hl_lines="6"
from aws_lambda_powertools import Metrics
from aws_lambda_powertools.metrics import MetricUnit

metrics = Metrics(service="ExampleService")

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

metrics = Metrics(namespace="ExampleApplication", service="booking")
metrics.add_metric(name="ColdStart", unit="Count", value=1)
metrics.add_metric(name="ColdStart", unit=MetricUnit.Count, value=1)

your_metrics_object = metrics.serialize_metric_set()
metrics.clear_metrics()
Expand Down