Module prometheus_gauge

Gauge metric, to report instantaneous values.

Behaviours: prometheus_collector, prometheus_metric.

Description

Gauge metric, to report instantaneous values.

Gauge is a metric that represents a single numerical value that can arbitrarily go up and down.

A Gauge is typically used for measured values like temperatures or current memory usage, but also "counts" that can go up and down, like the number of running processes.

Example use cases for Gauges:

Function Index

collect_metrics/2
collect_mf/2
declare/1
declare/2(Deprecated.)
deregister_cleanup/1
new/1
new/2(Deprecated.)
reset/1Equivalent to reset(default, Name, []).
reset/2Equivalent to reset(default, Name, LabelValues).
reset/3
set/2Equivalent to set(default, Name, [], Value).
set/3Equivalent to set(default, Name, LabelValues, Value).
set/4
set_to_current_time/1Equivalent to set_to_current_time(default, Name, []).
set_to_current_time/2Equivalent to seto_to_current_time(default, Name, LabelValues).
set_to_current_time/3
track_inprogress/2Equivalent to track_inprogress(default, Name, [], Fun).
track_inprogress/3Equivalent to track_inprogress(default, Name, LabelValues, Fun).
track_inprogress/4
value/1Equivalent to value(default, Name, []).
value/2Equivalent to value(default, Name, LabelValues).
value/3

Function Details

collect_metrics/2

collect_metrics(Name, X2) -> any()

collect_mf/2

collect_mf(Callback, Registry) -> any()

declare/1

declare(Spec) -> any()

declare/2

declare(Spec, Registry) -> any()

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

deregister_cleanup/1

deregister_cleanup(Registry) -> 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()

set/2

set(Name, Value) -> any()

Equivalent to set(default, Name, [], Value).

set/3

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

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

set/4

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

set_to_current_time/1

set_to_current_time(Name) -> any()

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

set_to_current_time/2

set_to_current_time(Name, LabelValues) -> any()

Equivalent to seto_to_current_time(default, Name, LabelValues).

set_to_current_time/3

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

track_inprogress/2

track_inprogress(Name, Fun) -> any()

Equivalent to track_inprogress(default, Name, [], Fun).

track_inprogress/3

track_inprogress(Name, LabelValues, Fun) -> any()

Equivalent to track_inprogress(default, Name, LabelValues, Fun).

track_inprogress/4

track_inprogress(Registry, Name, LabelValues, Fun) -> 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.