Class MetricKey

java.lang.Object

io.confluent.telemetry.MetricKey

All Implemented Interfaces:

Keyed

public class MetricKey
extends Object
implements Keyed

Value object that contains the name and labels for a Metric.

Rather than a Metrics Protobuf, we use objects of this class for filtering Metrics and as entries in the LastValueTracker's underlying Map. We do this because 1) we want to avoid the CPU overhead by filtering metrics before we materialize them 2) the OpenCensus Metric format is not ideal for writing a predicate, since you have to stitch back together the metric labelKeys and labelValues (and this latter one lives inside of an array) and 3) the metric name + labels uniquely identify a metric.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MetricKey.Builder

Constructor Summary

Constructors

Constructor	Description
MetricKey(String name, Map<String,String> labels)	Create a MetricKey

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Map<String,String>	getLabels()
String	getName()
int	hashCode()
MetricKey	key()	This is a bit weird but prevents from always having to wrap this object if we're already interacting with a MetricKey directly.
static MetricKey.Builder	newBuilder()
MetricKey.Builder	toBuilder()
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MetricKey

public MetricKey(String name,
 Map<String,String> labels)

Create a MetricKey

Parameters:

name - metric name. This should be the _converted_ name of the metric (the final name under which this metric is emitted).

labels - mapping of tag keys to values.

Method Details

getName

public String getName()

getLabels

public Map<String,String> getLabels()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

key

public MetricKey key()

This is a bit weird but prevents from always having to wrap this object if we're already interacting with a MetricKey directly.

Specified by:

key in interface Keyed

toBuilder

public MetricKey.Builder toBuilder()

newBuilder

public static MetricKey.Builder newBuilder()