Skip to content

Commit 6f887a7

Browse files
author
Michael Brewer
committed
docs(metrics): Corrections to the code examples
1 parent b6e61e2 commit 6f887a7

File tree

3 files changed

+11
-12
lines changed

3 files changed

+11
-12
lines changed

aws_lambda_powertools/metrics/base.py

+1-3
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ def serialize_metric_set(self, metrics: Dict = None, dimensions: Dict = None, me
197197
metric_names_and_units.append({"Name": metric_name, "Unit": metric_unit})
198198
metric_names_and_values.update({metric_name: metric_value})
199199

200-
embedded_metrics_object = {
200+
return {
201201
"_aws": {
202202
"Timestamp": int(datetime.datetime.now().timestamp() * 1000), # epoch
203203
"CloudWatchMetrics": [
@@ -213,8 +213,6 @@ def serialize_metric_set(self, metrics: Dict = None, dimensions: Dict = None, me
213213
**metric_names_and_values, # "single_metric": 1.0
214214
}
215215

216-
return embedded_metrics_object
217-
218216
def add_dimension(self, name: str, value: str):
219217
"""Adds given dimension to all metrics
220218

aws_lambda_powertools/metrics/metric.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ class SingleMetric(MetricManager):
2727
-------
2828
**Creates cold start metric with function_version as dimension**
2929
30-
from aws_lambda_powertools.metrics import SingleMetric, MetricUnit
3130
import json
32-
metric = Single_Metric(namespace="ServerlessAirline")
31+
from aws_lambda_powertools.metrics import single_metric, MetricUnit
32+
metric = single_metric(namespace="ServerlessAirline")
3333
3434
metric.add_metric(name="ColdStart", unit=MetricUnit.Count, value=1)
3535
metric.add_dimension(name="function_version", value=47)
@@ -72,7 +72,7 @@ def single_metric(name: str, unit: MetricUnit, value: float, namespace: str = No
7272
from aws_lambda_powertools.metrics import MetricUnit
7373
7474
with single_metric(name="ColdStart", unit=MetricUnit.Count, value=1, namespace="ServerlessAirline") as metric:
75-
metric.add_dimension(name="function_version", value=47)
75+
metric.add_dimension(name="function_version", value="47")
7676
7777
**Same as above but set namespace using environment variable**
7878
@@ -82,7 +82,7 @@ def single_metric(name: str, unit: MetricUnit, value: float, namespace: str = No
8282
from aws_lambda_powertools.metrics import MetricUnit
8383
8484
with single_metric(name="ColdStart", unit=MetricUnit.Count, value=1) as metric:
85-
metric.add_dimension(name="function_version", value=47)
85+
metric.add_dimension(name="function_version", value="47")
8686
8787
Parameters
8888
----------

aws_lambda_powertools/metrics/metrics.py

+6-5
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,13 @@ class Metrics(MetricManager):
3939
metrics.add_dimension(name="function_version", value="$LATEST")
4040
...
4141
42-
@tracer.capture_lambda_handler
4342
@metrics.log_metrics()
4443
def lambda_handler():
45-
do_something()
46-
return True
44+
do_something()
45+
return True
4746
4847
def do_something():
49-
metrics.add_metric(name="Something", unit="Count", value=1)
48+
metrics.add_metric(name="Something", unit="Count", value=1)
5049
5150
Environment variables
5251
---------------------
@@ -111,12 +110,14 @@ def log_metrics(
111110
-------
112111
**Lambda function using tracer and metrics decorators**
113112
113+
from aws_lambda_powertools import Metrics, Tracer
114+
114115
metrics = Metrics(service="payment")
115116
tracer = Tracer(service="payment")
116117
117118
@tracer.capture_lambda_handler
118119
@metrics.log_metrics
119-
def handler(event, context):
120+
def handler(event, context):
120121
...
121122
122123
Parameters

0 commit comments

Comments
 (0)