org.apache.beam.sdk.metrics

Class LabeledMetricNameUtils

java.lang.Object

org.apache.beam.sdk.metrics.LabeledMetricNameUtils

public class LabeledMetricNameUtils
extends java.lang.Object

Util class for building/parsing labeled MetricName.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LabeledMetricNameUtils.MetricNameBuilder Builder class for a labeled MetricName.
static class	LabeledMetricNameUtils.ParsedMetricName

Constructor Summary

Constructors

Constructor and Description
LabeledMetricNameUtils()

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<LabeledMetricNameUtils.ParsedMetricName>	parseMetricName(java.lang.String metricName) Parse a 'metric name' String that was created with 'MetricNameBuilder'.

Methods inherited from class java.lang.Object

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

Constructor Detail

LabeledMetricNameUtils

public LabeledMetricNameUtils()

Method Detail

parseMetricName

public static java.util.Optional<LabeledMetricNameUtils.ParsedMetricName> parseMetricName(java.lang.String metricName)

Parse a 'metric name' String that was created with 'MetricNameBuilder'. The input string should be formatted as.

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

Parameters:

metricName -

Returns:

Returns a ParsedMetricName object if the input string is properly formatted. If the input string is empty or malformed, returns an empty value.