Skip to content

Commit fe09376

Browse files
fix(metrics): skip non-finite metric values in DatadogProvider (#8845)
Signed-off-by: dhairyakhandelwal880-dotcom <dhairyakhandelwal880@gmail.com>
1 parent 379929b commit fe09376

3 files changed

Lines changed: 38 additions & 0 deletions

File tree

‎aws_lambda_powertools/metrics/provider/datadog/datadog.py‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import json
44
import logging
5+
import math
56
import numbers
67
import os
78
import re
@@ -15,6 +16,7 @@
1516
from aws_lambda_powertools.metrics.provider.datadog.warnings import DatadogDataValidationWarning
1617
from aws_lambda_powertools.shared import constants
1718
from aws_lambda_powertools.shared.functions import resolve_env_var_choice, strtobool
19+
from aws_lambda_powertools.warnings import PowertoolsUserWarning
1820

1921
if TYPE_CHECKING:
2022
from aws_lambda_powertools.shared.types import AnyCallableT
@@ -119,6 +121,15 @@ def add_metric(
119121
if not isinstance(value, numbers.Real):
120122
raise MetricValueError(f"{value} is not a valid number")
121123

124+
if not math.isfinite(value):
125+
warnings.warn(
126+
f"The metric {name} has a non-finite value ({value}) and won't be added. "
127+
"Datadog only accepts finite numbers.",
128+
category=PowertoolsUserWarning,
129+
stacklevel=2,
130+
)
131+
return
132+
122133
if not timestamp:
123134
timestamp = int(time.time())
124135

‎docs/core/metrics/datadog.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,9 @@ By default, we will generate the current timestamp for you. Alternatively, you c
7979
--8<-- "examples/metrics_datadog/src/add_metrics_with_timestamp.py"
8080
```
8181

82+
???+ note "Note: Non-finite values"
83+
Datadog only accepts finite numbers. `add_metric` skips a `NaN` or infinite value and emits a `PowertoolsUserWarning`.
84+
8285
???+ warning "Warning: Do not create metrics outside the handler"
8386
Metrics added in the global scope will only be added during cold start. Disregard if you that's the intended behavior.
8487

‎tests/functional/metrics/datadog/test_metrics_datadog.py‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
from aws_lambda_powertools.metrics.exceptions import MetricValueError, SchemaValidationError
1010
from aws_lambda_powertools.metrics.provider.cold_start import reset_cold_start_flag
1111
from aws_lambda_powertools.metrics.provider.datadog import DatadogMetrics, DatadogProvider
12+
from aws_lambda_powertools.warnings import PowertoolsUserWarning
1213

1314

1415
def test_datadog_coldstart(capsys):
@@ -125,6 +126,29 @@ def test_datadog_with_invalid_metric_value():
125126
metrics.add_metric(name="item_sold", value="a", product="latte", order="online")
126127

127128

129+
def _reject_non_finite(constant: str):
130+
raise ValueError(f"Datadog output contains {constant}, which is not valid JSON")
131+
132+
133+
@pytest.mark.parametrize("value", [float("nan"), float("inf"), float("-inf")])
134+
def test_datadog_add_metric_with_non_finite_value(capsys, value):
135+
# GIVEN DatadogMetrics is initialized with flush_to_log
136+
dd_provider = DatadogProvider(flush_to_log=True)
137+
metrics = DatadogMetrics(provider=dd_provider)
138+
139+
# WHEN we add a non-finite metric value next to a valid metric
140+
with pytest.warns(PowertoolsUserWarning, match="The metric bad_metric has a non-finite value *"):
141+
metrics.add_metric(name="bad_metric", value=value)
142+
metrics.add_metric(name="good_metric", value=1.0)
143+
metrics.flush_metrics()
144+
145+
# THEN the flushed log is valid JSON and only contains the valid metric
146+
output = capsys.readouterr().out.strip()
147+
logs = json.loads(output, parse_constant=_reject_non_finite)
148+
assert logs["m"] == "good_metric"
149+
assert logs["v"] == 1.0
150+
151+
128152
def test_datadog_with_invalid_metric_name():
129153
# GIVEN DatadogMetrics is initialized
130154
metrics = DatadogMetrics()

0 commit comments

Comments
 (0)