org.apache.paimon.flink.metrics

Class FlinkMetricGroup

java.lang.Object

org.apache.paimon.flink.metrics.FlinkMetricGroup

All Implemented Interfaces:

MetricGroup

public class FlinkMetricGroup
extends Object
implements MetricGroup

MetricGroup which wraps a Flink's MetricGroup and register all metrics into Flink's metric system.

Constructor Summary

Constructors

Constructor and Description
FlinkMetricGroup(org.apache.flink.metrics.MetricGroup wrapped, String groupName, Map<String,String> variables)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlinkMetricGroup

public FlinkMetricGroup(org.apache.flink.metrics.MetricGroup wrapped,
                        String groupName,
                        Map<String,String> variables)

Method Detail

counter

public Counter counter(String name)

Description copied from interface: MetricGroup

Creates and registers a new Counter with Paimon.

Specified by:

counter in interface MetricGroup

Parameters:

name - name of the counter

Returns:

the created counter

gauge

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

Description copied from interface: MetricGroup

Registers a new Gauge with Paimon.

Specified by:

gauge in interface MetricGroup

Type Parameters:

T - return type of the gauge

Parameters:

name - name of the gauge

gauge - gauge to register

Returns:

the given gauge

histogram

public Histogram histogram(String name,
                           int windowSize)

Description copied from interface: MetricGroup

Registers a new Histogram with Paimon.

Specified by:

histogram in interface MetricGroup

Parameters:

name - name of the histogram

windowSize - number of records this histogram keeps

Returns:

the registered histogram

getAllVariables

public Map<String,String> getAllVariables()

Description copied from interface: MetricGroup

Returns a map of all variables and their associated value.

Specified by:

getAllVariables in interface MetricGroup

getGroupName

public String getGroupName()

Description copied from interface: MetricGroup

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

Specified by:

getGroupName in interface MetricGroup

getMetrics

public Map<String,Metric> getMetrics()

Description copied from interface: MetricGroup

Returns all the metrics the group carries.

Specified by:

getMetrics in interface MetricGroup

close

public void close()

Description copied from interface: MetricGroup

Close the metric group and release related resources.

Specified by:

close in interface MetricGroup