Counter class Null safety

Counter is a monotonically increasing counter.

Inheritance

Constructors

Counter({required String name, required String help, List<String> labelNames = const [], Collect<Counter>? collectCallback})
Construct a new Counter 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 counter before collecting it.

Properties

collectCallback Collect<Counter>?
Optional callback called in collect before samples are collected.
final
hashCode int
The hash code for this object.
read-onlyinherited
help String
The help text of the metric.
finalinherited
labelNames List<String>
The unmodifiable list of labelNames assigned to this metric.
finalinherited
name String
The name of the metric.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
value double
Accesses the current value of the counter without labels.
read-only

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
inc([double amount = 1]) → void
Increment the value of the counter without labels by amount. Increments by one, if no amount is provided.
labels(List<String> labelValues) CounterChild
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 non-existent 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
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited