Gauge class

A Gauge represents a value that can go up and down.

Inheritance

• Object
• Collector
• Gauge

Constructors

Gauge({required String name, required String help, List<String> labelNames = const [], Collect<Gauge>? collectCallback})

Construct a new Gauge with a name, help text and optional labelNames. If labelNames are provided, use labels(...) to assign label values. The optional collectCallback is called at the beginning of collect and allows to update the value of the gauge before collecting it.

Properties

collectCallback → Collect<Gauge>?

Optional callback called in collect before samples are collected.

final

hashCode → int

The hash code for this object.

no setter, inherited

help → String

The help text of the metric.

final, inherited

labelNames → List<String>

The unmodifiable list of labelNames assigned to this metric.

final, inherited

name → String

The name of the metric.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

value ↔ double

Accesses the current value of the gauge without labels.

getter/setter pair

Methods

clear() → void

Remove all Child metrics.

inherited

collect() → Future<Iterable<MetricFamilySamples>>

collect all metrics and samples that are part of this Collector.

override

collectNames() → Iterable<String>

Collect all metric names, including child metrics.

override

dec([double amount = 1]) → void

Decrement the value of the gauge without labels by amount. Decrements by one, if no amount is provided.

inc([double amount = 1]) → void

Increment the value of the gauge without labels by amount. Increments by one, if no amount is provided.

labels(List<String> labelValues) → GaugeChild

Create a Child metric and assign the labelValues. The size of the labelValues has to match the labelNames of the metric.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

register([CollectorRegistry? registry]) → void

Register the Collector at a registry. If no registry is provided, the CollectorRegistry.defaultRegistry is used.

inherited

remove(List<String> labelValues) → void

Remove a Child metric based on it's label values.

inherited

setToCurrentTime() → void

Set the value of the gauge without labels to the current time as a unix timestamp.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited