Package org.opensearch.telemetry.metrics

Interface MetricsRegistry

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

MetricsTelemetry

All Known Implementing Classes:

NoopMetricsRegistry

@ExperimentalApi
public interface MetricsRegistry
extends Closeable

MetricsRegistry helps in creating the metric instruments.

Opensearch.experimental:

Method Summary

Modifier and Type	Method	Description
Counter	createCounter(String name, String description, String unit)	Creates the counter.
Counter	createUpDownCounter(String name, String description, String unit)	Creates the upDown counter.

Methods inherited from interface java.io.Closeable

close

Method Details

createCounter

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

Creates the counter.

Parameters:

name - name of the counter.

description - any description about the metric.

unit - unit of the metric.

Returns:

counter.

createUpDownCounter

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

Creates the upDown counter.

Parameters:

name - name of the upDown counter.

description - any description about the metric.

unit - unit of the metric.

Returns:

counter.