org.apache.paimon.metrics

Interface MetricGroup

All Known Implementing Classes:

FlinkMetricGroup, MetricGroupImpl

@Public
public interface MetricGroup

A MetricGroup is a named container for Metrics and further metric subgroups.

Instances of this class can be used to register new metrics with Paimon.

Method Summary

Modifier and Type	Method and Description
void	close() Close the metric group and release related resources.
Counter	counter(String name) Creates and registers a new Counter with Paimon.
<T> Gauge<T>	gauge(String name, Gauge<T> gauge) Registers a new Gauge with Paimon.
Map<String,String>	getAllVariables() Returns a map of all variables and their associated value.
String	getGroupName() Returns the name for this group, meaning what kind of entity it represents, for example "commit".
Map<String,Metric>	getMetrics() Returns all the metrics the group carries.
Histogram	histogram(String name, int windowSize) Registers a new Histogram with Paimon.

Method Detail

counter

Counter counter(String name)

Creates and registers a new Counter with Paimon.

Parameters:

name - name of the counter

Returns:

the created counter

gauge

<T> Gauge<T> gauge(String name,
                   Gauge<T> gauge)

Registers a new Gauge with Paimon.

Type Parameters:

T - return type of the gauge

Parameters:

name - name of the gauge

gauge - gauge to register

Returns:

the given gauge

histogram

Histogram histogram(String name,
                    int windowSize)

Registers a new Histogram with Paimon.

Parameters:

name - name of the histogram

windowSize - number of records this histogram keeps

Returns:

the registered histogram

getAllVariables

Map<String,String> getAllVariables()

Returns a map of all variables and their associated value.

getGroupName

String getGroupName()

Returns the name for this group, meaning what kind of entity it represents, for example "commit".

getMetrics

Map<String,Metric> getMetrics()

Returns all the metrics the group carries.

close

void close()

Close the metric group and release related resources.