software.amazon.kinesis.metrics

Class OtelMetricsScope

java.lang.Object

software.amazon.kinesis.metrics.OtelMetricsScope

All Implemented Interfaces:

MetricsScope

public class OtelMetricsScope
extends Object
implements MetricsScope

OTel-native metrics scope that implements MetricsScope directly. Records raw observations immediately on OTel Meter instruments (DoubleHistogram, DoubleCounter, DoubleGauge) as addData(java.lang.String, double, software.amazon.awssdk.services.cloudwatch.model.StandardUnit) is called. The OTel SDK (configured by the application owner) handles aggregation, batching, and export.

Dimensions must be added via addDimension(java.lang.String, java.lang.String) before calling addData(java.lang.String, double, software.amazon.awssdk.services.cloudwatch.model.StandardUnit), as observations are recorded immediately with the current set of accumulated attributes.

Field Summary

Fields inherited from interface software.amazon.kinesis.metrics.MetricsScope

METRICS_DIMENSIONS_ALL

Constructor Summary

Constructors

Constructor and Description
OtelMetricsScope(io.opentelemetry.api.metrics.Meter meter, MetricsLevel metricsLevel, Set<String> metricsEnabledDimensions) Creates an OTel-native metrics scope.

Method Summary

Modifier and Type	Method and Description
void	addData(String name, double value, software.amazon.awssdk.services.cloudwatch.model.StandardUnit unit) Adds a data point to this IMetricsScope.
void	addData(String name, double value, software.amazon.awssdk.services.cloudwatch.model.StandardUnit unit, MetricsLevel level) Adds a data point to this IMetricsScope if given metrics level is enabled.
void	addDimension(String name, String value) Adds a dimension that applies to all metrics in this IMetricsScope.
void	end() Flushes the data from this IMetricsScope and causes future calls to addData and addDimension to fail.

Methods inherited from class java.lang.Object

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

Constructor Detail

OtelMetricsScope

public OtelMetricsScope(io.opentelemetry.api.metrics.Meter meter,
                        MetricsLevel metricsLevel,
                        Set<String> metricsEnabledDimensions)

Creates an OTel-native metrics scope.

Parameters:

meter - the OTel Meter to record observations on

metricsLevel - the minimum metrics level threshold; data points below this are dropped

metricsEnabledDimensions - the set of dimension names to include; use MetricsScope.METRICS_DIMENSIONS_ALL to include all

Method Detail

addData

public void addData(String name,
                    double value,
                    software.amazon.awssdk.services.cloudwatch.model.StandardUnit unit)

Description copied from interface: MetricsScope

Adds a data point to this IMetricsScope. Multiple calls against the same IMetricsScope with the same name parameter will result in accumulation.

Specified by:

addData in interface MetricsScope

Parameters:

name - data point name

value - data point value

unit - unit of data point

addData

public void addData(String name,
                    double value,
                    software.amazon.awssdk.services.cloudwatch.model.StandardUnit unit,
                    MetricsLevel level)

Description copied from interface: MetricsScope

Adds a data point to this IMetricsScope if given metrics level is enabled. Multiple calls against the same IMetricsScope with the same name parameter will result in accumulation.

Specified by:

addData in interface MetricsScope

Parameters:

name - data point name

value - data point value

unit - unit of data point

level - metrics level of this data point

addDimension

public void addDimension(String name,
                         String value)

Description copied from interface: MetricsScope

Adds a dimension that applies to all metrics in this IMetricsScope.

Specified by:

addDimension in interface MetricsScope

Parameters:

name - dimension name

value - dimension value

end

public void end()

Description copied from interface: MetricsScope

Flushes the data from this IMetricsScope and causes future calls to addData and addDimension to fail.

Specified by:

end in interface MetricsScope