Package io.opentelemetry.sdk.metrics

Class View

java.lang.Object

io.opentelemetry.sdk.metrics.View

@Immutable
public abstract class View
extends Object

A view configures how measurements are aggregated and exported as metrics.

Views are registered with the SDK SdkMeterProviderBuilder.registerView(InstrumentSelector, View).

Since:

1.14.0

Method Summary

Modifier and Type	Method	Description
static ViewBuilder	builder()	Returns a builder for a View.
abstract Aggregation	getAggregation()	Returns the aggregation of the resulting metric.
abstract int	getCardinalityLimit()	Returns the cardinality limit for this view.
abstract String	getDescription()	Returns the description of the resulting metric, or null if the matched instrument description should be used.
abstract String	getName()	Returns the name of the resulting metric, or null if the matched instrument name should be used.
final String	toString()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static ViewBuilder builder()

Returns a builder for a View.

getName

@Nullable
public abstract String getName()

Returns the name of the resulting metric, or null if the matched instrument name should be used.

getDescription

@Nullable
public abstract String getDescription()

Returns the description of the resulting metric, or null if the matched instrument description should be used.

getAggregation

public abstract Aggregation getAggregation()

Returns the aggregation of the resulting metric.

getCardinalityLimit

public abstract int getCardinalityLimit()

Returns the cardinality limit for this view.

Since:

1.44.0

toString

public final String toString()

Overrides:

toString in class Object