org.apache.rocketmq.shaded.io.opentelemetry.api.metrics.DefaultMeter Maven / Gradle / Ivy
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package org.apache.rocketmq.shaded.io.opentelemetry.api.metrics;
import org.apache.rocketmq.shaded.io.opentelemetry.api.common.Attributes;
import org.apache.rocketmq.shaded.io.opentelemetry.api.internal.ValidationUtil;
import org.apache.rocketmq.shaded.io.opentelemetry.context.Context;
import java.util.function.Consumer;
import javax.annotation.concurrent.ThreadSafe;
/**
* No-op implementations of {@link Meter}.
*
* This implementation should induce as close to zero overhead as possible.
*
*
A few notes from the specification on allowed behaviors leading to this design [Instrument
* Spec]:
*
*
* - Multiple Instruments with the same name under the same Meter MUST return an error
*
- Different Meters MUST be treated as separate namespaces
*
- Implementations MUST NOT require users to repeatedly obtain a Meter again with the same
* name+version+schema_url to pick up configuration changes. This can be achieved either by
* allowing to work with an outdated configuration or by ensuring that new configuration
* applies also to previously returned Meters.
*
- A MeterProvider could also return a no-op Meter here if application owners configure the
* SDK to suppress telemetry produced by this library
*
- In case an invalid name (null or empty string) is specified, a working Meter implementation
* MUST be returned as a fallback rather than returning null or throwing an exception,
*
*/
@ThreadSafe
class DefaultMeter implements Meter {
private static final Meter INSTANCE = new DefaultMeter();
private static final LongCounterBuilder NOOP_LONG_COUNTER_BUILDER = new NoopLongCounterBuilder();
private static final LongUpDownCounterBuilder NOOP_LONG_UP_DOWN_COUNTER_BUILDER =
new NoopLongUpDownCounterBuilder();
private static final DoubleHistogramBuilder NOOP_DOUBLE_HISTOGRAM_BUILDER =
new NoopDoubleHistogramBuilder();
private static final DoubleGaugeBuilder NOOP_DOUBLE_GAUGE_BUILDER = new NoopDoubleGaugeBuilder();
static Meter getInstance() {
return INSTANCE;
}
@Override
public LongCounterBuilder counterBuilder(String name) {
ValidationUtil.checkValidInstrumentName(name);
return NOOP_LONG_COUNTER_BUILDER;
}
@Override
public LongUpDownCounterBuilder upDownCounterBuilder(String name) {
ValidationUtil.checkValidInstrumentName(name);
return NOOP_LONG_UP_DOWN_COUNTER_BUILDER;
}
@Override
public DoubleHistogramBuilder histogramBuilder(String name) {
ValidationUtil.checkValidInstrumentName(name);
return NOOP_DOUBLE_HISTOGRAM_BUILDER;
}
@Override
public DoubleGaugeBuilder gaugeBuilder(String name) {
ValidationUtil.checkValidInstrumentName(name);
return NOOP_DOUBLE_GAUGE_BUILDER;
}
private DefaultMeter() {}
private static class NoopLongCounter implements LongCounter {
@Override
public void add(long value, Attributes attributes, Context context) {}
@Override
public void add(long value, Attributes attributes) {}
@Override
public void add(long value) {}
}
private static class NoopDoubleCounter implements DoubleCounter {
@Override
public void add(double value, Attributes attributes, Context context) {}
@Override
public void add(double value, Attributes attributes) {}
@Override
public void add(double value) {}
}
private static class NoopLongCounterBuilder implements LongCounterBuilder {
private static final LongCounter NOOP_COUNTER = new NoopLongCounter();
private static final ObservableLongCounter NOOP_OBSERVABLE_COUNTER =
new ObservableLongCounter() {};
private static final DoubleCounterBuilder NOOP_DOUBLE_COUNTER_BUILDER =
new NoopDoubleCounterBuilder();
@Override
public LongCounterBuilder setDescription(String description) {
return this;
}
@Override
public LongCounterBuilder setUnit(String unit) {
ValidationUtil.checkValidInstrumentUnit(unit);
return this;
}
@Override
public DoubleCounterBuilder ofDoubles() {
return NOOP_DOUBLE_COUNTER_BUILDER;
}
@Override
public LongCounter build() {
return NOOP_COUNTER;
}
@Override
public ObservableLongCounter buildWithCallback(Consumer callback) {
return NOOP_OBSERVABLE_COUNTER;
}
}
private static class NoopDoubleCounterBuilder implements DoubleCounterBuilder {
private static final DoubleCounter NOOP_COUNTER = new NoopDoubleCounter();
private static final ObservableDoubleCounter NOOP_OBSERVABLE_COUNTER =
new ObservableDoubleCounter() {};
@Override
public DoubleCounterBuilder setDescription(String description) {
return this;
}
@Override
public DoubleCounterBuilder setUnit(String unit) {
ValidationUtil.checkValidInstrumentUnit(unit);
return this;
}
@Override
public DoubleCounter build() {
return NOOP_COUNTER;
}
@Override
public ObservableDoubleCounter buildWithCallback(
Consumer callback) {
return NOOP_OBSERVABLE_COUNTER;
}
}
private static class NoopLongUpDownCounter implements LongUpDownCounter {
@Override
public void add(long value, Attributes attributes, Context context) {}
@Override
public void add(long value, Attributes attributes) {}
@Override
public void add(long value) {}
}
private static class NoopDoubleUpDownCounter implements DoubleUpDownCounter {
@Override
public void add(double value, Attributes attributes, Context context) {}
@Override
public void add(double value, Attributes attributes) {}
@Override
public void add(double value) {}
}
private static class NoopLongUpDownCounterBuilder implements LongUpDownCounterBuilder {
private static final LongUpDownCounter NOOP_UP_DOWN_COUNTER = new NoopLongUpDownCounter() {};
private static final ObservableLongUpDownCounter NOOP_OBSERVABLE_UP_DOWN_COUNTER =
new ObservableLongUpDownCounter() {};
private static final DoubleUpDownCounterBuilder NOOP_DOUBLE_UP_DOWN_COUNTER_BUILDER =
new NoopDoubleUpDownCounterBuilder();
@Override
public LongUpDownCounterBuilder setDescription(String description) {
return this;
}
@Override
public LongUpDownCounterBuilder setUnit(String unit) {
ValidationUtil.checkValidInstrumentUnit(unit);
return this;
}
@Override
public DoubleUpDownCounterBuilder ofDoubles() {
return NOOP_DOUBLE_UP_DOWN_COUNTER_BUILDER;
}
@Override
public LongUpDownCounter build() {
return NOOP_UP_DOWN_COUNTER;
}
@Override
public ObservableLongUpDownCounter buildWithCallback(
Consumer callback) {
return NOOP_OBSERVABLE_UP_DOWN_COUNTER;
}
}
private static class NoopDoubleUpDownCounterBuilder implements DoubleUpDownCounterBuilder {
private static final DoubleUpDownCounter NOOP_UP_DOWN_COUNTER =
new NoopDoubleUpDownCounter() {};
private static final ObservableDoubleUpDownCounter NOOP_OBSERVABLE_UP_DOWN_COUNTER =
new ObservableDoubleUpDownCounter() {};
@Override
public DoubleUpDownCounterBuilder setDescription(String description) {
return this;
}
@Override
public DoubleUpDownCounterBuilder setUnit(String unit) {
ValidationUtil.checkValidInstrumentUnit(unit);
return this;
}
@Override
public DoubleUpDownCounter build() {
return NOOP_UP_DOWN_COUNTER;
}
@Override
public ObservableDoubleUpDownCounter buildWithCallback(
Consumer callback) {
return NOOP_OBSERVABLE_UP_DOWN_COUNTER;
}
}
private static class NoopDoubleHistogram implements DoubleHistogram {
@Override
public void record(double value, Attributes attributes, Context context) {}
@Override
public void record(double value, Attributes attributes) {}
@Override
public void record(double value) {}
}
private static class NoopLongHistogram implements LongHistogram {
@Override
public void record(long value, Attributes attributes, Context context) {}
@Override
public void record(long value, Attributes attributes) {}
@Override
public void record(long value) {}
}
private static class NoopDoubleHistogramBuilder implements DoubleHistogramBuilder {
private static final DoubleHistogram NOOP = new NoopDoubleHistogram();
private static final LongHistogramBuilder NOOP_LONG_HISTOGRAM_BUILDER =
new NoopLongHistogramBuilder();
@Override
public DoubleHistogramBuilder setDescription(String description) {
return this;
}
@Override
public DoubleHistogramBuilder setUnit(String unit) {
ValidationUtil.checkValidInstrumentUnit(unit);
return this;
}
@Override
public LongHistogramBuilder ofLongs() {
return NOOP_LONG_HISTOGRAM_BUILDER;
}
@Override
public DoubleHistogram build() {
return NOOP;
}
}
private static class NoopLongHistogramBuilder implements LongHistogramBuilder {
private static final LongHistogram NOOP = new NoopLongHistogram();
@Override
public LongHistogramBuilder setDescription(String description) {
return this;
}
@Override
public LongHistogramBuilder setUnit(String unit) {
ValidationUtil.checkValidInstrumentUnit(unit);
return this;
}
@Override
public LongHistogram build() {
return NOOP;
}
}
private static class NoopDoubleGaugeBuilder implements DoubleGaugeBuilder {
private static final ObservableDoubleGauge NOOP = new ObservableDoubleGauge() {};
private static final LongGaugeBuilder NOOP_LONG_GAUGE_BUILDER = new NoopLongGaugeBuilder();
@Override
public DoubleGaugeBuilder setDescription(String description) {
return this;
}
@Override
public DoubleGaugeBuilder setUnit(String unit) {
ValidationUtil.checkValidInstrumentUnit(unit);
return this;
}
@Override
public LongGaugeBuilder ofLongs() {
return NOOP_LONG_GAUGE_BUILDER;
}
@Override
public ObservableDoubleGauge buildWithCallback(Consumer callback) {
return NOOP;
}
}
private static class NoopLongGaugeBuilder implements LongGaugeBuilder {
private static final ObservableLongGauge NOOP = new ObservableLongGauge() {};
@Override
public LongGaugeBuilder setDescription(String description) {
return this;
}
@Override
public LongGaugeBuilder setUnit(String unit) {
ValidationUtil.checkValidInstrumentUnit(unit);
return this;
}
@Override
public ObservableLongGauge buildWithCallback(Consumer callback) {
return NOOP;
}
}
}