public class MetricBuilderFacade extends Object implements Cloneable
Metric.Builder
that provides: TimeSeries
containing a single Point
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 and Description |
---|
MetricBuilderFacade() |
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) |
public MetricBuilderFacade withResource(io.opencensus.proto.resource.v1.Resource resource)
public MetricBuilderFacade withLabel(String key, String value)
public MetricBuilderFacade withLabels(Map<String,String> labels)
public MetricBuilderFacade withName(String name)
public MetricBuilderFacade withType(io.opencensus.proto.metrics.v1.MetricDescriptor.Type type)
public MetricBuilderFacade addSinglePointTimeseries(io.opencensus.proto.metrics.v1.Point point)
TimeSeries
containing a single Point
.public MetricBuilderFacade addSinglePointTimeseries(io.opencensus.proto.metrics.v1.Point point, com.google.protobuf.Timestamp startTimestamp)
TimeSeries
containing a single Point
and the given
startTimestamp
.public io.opencensus.proto.metrics.v1.Metric build()
Metric
.
This will apply the label keys to the MetricDescriptor
and the label values to
each TimeSeries
.
public MetricBuilderFacade clone()
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.