Namespace AWS.Lambda.Powertools.Metrics
Classes
DimensionSet
List of key-value pairs with Metric Dimensions
JsonNamingPolicyDecorator
Class JsonNamingPolicyDecorator Implements the JsonNamingPolicy
Metadata
Class Metadata.
MetricDefinition
Class MetricDefinition.
MetricDirective
Class MetricDirective.
MetricResolutionJsonConverter
Class MetricResolutionJsonConverter. Implements the JsonConverter<T>
Metrics
Class Metrics. Implements the IMetrics
MetricsAspect
MetricsAspect class is responsible for capturing ColdStart metric and flushing metrics on function exit. Scope.Global - means aspect will operate as singleton.
MetricsAttribute
Creates custom metrics asynchronously by logging metrics to
standard output following Amazon CloudWatch Embedded Metric Format (EMF).
Key features
---------------------
- Aggregate up to 100 metrics using a single CloudWatch EMF object (large JSON blob)
- Validate against common metric definitions mistakes (metric unit, values, max dimensions, max metrics, etc)
- Metrics are created asynchronously by CloudWatch service, no custom stacks needed
- Context manager to create a one off metric with a different dimension
Environment variables
---------------------
Variable name | Description |
---|---|
POWERTOOLS_SERVICE_NAME | string, service name |
POWERTOOLS_METRICS_NAMESPACE | string, metric namespace |
Parameters
-----------
Parameter name | Description |
---|---|
Service | string, service name is used for metric dimension |
Namespace | string, logical container where all metrics will be placed |
CaptureColdStart | bool, captures cold start during Lambda execution, by default false |
RaiseOnEmptyMetrics | bool, instructs metrics validation to throw exception if no metrics are provided, by default false |
MetricsBuilder
Provides a builder for configuring metrics.
MetricsContext
Class MetricsContext. Implements the IDisposable
MetricsOptions
Configuration options for AWS Lambda Powertools Metrics.
MetricsSerializationContext
Source generator for Metrics types
RootNode
Class RootNode.
SchemaValidationException
Class SchemaValidationException. Implements the Exception
UnixMillisecondDateTimeConverter
Class UnixMillisecondDateTimeConverter. Implements the JsonConverter
Interfaces
IMetrics
Interface for metrics operations.
Enums
MetricResolution
Enum MetricResolution
MetricUnit
Enum MetricUnit