Package io.opentelemetry.sdk.metrics.data

Class DelegatingMetricData

java.lang.Object

io.opentelemetry.sdk.metrics.data.DelegatingMetricData

All Implemented Interfaces:

MetricData

public abstract class DelegatingMetricData
extends Object
implements MetricData

A MetricData which delegates all methods to another MetricData. Extend this class to modify the MetricData that will be exported, for example by creating a delegating MetricExporter which wraps MetricData with a custom implementation.

Example usage:

 // class MetricDataWithCustomDescription extends DelegatingMetricData {
 //
 //   private final String description;
 //
 //   MetricDataWithCustomDescription(MetricData delegate) {
 //     super(delegate);
 //     this.description = delegate.getDescription() + " (custom)";
 //   }
 //
 //   @Override
 //   public String getDescription() {
 //     return description;
 //   }
 // }
 

Since:

1.50.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DelegatingMetricData(MetricData delegate)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Returns a boolean indicating whether the delegate MetricData is equal to this MetricData.
Data<?>	getData()	Returns the data of the metric.
String	getDescription()	Returns the description of the metric.
io.opentelemetry.sdk.common.InstrumentationScopeInfo	getInstrumentationScopeInfo()	Returns the instrumentation library information associated with this metric data.
String	getName()	Returns the name of the metric.
io.opentelemetry.sdk.resources.Resource	getResource()	Returns the resource associated with this metric data.
MetricDataType	getType()	Returns the type of the metric.
String	getUnit()	Returns the unit of the metric.
int	hashCode()	Returns a hash code value for the delegate MetricData.
String	toString()	Returns a string representation of the delegate MetricData.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.opentelemetry.sdk.metrics.data.MetricData

getDoubleGaugeData, getDoubleSumData, getExponentialHistogramData, getHistogramData, getLongGaugeData, getLongSumData, getSummaryData, isEmpty

Constructor Details

DelegatingMetricData

protected DelegatingMetricData(MetricData delegate)

Method Details

getResource

public io.opentelemetry.sdk.resources.Resource getResource()

Returns the resource associated with this metric data.

Specified by:

getResource in interface MetricData

Returns:

the Resource instance.

getInstrumentationScopeInfo

public io.opentelemetry.sdk.common.InstrumentationScopeInfo getInstrumentationScopeInfo()

Returns the instrumentation library information associated with this metric data.

Specified by:

getInstrumentationScopeInfo in interface MetricData

Returns:

the InstrumentationScopeInfo instance.

getName

public String getName()

Returns the name of the metric.

Specified by:

getName in interface MetricData

Returns:

the name of the metric.

getDescription

public String getDescription()

Returns the description of the metric.

Specified by:

getDescription in interface MetricData

Returns:

the description of the metric.

getUnit

public String getUnit()

Returns the unit of the metric.

Specified by:

getUnit in interface MetricData

Returns:

the unit of the metric.

getType

public MetricDataType getType()

Returns the type of the metric.

Specified by:

getType in interface MetricData

Returns:

the type of the metric.

getData

public Data<?> getData()

Returns the data of the metric.

Specified by:

getData in interface MetricData

Returns:

the data of the metric.

See Also:

• MetricData.getDoubleGaugeData()
• MetricData.getLongGaugeData()
• MetricData.getDoubleSumData()
• MetricData.getLongSumData()
• MetricData.getHistogramData()
• MetricData.getSummaryData()

equals

public boolean equals(Object o)

Returns a boolean indicating whether the delegate MetricData is equal to this MetricData.

Overrides:

equals in class Object

Parameters:

o - the object to compare to.

Returns:

a boolean indicating whether the delegate MetricData is equal to this MetricData.

hashCode

public int hashCode()

Returns a hash code value for the delegate MetricData.

Overrides:

hashCode in class Object

Returns:

a hash code value for the delegate MetricData.

toString

public String toString()

Returns a string representation of the delegate MetricData.

Overrides:

toString in class Object