File size: 4,236 Bytes
26e6f31 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 | from __future__ import annotations
from datetime import datetime
from aws_lambda_powertools.metrics.provider.cloudwatch_emf.exceptions import (
MetricResolutionError,
MetricUnitError,
)
from aws_lambda_powertools.metrics.provider.cloudwatch_emf.metric_properties import MetricResolution, MetricUnit
from aws_lambda_powertools.shared import constants
def extract_cloudwatch_metric_resolution_value(metric_resolutions: list, resolution: int | MetricResolution) -> int:
"""Return metric value from CloudWatch metric unit whether that's str or MetricResolution enum
Parameters
----------
resolution : int | MetricResolution
Metric resolution
Returns
-------
int
Metric resolution value must be 1 or 60
Raises
------
MetricResolutionError
When metric resolution is not supported by CloudWatch
"""
if isinstance(resolution, MetricResolution):
return resolution.value
if isinstance(resolution, int) and resolution in metric_resolutions:
return resolution
raise MetricResolutionError(
f"Invalid metric resolution '{resolution}', expected either option: {metric_resolutions}", # noqa: E501
)
def extract_cloudwatch_metric_unit_value(metric_units: list, metric_valid_options: list, unit: str | MetricUnit) -> str:
"""Return metric value from CloudWatch metric unit whether that's str or MetricUnit enum
Parameters
----------
unit : str | MetricUnit
Metric unit
Returns
-------
str
Metric unit value (e.g. "Seconds", "Count/Second")
Raises
------
MetricUnitError
When metric unit is not supported by CloudWatch
"""
if isinstance(unit, str):
if unit in metric_valid_options:
unit = MetricUnit[unit].value
if unit not in metric_units:
raise MetricUnitError(
f"Invalid metric unit '{unit}', expected either option: {metric_valid_options}",
)
if isinstance(unit, MetricUnit):
unit = unit.value
return unit
def validate_emf_timestamp(timestamp: int | datetime) -> bool:
"""
Validates a given timestamp based on CloudWatch Timestamp guidelines.
Timestamp must meet CloudWatch requirements, otherwise an InvalidTimestampError will be raised.
See [Timestamps](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#about_timestamp)
for valid values.
Parameters:
----------
timestamp: int | datetime
Datetime object or epoch time in milliseconds representing the timestamp to validate.
Returns
-------
bool
Valid or not timestamp values
"""
if not isinstance(timestamp, (int, datetime)):
return False
if isinstance(timestamp, datetime):
# Converting timestamp to epoch time in milliseconds
timestamp = int(timestamp.timestamp() * 1000)
# Consider current timezone when working with date and time
current_timezone = datetime.now().astimezone().tzinfo
current_time = int(datetime.now(current_timezone).timestamp() * 1000)
min_valid_timestamp = current_time - constants.EMF_MAX_TIMESTAMP_PAST_AGE
max_valid_timestamp = current_time + constants.EMF_MAX_TIMESTAMP_FUTURE_AGE
return min_valid_timestamp <= timestamp <= max_valid_timestamp
def convert_timestamp_to_emf_format(timestamp: int | datetime) -> int:
"""
Converts a timestamp to EMF compatible format.
Parameters
----------
timestamp: int | datetime
The timestamp to convert. If already in epoch milliseconds format, returns it as is.
If datetime object, converts it to milliseconds since Unix epoch.
Returns:
--------
int
The timestamp converted to EMF compatible format (milliseconds since Unix epoch).
"""
if isinstance(timestamp, int):
return timestamp
try:
return int(round(timestamp.timestamp() * 1000))
except AttributeError:
# If this point is reached, it indicates timestamp is not a datetime object
# Returning zero represents the initial date of epoch time,
# which will be skipped by Amazon CloudWatch.
return 0
|