io.confluent.telemetry

Class MetricBuilderFacade

java.lang.Object

io.confluent.telemetry.MetricBuilderFacade

All Implemented Interfaces:

Cloneable

public class MetricBuilderFacade
extends Object
implements Cloneable

A wrapper on the protobuf Metric.Builder that provides:

• A simpler interface for applying labels as a flat set of key-value pairs
• Convenience methods for building a TimeSeries containing a single Point
• Enforcement of Confluent conventions

When using the raw OpenCensus Metric.Builder, labels keys must be applied to the MetricDescriptor and label values must be applied separately on each individual Timeseries.

When using this facade, labels can be set directly as key-value pairs. Upon build() the label keys are applied to the MetricDescriptor and the label values are applied to each TimeSeries.

Constructor Summary

Constructors

Constructor and Description
MetricBuilderFacade()

Method Summary

Modifier and Type	Method and Description
MetricBuilderFacade	addSinglePointTimeseries(io.opencensus.proto.metrics.v1.Point point) Add a TimeSeries containing a single Point.
MetricBuilderFacade	addSinglePointTimeseries(io.opencensus.proto.metrics.v1.Point point, com.google.protobuf.Timestamp startTimestamp) Add a TimeSeries containing a single Point and the given startTimestamp.
io.opencensus.proto.metrics.v1.Metric	build() Build the Metric.
MetricBuilderFacade	clone() Perform a deep clone of this builder.
Map<String,String>	getLabels()
MetricBuilderFacade	withLabel(String key, String value)
MetricBuilderFacade	withLabels(Map<String,String> labels)
MetricBuilderFacade	withName(String name)
MetricBuilderFacade	withResource(io.opencensus.proto.resource.v1.Resource resource)
MetricBuilderFacade	withType(io.opencensus.proto.metrics.v1.MetricDescriptor.Type type)

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricBuilderFacade

public MetricBuilderFacade()

Method Detail

getLabels

public Map<String,String> getLabels()

withResource

public MetricBuilderFacade withResource(io.opencensus.proto.resource.v1.Resource resource)

withLabel

public MetricBuilderFacade withLabel(String key,
                                     String value)

withLabels

public MetricBuilderFacade withLabels(Map<String,String> labels)

withName

public MetricBuilderFacade withName(String name)

withType

public MetricBuilderFacade withType(io.opencensus.proto.metrics.v1.MetricDescriptor.Type type)

addSinglePointTimeseries

public MetricBuilderFacade addSinglePointTimeseries(io.opencensus.proto.metrics.v1.Point point)

Add a TimeSeries containing a single Point.

addSinglePointTimeseries

public MetricBuilderFacade addSinglePointTimeseries(io.opencensus.proto.metrics.v1.Point point,
                                                    com.google.protobuf.Timestamp startTimestamp)

Add a TimeSeries containing a single Point and the given startTimestamp.

build

public io.opencensus.proto.metrics.v1.Metric build()

Build the Metric.

This will apply the label keys to the MetricDescriptor and the label values to each TimeSeries.

clone

public MetricBuilderFacade clone()

Perform a deep clone of this builder.

This can be used to create a "prototype" builder with a default set of labels which can be cloned into builders for individual metrics. See MetricBuilderFacadeTest for an example of this pattern.

Overrides:

clone in class Object

See Also:

Metric.Builder#clone()