Module prometheus_histogram

A Histogram tracks the size and number of events in buckets.

Behaviours: prometheus_collector, prometheus_metric.

Description

A Histogram tracks the size and number of events in buckets. You can use Histograms for aggregatable calculation of quantiles.

Example use cases for Histograms:

Function Index

buckets/1Equivalent to buckets(default, Name, []).
buckets/2Equivalent to buckets(default, Name, LabelValues).
buckets/3
declare/1
declare/2(Deprecated.)
default_buckets/0
dobserve/2Equivalent to dobserve(default, Name, [], Value).
dobserve/3Equivalent to dobserve(default, Name, LabelValues, [], Value).
dobserve/4
exponential_buckets/3
linear_buckets/3
new/1
new/2(Deprecated.)
observe/2Equivalent to observe(default, Name, [], Value).
observe/3Equivalent to observe(default, Name, LabelValues, Value).
observe/4
observe_duration/2Equivalent to observe_duration(default, Name, [], Fun).
observe_duration/3Equivalent to observe_duration(default, Name, LabelValues, Fun).
observe_duration/4
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

buckets/1

buckets(Name) -> any()

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

buckets/2

buckets(Name, LabelValues) -> any()

Equivalent to buckets(default, Name, LabelValues).

buckets/3

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

declare/1

declare(Spec) -> any()

declare/2

declare(Spec, Registry) -> any()

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

default_buckets/0

default_buckets() -> any()

dobserve/2

dobserve(Name, Value) -> any()

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

dobserve/3

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

Equivalent to dobserve(default, Name, LabelValues, [], Value).

dobserve/4

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

exponential_buckets/3

exponential_buckets(Start, Factor, Count) -> any()

linear_buckets/3

linear_buckets(Start, Step, Count) -> any()

new/1

new(Spec) -> any()

new/2

new(Spec, Registry) -> any()

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

observe/2

observe(Name, Value) -> any()

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

observe/3

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

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

observe/4

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

observe_duration/2

observe_duration(Name, Fun) -> any()

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

observe_duration/3

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

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

observe_duration/4

observe_duration(Registry, Name, LabelValues, Fun) -> any()

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.