Package org.apache.beam.sdk.metrics

Class MetricName

java.lang.Object

org.apache.beam.sdk.metrics.MetricName

All Implemented Interfaces:

Serializable

public abstract class MetricName
extends Object
implements Serializable

The name of a metric consists of a getNamespace() and a getName(). The getNamespace() allows grouping related metrics together and also prevents collisions between multiple metrics with the same name.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MetricName()

Method Summary

Modifier and Type	Method	Description
abstract Map<String,String>	getLabels()	Associated labels for the metric.
abstract String	getName()	The name of this metric.
abstract String	getNamespace()	The namespace associated with this metric.
static MetricName	named(Class<?> namespace, String name)
static MetricName	named(Class<?> namespace, String name, Map<String,String> labels)
static MetricName	named(String namespace, String name)
static MetricName	named(String namespace, String name, Map<String,String> labels)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

MetricName

public MetricName()

Method Details

getNamespace

public abstract String getNamespace()

The namespace associated with this metric.

getName

public abstract String getName()

The name of this metric.

getLabels

public abstract Map<String,String> getLabels()

Associated labels for the metric.

toString

@Memoized
public String toString()

Overrides:

toString in class Object

named

public static MetricName named(String namespace,
 String name)

named

public static MetricName named(String namespace,
 String name,
 Map<String,String> labels)

named

public static MetricName named(Class<?> namespace,
 String name)

named

public static MetricName named(Class<?> namespace,
 String name,
 Map<String,String> labels)