Module prometheus_counter

Counter is a Metric that represents a single numerical value that only ever goes up.

Behaviours: gen_server, prometheus_collector, prometheus_metric.

Description

Counter is a Metric that represents a single numerical value that only ever goes up. That implies that it cannot be used to count items whose number can also go down, e.g. the number of currently running processes. Those "counters" are represented by prometheus_gauge.

A Counter is typically used to count requests served, tasks completed, errors occurred, etc.

Examople use cases for Counters: Use the rate()/irate() functions in Prometheus to calculate the rate of increase of a Counter. By convention, the names of Counters are suffixed by _total.

Function Index

declare/1
declare/2(Deprecated.)
dinc/1Equivalent to dinc(default, Name, [], 1).
dinc/2
dinc/3Equivalent to dinc(default, Name, LabelValues, Value).
dinc/4
inc/1Equivalent to inc(default, Name, [], 1).
inc/2
inc/3Equivalent to inc(default, Name, LabelValues, Value).
inc/4
new/1
new/2(Deprecated.)
reset/1Equivalent to reset(default, Name, []).
reset/2Equivalent to reset(default, Name, LabelValues).
reset/3
value/1Equivalent to value(default, Name, []).
value/2Equivalent to value(default, Name, LabelValues).
value/3

Function Details

declare/1

declare(Spec) -> any()

declare/2

declare(Spec, Registry) -> any()

This function is deprecated: Please use declare/1 with registry key instead.

dinc/1

dinc(Name) -> any()

Equivalent to dinc(default, Name, [], 1).

dinc/2

dinc(Name, LabelValues) -> any()

dinc/3

dinc(Name, LabelValues, Value) -> any()

Equivalent to dinc(default, Name, LabelValues, Value).

dinc/4

dinc(Registry, Name, LabelValues, Value) -> any()

inc/1

inc(Name) -> any()

Equivalent to inc(default, Name, [], 1).

inc/2

inc(Name, LabelValues) -> any()

inc/3

inc(Name, LabelValues, Value) -> any()

Equivalent to inc(default, Name, LabelValues, Value).

inc/4

inc(Registry, Name, LabelValues, Value) -> any()

new/1

new(Spec) -> any()

new/2

new(Spec, Registry) -> any()

This function is deprecated: Please use new/1 with registry key instead.

reset/1

reset(Name) -> any()

Equivalent to reset(default, Name, []).

reset/2

reset(Name, LabelValues) -> any()

Equivalent to reset(default, Name, LabelValues).

reset/3

reset(Registry, Name, LabelValues) -> any()

value/1

value(Name) -> any()

Equivalent to value(default, Name, []).

value/2

value(Name, LabelValues) -> any()

Equivalent to value(default, Name, LabelValues).

value/3

value(Registry, Name, LabelValues) -> any()


Generated by EDoc, Aug 29 2016, 23:53:53.