org.apache.flink.metrics.groups

Class UnregisteredMetricsGroup

java.lang.Object

org.apache.flink.metrics.groups.UnregisteredMetricsGroup

All Implemented Interfaces:

MetricGroup

public class UnregisteredMetricsGroup
extends Object
implements MetricGroup

A special MetricGroup that does not register any metrics at the metrics registry and any reporters.

Constructor Summary

Constructors

Constructor and Description
UnregisteredMetricsGroup()

Method Summary

Modifier and Type	Method and Description
MetricGroup	addGroup(int name) Creates a new MetricGroup and adds it to this groups sub-groups.
MetricGroup	addGroup(String name) Creates a new MetricGroup and adds it to this groups sub-groups.
MetricGroup	addGroup(String key, String value) Creates a new key-value MetricGroup pair.
Counter	counter(int name) Creates and registers a new Counter with Flink.
<C extends Counter> C	counter(int name, C counter) Registers a Counter with Flink.
Counter	counter(String name) Creates and registers a new Counter with Flink.
<C extends Counter> C	counter(String name, C counter) Registers a Counter with Flink.
<T,G extends Gauge<T>> G	gauge(int name, G gauge) Registers a new Gauge with Flink.
<T,G extends Gauge<T>> G	gauge(String name, G gauge) Registers a new Gauge with Flink.
Map<String,String>	getAllVariables() Returns a map of all variables and their associated value, for example {"<host>"="host-7", "<tm_id>"="taskmanager-2"}.
String	getMetricIdentifier(String metricName) Returns the fully qualified metric name, for example "host-7.taskmanager-2.window_word_count.my-mapper.metricName".
String	getMetricIdentifier(String metricName, CharacterFilter filter) Returns the fully qualified metric name, for example "host-7.taskmanager-2.window_word_count.my-mapper.metricName".
String[]	getScopeComponents() Gets the scope as an array of the scope components, for example ["host-7", "taskmanager-2", "window_word_count", "my-mapper"].
<H extends Histogram> H	histogram(int name, H histogram) Registers a new Histogram with Flink.
<H extends Histogram> H	histogram(String name, H histogram) Registers a new Histogram with Flink.
<M extends Meter> M	meter(int name, M meter) Registers a new Meter with Flink.
<M extends Meter> M	meter(String name, M meter) Registers a new Meter with Flink.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnregisteredMetricsGroup

public UnregisteredMetricsGroup()

Method Detail

counter

public Counter counter(int name)

Description copied from interface: MetricGroup

Creates and registers a new Counter with Flink.

Specified by:

counter in interface MetricGroup

Parameters:

name - name of the counter

Returns:

the created counter

counter

public Counter counter(String name)

Description copied from interface: MetricGroup

Creates and registers a new Counter with Flink.

Specified by:

counter in interface MetricGroup

Parameters:

name - name of the counter

Returns:

the created counter

counter

public <C extends Counter> C counter(int name,
                                     C counter)

Description copied from interface: MetricGroup

Registers a Counter with Flink.

Specified by:

counter in interface MetricGroup

Type Parameters:

C - counter type

Parameters:

name - name of the counter

counter - counter to register

Returns:

the given counter

counter

public <C extends Counter> C counter(String name,
                                     C counter)

Description copied from interface: MetricGroup

Registers a Counter with Flink.

Specified by:

counter in interface MetricGroup

Type Parameters:

C - counter type

Parameters:

name - name of the counter

counter - counter to register

Returns:

the given counter

gauge

public <T,G extends Gauge<T>> G gauge(int name,
                                      G gauge)

Description copied from interface: MetricGroup

Registers a new Gauge with Flink.

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

gauge

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

Description copied from interface: MetricGroup

Registers a new Gauge with Flink.

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 <H extends Histogram> H histogram(int name,
                                         H histogram)

Description copied from interface: MetricGroup

Registers a new Histogram with Flink.

Specified by:

histogram in interface MetricGroup

Type Parameters:

H - histogram type

Parameters:

name - name of the histogram

histogram - histogram to register

Returns:

the registered histogram

meter

public <M extends Meter> M meter(String name,
                                 M meter)

Description copied from interface: MetricGroup

Registers a new Meter with Flink.

Specified by:

meter in interface MetricGroup

Type Parameters:

M - meter type

Parameters:

name - name of the meter

meter - meter to register

Returns:

the registered meter

meter

public <M extends Meter> M meter(int name,
                                 M meter)

Description copied from interface: MetricGroup

Registers a new Meter with Flink.

Specified by:

meter in interface MetricGroup

Type Parameters:

M - meter type

Parameters:

name - name of the meter

meter - meter to register

Returns:

the registered meter

histogram

public <H extends Histogram> H histogram(String name,
                                         H histogram)

Description copied from interface: MetricGroup

Registers a new Histogram with Flink.

Specified by:

histogram in interface MetricGroup

Type Parameters:

H - histogram type

Parameters:

name - name of the histogram

histogram - histogram to register

Returns:

the registered histogram

addGroup

public MetricGroup addGroup(int name)

Description copied from interface: MetricGroup

Creates a new MetricGroup and adds it to this groups sub-groups.

Specified by:

addGroup in interface MetricGroup

Parameters:

name - name of the group

Returns:

the created group

addGroup

public MetricGroup addGroup(String name)

Description copied from interface: MetricGroup

Creates a new MetricGroup and adds it to this groups sub-groups.

Specified by:

addGroup in interface MetricGroup

Parameters:

name - name of the group

Returns:

the created group

addGroup

public MetricGroup addGroup(String key,
                            String value)

Description copied from interface: MetricGroup

Creates a new key-value MetricGroup pair. The key group is added to this groups sub-groups, while the value group is added to the key group's sub-groups. This method returns the value group.

The only difference between calling this method and group.addGroup(key).addGroup(value) is that MetricGroup.getAllVariables() of the value group return an additional "<key>"="value" pair.

Specified by:

addGroup in interface MetricGroup

Parameters:

key - name of the first group

value - name of the second group

Returns:

the second created group

getScopeComponents

public String[] getScopeComponents()

Description copied from interface: MetricGroup

Gets the scope as an array of the scope components, for example ["host-7", "taskmanager-2", "window_word_count", "my-mapper"].

Specified by:

getScopeComponents in interface MetricGroup

See Also:

MetricGroup.getMetricIdentifier(String), MetricGroup.getMetricIdentifier(String, CharacterFilter)

getAllVariables

public Map<String,String> getAllVariables()

Description copied from interface: MetricGroup

Returns a map of all variables and their associated value, for example {"<host>"="host-7", "<tm_id>"="taskmanager-2"}.

Specified by:

getAllVariables in interface MetricGroup

Returns:

map of all variables and their associated value

getMetricIdentifier

public String getMetricIdentifier(String metricName)

Description copied from interface: MetricGroup

Returns the fully qualified metric name, for example "host-7.taskmanager-2.window_word_count.my-mapper.metricName".

Specified by:

getMetricIdentifier in interface MetricGroup

Parameters:

metricName - metric name

Returns:

fully qualified metric name

getMetricIdentifier

public String getMetricIdentifier(String metricName,
                                  CharacterFilter filter)

Description copied from interface: MetricGroup

Returns the fully qualified metric name, for example "host-7.taskmanager-2.window_word_count.my-mapper.metricName".

Specified by:

getMetricIdentifier in interface MetricGroup

Parameters:

metricName - metric name

filter - character filter which is applied to the scope components if not null.

Returns:

fully qualified metric name