software.amazon.lambda.powertools.metrics

Class MetricsUtils

java.lang.Object

software.amazon.lambda.powertools.metrics.MetricsUtils

public final class MetricsUtils
extends java.lang.Object

A class used to retrieve the instance of the MetricsLogger used by Metrics. Metrics

Method Summary

Modifier and Type	Method and Description
static void	defaultDimensions(software.amazon.cloudwatchlogs.emf.model.DimensionSet... dimensionSets) Configure default dimension to be used by logger.
static void	defaultDimensionSet(software.amazon.cloudwatchlogs.emf.model.DimensionSet dimensionSet) Deprecated. use defaultDimensions(DimensionSet...) instead
static software.amazon.cloudwatchlogs.emf.model.DimensionSet[]	getDefaultDimensions()
static boolean	hasDefaultDimension()
static software.amazon.cloudwatchlogs.emf.logger.MetricsLogger	metricsLogger() The instance of the MetricsLogger used by Metrics.
static void	withSingleMetric(java.lang.String name, double value, software.amazon.cloudwatchlogs.emf.model.Unit unit, java.util.function.Consumer<software.amazon.cloudwatchlogs.emf.logger.MetricsLogger> logger) Add and immediately flush a single metric.
static void	withSingleMetric(java.lang.String name, double value, software.amazon.cloudwatchlogs.emf.model.Unit unit, java.lang.String namespace, java.util.function.Consumer<software.amazon.cloudwatchlogs.emf.logger.MetricsLogger> logger) Add and immediately flush a single metric.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

metricsLogger

public static software.amazon.cloudwatchlogs.emf.logger.MetricsLogger metricsLogger()

The instance of the MetricsLogger used by Metrics.

Returns:

The instance of the MetricsLogger used by Metrics.

defaultDimensions

public static void defaultDimensions(software.amazon.cloudwatchlogs.emf.model.DimensionSet... dimensionSets)

Configure default dimension to be used by logger. By default, @Metrics annotation captures configured service as a dimension Service

Parameters:

dimensionSets - Default value of dimensions set for logger

defaultDimensionSet

@Deprecated
public static void defaultDimensionSet(software.amazon.cloudwatchlogs.emf.model.DimensionSet dimensionSet)

Deprecated. use defaultDimensions(DimensionSet...) instead

Configure default dimension to be used by logger. By default, @Metrics annotation captures configured service as a dimension Service

Parameters:

dimensionSet - Default value of dimension set for logger

withSingleMetric

public static void withSingleMetric(java.lang.String name,
                                    double value,
                                    software.amazon.cloudwatchlogs.emf.model.Unit unit,
                                    java.util.function.Consumer<software.amazon.cloudwatchlogs.emf.logger.MetricsLogger> logger)

Add and immediately flush a single metric. It will use the default namespace specified either on Metrics annotation or via POWERTOOLS_METRICS_NAMESPACE env var. It by default captures function_request_id as property if used together with Metrics annotation. It will also capture xray_trace_id as property if tracing is enabled.

Parameters:

name - the name of the metric

value - the value of the metric

unit - the unit type of the metric

logger - the MetricsLogger

withSingleMetric

public static void withSingleMetric(java.lang.String name,
                                    double value,
                                    software.amazon.cloudwatchlogs.emf.model.Unit unit,
                                    java.lang.String namespace,
                                    java.util.function.Consumer<software.amazon.cloudwatchlogs.emf.logger.MetricsLogger> logger)

Add and immediately flush a single metric. It by default captures function_request_id as property if used together with Metrics annotation. It will also capture xray_trace_id as property if tracing is enabled.

Parameters:

name - the name of the metric

value - the value of the metric

unit - the unit type of the metric

namespace - the namespace associated with the metric

logger - the MetricsLogger

getDefaultDimensions

public static software.amazon.cloudwatchlogs.emf.model.DimensionSet[] getDefaultDimensions()

hasDefaultDimension

public static boolean hasDefaultDimension()