software.amazon.kinesis.metrics

Interface MetricsScope

All Known Implementing Classes:

AccumulateByNameMetricsScope, AccumulatingMetricsScope, CloudWatchMetricsScope, DimensionTrackingMetricsScope, EndingMetricsScope, FilteringMetricsScope, LogMetricsScope, NullMetricsScope, OtelMetricsScope, ThreadSafeMetricsDelegatingScope

public interface MetricsScope

An IMetricsScope represents a set of metric data that share a set of dimensions. IMetricsScopes know how to output themselves (perhaps to disk, perhaps over service calls, etc).

Ordering contract: All addDimension(java.lang.String, java.lang.String) calls should be made before any addData(java.lang.String, double, software.amazon.awssdk.services.cloudwatch.model.StandardUnit) calls. Some implementations (e.g., OtelMetricsScope) record observations immediately on addData with the dimensions accumulated so far. Dimensions added after addData may not be attached to earlier observations. // TODO: Consider extending AutoCloseable so callers can use try-with-resources // instead of manual try/finally with end(). This would help ensure end() is // always called and reduce boilerplate across the codebase.

Field Summary

Fields

Modifier and Type	Field and Description
static String	METRICS_DIMENSIONS_ALL Value that signifies that all dimensions are allowed for the 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.

Field Detail

METRICS_DIMENSIONS_ALL

static final String METRICS_DIMENSIONS_ALL

Value that signifies that all dimensions are allowed for the metrics scope.

See Also:

Constant Field Values

Method Detail

addData

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

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

Parameters:

name - data point name

value - data point value

unit - unit of data point

addData

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. Multiple calls against the same IMetricsScope with the same name parameter will result in accumulation.

Parameters:

name - data point name

value - data point value

unit - unit of data point

level - metrics level of this data point

addDimension

void addDimension(String name,
                  String value)

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

Parameters:

name - dimension name

value - dimension value

end

void end()

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