org.apache.beam.sdk.metrics

Class LabeledMetricNameUtils.MetricNameBuilder

java.lang.Object

org.apache.beam.sdk.metrics.LabeledMetricNameUtils.MetricNameBuilder

Enclosing class:

LabeledMetricNameUtils

public static class LabeledMetricNameUtils.MetricNameBuilder
extends java.lang.Object

Builder class for a labeled MetricName. Returned MetricName.getName() will be formatted as:

'{baseName}-{metricLabelKey1}:{metricLabelVal1};...{metricLabelKeyN}:{metricLabelValN};'

Method Summary

Modifier and Type	Method and Description
void	addLabel(java.lang.String key, java.lang.String value) Add a metric label KV pair to the metric name.
void	addMetricLabel(java.lang.String key, java.lang.String value) Add a metric label KV pair to the metric.
static LabeledMetricNameUtils.MetricNameBuilder	baseNameBuilder(java.lang.String baseName)
MetricName	build(java.lang.String metricNamespace)

Methods inherited from class java.lang.Object

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

Method Detail

baseNameBuilder

public static LabeledMetricNameUtils.MetricNameBuilder baseNameBuilder(java.lang.String baseName)

addLabel

public void addLabel(java.lang.String key,
                     java.lang.String value)

Add a metric label KV pair to the metric name. Calling addLabel multiple times with the same key will lead to unexpected results when parsing metric names.

addMetricLabel

public void addMetricLabel(java.lang.String key,
                           java.lang.String value)

Add a metric label KV pair to the metric. This is not concatenated as a part of the name, but merely for adding attributes to the metric.

build

public MetricName build(java.lang.String metricNamespace)