Package org.opensearch.telemetry.metrics

Class OTelMetricsTelemetry<T extends io.opentelemetry.api.metrics.MeterProvider & Closeable>

java.lang.Object

org.opensearch.telemetry.metrics.OTelMetricsTelemetry<T>

All Implemented Interfaces:

Closeable, AutoCloseable, MetricsRegistry, MetricsTelemetry

public class OTelMetricsTelemetry<T extends io.opentelemetry.api.metrics.MeterProvider & Closeable>
extends Object
implements MetricsTelemetry

OTel implementation for MetricsTelemetry

Constructor Summary

Constructors

Constructor	Description
OTelMetricsTelemetry(RefCountedReleasable<io.opentelemetry.sdk.OpenTelemetrySdk> openTelemetry, T meterProvider)	Creates OTel based MetricsTelemetry.

Method Summary

Modifier and Type	Method	Description
void	close()
Counter	createCounter(String name, String description, String unit)
Closeable	createGauge(String name, String description, String unit, Supplier<Double> valueProvider, org.opensearch.telemetry.metrics.tags.Tags tags)
Closeable	createGauge(String name, String description, String unit, Supplier<TaggedMeasurement> value)
Histogram	createHistogram(String name, String description, String unit)	Creates the Otel Histogram.
Counter	createUpDownCounter(String name, String description, String unit)

Methods inherited from class java.lang.Object

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

Constructor Details

OTelMetricsTelemetry

public OTelMetricsTelemetry(RefCountedReleasable<io.opentelemetry.sdk.OpenTelemetrySdk> openTelemetry,
 T meterProvider)

Creates OTel based MetricsTelemetry.

Parameters:

openTelemetry - open telemetry.

meterProvider - MeterProvider instance

Method Details

createCounter

public Counter createCounter(String name,
 String description,
 String unit)

Specified by:

createCounter in interface MetricsRegistry

createUpDownCounter

public Counter createUpDownCounter(String name,
 String description,
 String unit)

Specified by:

createUpDownCounter in interface MetricsRegistry

createHistogram

public Histogram createHistogram(String name,
 String description,
 String unit)

Creates the Otel Histogram. In OTelResourceProvider we can configure the bucketing/aggregation strategy through view. Default startegy configured is the Base2ExponentialHistogramAggregation.

Specified by:

createHistogram in interface MetricsRegistry

Parameters:

name - name of the histogram.

description - any description about the metric.

unit - unit of the metric.

Returns:

histogram

createGauge

public Closeable createGauge(String name,
 String description,
 String unit,
 Supplier<Double> valueProvider,
 org.opensearch.telemetry.metrics.tags.Tags tags)

Specified by:

createGauge in interface MetricsRegistry

createGauge

public Closeable createGauge(String name,
 String description,
 String unit,
 Supplier<TaggedMeasurement> value)

Specified by:

createGauge in interface MetricsRegistry

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException