Package org.apache.iceberg.metrics

Class DefaultMetricsContext

java.lang.Object

org.apache.iceberg.metrics.DefaultMetricsContext

All Implemented Interfaces:

Serializable, MetricsContext

public class DefaultMetricsContext
extends Object
implements MetricsContext

A default MetricsContext implementation that uses native Java counters/timers.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.iceberg.metrics.MetricsContext

MetricsContext.Counter<T extends Number>, MetricsContext.Unit

Constructor Summary

Constructors

Constructor	Description
DefaultMetricsContext()

Method Summary

Modifier and Type	Method	Description
<T extends Number> MetricsContext.Counter<T>	counter(String name, Class<T> type, MetricsContext.Unit unit)	Deprecated. will be removed in 2.0.0, use Counter instead.
Counter	counter(String name, MetricsContext.Unit unit)	Get a named counter.
Histogram	histogram(String name)
Timer	timer(String name, TimeUnit unit)	Get a named timer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.iceberg.metrics.MetricsContext

counter, initialize

Constructor Details

DefaultMetricsContext

public DefaultMetricsContext()

Method Details

counter

@Deprecated
public <T extends Number> MetricsContext.Counter<T> counter(String name,
 Class<T> type,
 MetricsContext.Unit unit)

Deprecated.

will be removed in 2.0.0, use Counter instead.

Description copied from interface: MetricsContext

Get a named counter of a specific type. Metric implementations may impose restrictions on what types are supported for specific counters.

Specified by:

counter in interface MetricsContext

Parameters:

name - name of the metric

type - numeric type of the counter value

unit - the unit designation of the metric

Returns:

a counter implementation

timer

public Timer timer(String name,
 TimeUnit unit)

Description copied from interface: MetricsContext

Get a named timer.

Specified by:

timer in interface MetricsContext

Parameters:

name - name of the metric

unit - the time unit designation of the metric

Returns:

a timer implementation

counter

public Counter counter(String name,
 MetricsContext.Unit unit)

Description copied from interface: MetricsContext

Get a named counter.

Specified by:

counter in interface MetricsContext

Parameters:

name - The name of the counter

unit - The unit designation of the counter

Returns:

a Counter implementation

histogram

public Histogram histogram(String name)

Specified by:

histogram in interface MetricsContext