Class Gauge.Builder

Object

MetricWithFixedMetadata.Builder<Gauge.Builder, Gauge>

Builder

Enclosing class:

Gauge

public static class Gauge.Builder
extends MetricWithFixedMetadata.Builder<Gauge.Builder, Gauge>

Method Summary

Modifier and Type	Method	Description
Gauge	build()
Gauge.Builder	exemplarLabelsSupplier(Supplier<Labels> supplier)	Provide additional labels to be merged into every automatically-sampled exemplar of this metric.
MetricsProperties	getDefaultProperties()	Override if there are more properties than just exemplars enabled.
Gauge.Builder	withExemplars()	Allow Exemplars for this metric.
Gauge.Builder	withoutExemplars()	Turn off Exemplars for this metric.

Methods inherited from class MetricWithFixedMetadata.Builder

constLabels, help, labelNames, name, unit

Methods inherited from class Object

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

Method Details

build

public Gauge build()

Specified by:

build in class MetricWithFixedMetadata.Builder<Gauge.Builder, Gauge>

exemplarLabelsSupplier

public Gauge.Builder exemplarLabelsSupplier(Supplier<Labels> supplier)

Provide additional labels to be merged into every automatically-sampled exemplar of this metric. The supplier is called each time an exemplar is sampled, so it can return dynamic values (e.g. a request-scoped identifier from a thread-local). The supplier is only invoked when a valid, sampled span context is present; it has no effect when tracing is not active.

For a global supplier that applies to all metrics (including metrics registered by third-party libraries you do not control), see ExemplarLabelsSupplier. When both are configured, this per-metric supplier takes precedence over the global one on a label-name collision, and the reserved trace_id/span_id labels always win over both. Labels that collide are silently dropped.

withExemplars

public Gauge.Builder withExemplars()

Allow Exemplars for this metric.

withoutExemplars

public Gauge.Builder withoutExemplars()

Turn off Exemplars for this metric.

getDefaultProperties

public MetricsProperties getDefaultProperties()

Override if there are more properties than just exemplars enabled.