Package org.apache.solr.metrics

Class SolrMetricsContext

java.lang.Object

org.apache.solr.metrics.SolrMetricsContext

public class SolrMetricsContext
extends Object

This class represents a metrics context that ties together components with the same life-cycle and provides convenient access to the metric registry.

Additionally it's used for registering and reporting metrics specific to the components that use the same instance of context.

Constructor Summary

Constructors

Constructor	Description
SolrMetricsContext(SolrMetricManager metricManager, String registryName)

Method Summary

Modifier and Type	Method	Description
io.opentelemetry.api.metrics.BatchCallback	batchCallback(Runnable callback, io.opentelemetry.api.metrics.ObservableMeasurement measurement, io.opentelemetry.api.metrics.ObservableMeasurement... additionalMeasurements)
io.opentelemetry.api.metrics.DoubleCounter	doubleCounter(String metricName, String description)
io.opentelemetry.api.metrics.DoubleCounter	doubleCounter(String metricName, String description, OtelUnit unit)
io.opentelemetry.api.metrics.ObservableDoubleMeasurement	doubleCounterMeasurement(String metricName, String description)
io.opentelemetry.api.metrics.ObservableDoubleMeasurement	doubleCounterMeasurement(String metricName, String description, OtelUnit unit)
io.opentelemetry.api.metrics.DoubleGauge	doubleGauge(String metricName, String description)
io.opentelemetry.api.metrics.DoubleGauge	doubleGauge(String metricName, String description, OtelUnit unit)
io.opentelemetry.api.metrics.ObservableDoubleMeasurement	doubleGaugeMeasurement(String metricName, String description)
io.opentelemetry.api.metrics.ObservableDoubleMeasurement	doubleGaugeMeasurement(String metricName, String description, OtelUnit unit)
io.opentelemetry.api.metrics.DoubleHistogram	doubleHistogram(String metricName, String description)
io.opentelemetry.api.metrics.DoubleHistogram	doubleHistogram(String metricName, String description, OtelUnit unit)
io.opentelemetry.api.metrics.DoubleUpDownCounter	doubleUpDownCounter(String metricName, String description)
io.opentelemetry.api.metrics.DoubleUpDownCounter	doubleUpDownCounter(String metricName, String description, OtelUnit unit)
SolrMetricsContext	getChildContext(Object child)	Get a context with the same registry name but a tag that represents a parent-child relationship.
SolrMetricManager	getMetricManager()	Return the instance of SolrMetricManager used in this context.
String	getRegistryName()	Return metric registry name used in this context.
ExecutorService	instrumentedExecutorService(ExecutorService delegate, String metricNamePrefix, String executorName, SolrInfoBean.Category category)	Returns an instrumented wrapper over the given executor service.
io.opentelemetry.api.metrics.LongCounter	longCounter(String metricName, String description)
io.opentelemetry.api.metrics.LongCounter	longCounter(String metricName, String description, OtelUnit unit)
io.opentelemetry.api.metrics.ObservableLongMeasurement	longCounterMeasurement(String metricName, String description)
io.opentelemetry.api.metrics.ObservableLongMeasurement	longCounterMeasurement(String metricName, String description, OtelUnit unit)
io.opentelemetry.api.metrics.LongGauge	longGauge(String metricName, String description)
io.opentelemetry.api.metrics.LongGauge	longGauge(String metricName, String description, OtelUnit unit)
io.opentelemetry.api.metrics.ObservableLongMeasurement	longGaugeMeasurement(String metricName, String description)
io.opentelemetry.api.metrics.ObservableLongMeasurement	longGaugeMeasurement(String metricName, String description, OtelUnit unit)
io.opentelemetry.api.metrics.LongHistogram	longHistogram(String metricName, String description)
io.opentelemetry.api.metrics.LongHistogram	longHistogram(String metricName, String description, OtelUnit unit)
io.opentelemetry.api.metrics.LongUpDownCounter	longUpDownCounter(String metricName, String description)
io.opentelemetry.api.metrics.LongUpDownCounter	longUpDownCounter(String metricName, String description, OtelUnit unit)
io.opentelemetry.api.metrics.ObservableDoubleCounter	observableDoubleCounter(String metricName, String description, Consumer<io.opentelemetry.api.metrics.ObservableDoubleMeasurement> callback)
io.opentelemetry.api.metrics.ObservableDoubleCounter	observableDoubleCounter(String metricName, String description, Consumer<io.opentelemetry.api.metrics.ObservableDoubleMeasurement> callback, OtelUnit unit)
io.opentelemetry.api.metrics.ObservableDoubleGauge	observableDoubleGauge(String metricName, String description, Consumer<io.opentelemetry.api.metrics.ObservableDoubleMeasurement> callback)
io.opentelemetry.api.metrics.ObservableDoubleGauge	observableDoubleGauge(String metricName, String description, Consumer<io.opentelemetry.api.metrics.ObservableDoubleMeasurement> callback, OtelUnit unit)
io.opentelemetry.api.metrics.ObservableLongCounter	observableLongCounter(String metricName, String description, Consumer<io.opentelemetry.api.metrics.ObservableLongMeasurement> callback)
io.opentelemetry.api.metrics.ObservableLongCounter	observableLongCounter(String metricName, String description, Consumer<io.opentelemetry.api.metrics.ObservableLongMeasurement> callback, OtelUnit unit)
io.opentelemetry.api.metrics.ObservableLongGauge	observableLongGauge(String metricName, String description, Consumer<io.opentelemetry.api.metrics.ObservableLongMeasurement> callback)
io.opentelemetry.api.metrics.ObservableLongGauge	observableLongGauge(String metricName, String description, Consumer<io.opentelemetry.api.metrics.ObservableLongMeasurement> callback, OtelUnit unit)
void	unregister()

Methods inherited from class java.lang.Object

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

Constructor Details

SolrMetricsContext

public SolrMetricsContext(SolrMetricManager metricManager,
 String registryName)

Method Details

getRegistryName

public String getRegistryName()

Return metric registry name used in this context.

getMetricManager

public SolrMetricManager getMetricManager()

Return the instance of SolrMetricManager used in this context.

getChildContext

public SolrMetricsContext getChildContext(Object child)

Get a context with the same registry name but a tag that represents a parent-child relationship. Since it's a different tag than the parent's context it is assumed that the life-cycle of the parent and child are different.

Parameters:

child - child object that produces metrics with a different life-cycle than the parent.

longCounter

public io.opentelemetry.api.metrics.LongCounter longCounter(String metricName,
 String description)

longCounter

public io.opentelemetry.api.metrics.LongCounter longCounter(String metricName,
 String description,
 OtelUnit unit)

longUpDownCounter

public io.opentelemetry.api.metrics.LongUpDownCounter longUpDownCounter(String metricName,
 String description)

longUpDownCounter

public io.opentelemetry.api.metrics.LongUpDownCounter longUpDownCounter(String metricName,
 String description,
 OtelUnit unit)

doubleCounter

public io.opentelemetry.api.metrics.DoubleCounter doubleCounter(String metricName,
 String description)

doubleCounter

public io.opentelemetry.api.metrics.DoubleCounter doubleCounter(String metricName,
 String description,
 OtelUnit unit)

doubleUpDownCounter

public io.opentelemetry.api.metrics.DoubleUpDownCounter doubleUpDownCounter(String metricName,
 String description)

doubleUpDownCounter

public io.opentelemetry.api.metrics.DoubleUpDownCounter doubleUpDownCounter(String metricName,
 String description,
 OtelUnit unit)

doubleHistogram

public io.opentelemetry.api.metrics.DoubleHistogram doubleHistogram(String metricName,
 String description)

doubleHistogram

public io.opentelemetry.api.metrics.DoubleHistogram doubleHistogram(String metricName,
 String description,
 OtelUnit unit)

longHistogram

public io.opentelemetry.api.metrics.LongHistogram longHistogram(String metricName,
 String description)

longHistogram

public io.opentelemetry.api.metrics.LongHistogram longHistogram(String metricName,
 String description,
 OtelUnit unit)

longGauge

public io.opentelemetry.api.metrics.LongGauge longGauge(String metricName,
 String description)

longGauge

public io.opentelemetry.api.metrics.LongGauge longGauge(String metricName,
 String description,
 OtelUnit unit)

doubleGauge

public io.opentelemetry.api.metrics.DoubleGauge doubleGauge(String metricName,
 String description)

doubleGauge

public io.opentelemetry.api.metrics.DoubleGauge doubleGauge(String metricName,
 String description,
 OtelUnit unit)

observableLongGauge

public io.opentelemetry.api.metrics.ObservableLongGauge observableLongGauge(String metricName,
 String description,
 Consumer<io.opentelemetry.api.metrics.ObservableLongMeasurement> callback)

observableLongGauge

public io.opentelemetry.api.metrics.ObservableLongGauge observableLongGauge(String metricName,
 String description,
 Consumer<io.opentelemetry.api.metrics.ObservableLongMeasurement> callback,
 OtelUnit unit)

observableDoubleGauge

public io.opentelemetry.api.metrics.ObservableDoubleGauge observableDoubleGauge(String metricName,
 String description,
 Consumer<io.opentelemetry.api.metrics.ObservableDoubleMeasurement> callback)

observableDoubleGauge

public io.opentelemetry.api.metrics.ObservableDoubleGauge observableDoubleGauge(String metricName,
 String description,
 Consumer<io.opentelemetry.api.metrics.ObservableDoubleMeasurement> callback,
 OtelUnit unit)

observableLongCounter

public io.opentelemetry.api.metrics.ObservableLongCounter observableLongCounter(String metricName,
 String description,
 Consumer<io.opentelemetry.api.metrics.ObservableLongMeasurement> callback)

observableLongCounter

public io.opentelemetry.api.metrics.ObservableLongCounter observableLongCounter(String metricName,
 String description,
 Consumer<io.opentelemetry.api.metrics.ObservableLongMeasurement> callback,
 OtelUnit unit)

observableDoubleCounter

public io.opentelemetry.api.metrics.ObservableDoubleCounter observableDoubleCounter(String metricName,
 String description,
 Consumer<io.opentelemetry.api.metrics.ObservableDoubleMeasurement> callback)

observableDoubleCounter

public io.opentelemetry.api.metrics.ObservableDoubleCounter observableDoubleCounter(String metricName,
 String description,
 Consumer<io.opentelemetry.api.metrics.ObservableDoubleMeasurement> callback,
 OtelUnit unit)

longGaugeMeasurement

public io.opentelemetry.api.metrics.ObservableLongMeasurement longGaugeMeasurement(String metricName,
 String description)

longGaugeMeasurement

public io.opentelemetry.api.metrics.ObservableLongMeasurement longGaugeMeasurement(String metricName,
 String description,
 OtelUnit unit)

doubleGaugeMeasurement

public io.opentelemetry.api.metrics.ObservableDoubleMeasurement doubleGaugeMeasurement(String metricName,
 String description)

doubleGaugeMeasurement

public io.opentelemetry.api.metrics.ObservableDoubleMeasurement doubleGaugeMeasurement(String metricName,
 String description,
 OtelUnit unit)

longCounterMeasurement

public io.opentelemetry.api.metrics.ObservableLongMeasurement longCounterMeasurement(String metricName,
 String description)

longCounterMeasurement

public io.opentelemetry.api.metrics.ObservableLongMeasurement longCounterMeasurement(String metricName,
 String description,
 OtelUnit unit)

doubleCounterMeasurement

public io.opentelemetry.api.metrics.ObservableDoubleMeasurement doubleCounterMeasurement(String metricName,
 String description)

doubleCounterMeasurement

public io.opentelemetry.api.metrics.ObservableDoubleMeasurement doubleCounterMeasurement(String metricName,
 String description,
 OtelUnit unit)

batchCallback

public io.opentelemetry.api.metrics.BatchCallback batchCallback(Runnable callback,
 io.opentelemetry.api.metrics.ObservableMeasurement measurement,
 io.opentelemetry.api.metrics.ObservableMeasurement... additionalMeasurements)

instrumentedExecutorService

public ExecutorService instrumentedExecutorService(ExecutorService delegate,
 String metricNamePrefix,
 String executorName,
 SolrInfoBean.Category category)

Returns an instrumented wrapper over the given executor service.

unregister

public void unregister()