org.apache.rocketmq.shaded.io.opentelemetry.sdk.metrics.internal.descriptor.MetricDescriptor Maven / Gradle / Ivy
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package org.apache.rocketmq.shaded.io.opentelemetry.sdk.metrics.internal.descriptor;
import org.apache.rocketmq.shaded.com.google.auto.value.AutoValue;
import org.apache.rocketmq.shaded.com.google.auto.value.extension.memoized.Memoized;
import org.apache.rocketmq.shaded.io.opentelemetry.sdk.metrics.Aggregation;
import org.apache.rocketmq.shaded.io.opentelemetry.sdk.metrics.InstrumentType;
import org.apache.rocketmq.shaded.io.opentelemetry.sdk.metrics.InstrumentValueType;
import org.apache.rocketmq.shaded.io.opentelemetry.sdk.metrics.View;
import org.apache.rocketmq.shaded.io.opentelemetry.sdk.metrics.internal.aggregator.AggregationUtil;
import org.apache.rocketmq.shaded.io.opentelemetry.sdk.metrics.internal.debug.SourceInfo;
import java.util.concurrent.atomic.AtomicReference;
import javax.annotation.concurrent.Immutable;
/**
* Describes a metric that will be output.
*
* Provides equality/identity semantics for detecting duplicate metrics of incompatible.
*
*
This class is internal and is hence not for public use. Its APIs are unstable and can change
* at any time.
*/
@AutoValue
@Immutable
public abstract class MetricDescriptor {
private final AtomicReference viewSourceInfo = new AtomicReference<>();
/**
* Constructs a metric descriptor with no instrument and default view.
*
* Used for testing + empty-storage only.
*/
public static MetricDescriptor create(String name, String description, String unit) {
return create(
View.builder().build(),
SourceInfo.fromCurrentStack(),
InstrumentDescriptor.create(
name, description, unit, InstrumentType.OBSERVABLE_GAUGE, InstrumentValueType.DOUBLE));
}
/** Constructs a metric descriptor for a given View + instrument. */
public static MetricDescriptor create(
View view, SourceInfo viewSourceInfo, InstrumentDescriptor instrument) {
String name = (view.getName() == null) ? instrument.getName() : view.getName();
String description =
(view.getDescription() == null) ? instrument.getDescription() : view.getDescription();
MetricDescriptor metricDescriptor =
new AutoValue_MetricDescriptor(name, description, view, instrument);
metricDescriptor.viewSourceInfo.set(viewSourceInfo);
return metricDescriptor;
}
MetricDescriptor() {}
/**
* The name of the descriptor, equal to {@link View#getName()} if not null, else {@link
* InstrumentDescriptor#getName()}.
*/
public abstract String getName();
/**
* The description of the descriptor, equal to {@link View#getDescription()} if not null, else
* {@link InstrumentDescriptor#getDescription()}.
*/
public abstract String getDescription();
/** The view that lead to the creation of this metric. */
public abstract View getView();
/**
* The {@link SourceInfo} from where the view was registered. Ignored from {@link #equals(Object)}
* and {@link #toString()}.
*/
public final SourceInfo getViewSourceInfo() {
SourceInfo sourceInfo = viewSourceInfo.get();
return sourceInfo == null ? SourceInfo.noSourceInfo() : sourceInfo;
}
/** The instrument which lead to the creation of this metric. */
public abstract InstrumentDescriptor getSourceInstrument();
/** The {@link AggregationUtil#aggregationName(Aggregation)} of the view aggregation. */
public String getAggregationName() {
return AggregationUtil.aggregationName(getView().getAggregation());
}
@Memoized
@Override
public abstract int hashCode();
/**
* Returns true if another metric descriptor is compatible with this one.
*
*
A metric descriptor is compatible with another if the following are true:
*
*
* - {@link #getName()} is equal
*
- {@link #getDescription()} is equal
*
- {@link #getAggregationName()} is equal
*
- {@link InstrumentDescriptor#getName()} is equal
*
- {@link InstrumentDescriptor#getDescription()} is equal
*
- {@link InstrumentDescriptor#getUnit()} is equal
*
- {@link InstrumentDescriptor#getType()} is equal
*
- {@link InstrumentDescriptor#getValueType()} is equal
*
*/
public boolean isCompatibleWith(MetricDescriptor other) {
return getName().equals(other.getName())
&& getDescription().equals(other.getDescription())
&& getAggregationName().equals(other.getAggregationName())
&& getSourceInstrument().getName().equals(other.getSourceInstrument().getName())
&& getSourceInstrument()
.getDescription()
.equals(other.getSourceInstrument().getDescription())
&& getSourceInstrument().getUnit().equals(other.getSourceInstrument().getUnit())
&& getSourceInstrument().getType().equals(other.getSourceInstrument().getType())
&& getSourceInstrument().getValueType().equals(other.getSourceInstrument().getValueType());
}
}