View Source prometheus_metric behaviour (prometheus v4.12.0)

Summary

Types

call_enabled()
counter_value()
duration_unit()
gauge_value()
help()
histogram_value()
labels()
name()
spec()
summary_value()
value()

Callbacks

declare(Spec)
new(Spec)
remove(Name)
remove(Name, LValues)
remove(Registry, Name, LValues)
reset(Name)
reset(Name, LValues)
reset(Registry, Name, LValues)
set_default(Registry, Name)
value(Name)
value(Name, LValues)
value(Registry, Name, LValues)

Types

call_enabled()

-type call_enabled() :: boolean().

counter_value()

-type counter_value() :: number().

duration_unit()

-type duration_unit() :: prometheus_time:duration_unit().

gauge_value()

-type gauge_value() :: number().

help()

-type help() :: binary() | nonempty_string().

histogram_value()

-type histogram_value() :: {Buckets :: [number(), ...], Sum :: number()}.

labels()

-type labels() :: [name()].

name()

-type name() :: atom() | binary() | nonempty_string() | iolist().

spec()

-type spec() :: proplists:proplist().

summary_value()

-type summary_value() :: {Count :: number(), Sum :: number()}.

value()

-type value() :: counter_value() | gauge_value() | summary_value() | histogram_value() | undefined.

Callbacks

declare(Spec)

-callback declare(Spec :: spec()) -> boolean().

new(Spec)

-callback new(Spec :: spec()) -> ok.

remove(Name)

-callback remove(Name :: name()) -> boolean() | no_return().

remove(Name, LValues)

-callback remove(Name :: name(), LValues :: list()) -> boolean() | no_return().

remove(Registry, Name, LValues)

-callback remove(Registry, Name, LValues) -> boolean() | no_return()
                    when Registry :: prometheus_registry:registry(), Name :: name(), LValues :: list().

reset(Name)

-callback reset(Name :: name()) -> boolean() | no_return().

reset(Name, LValues)

-callback reset(Name :: name(), LValues :: list()) -> boolean() | no_return().

reset(Registry, Name, LValues)

-callback reset(Registry, Name, LValues) -> boolean() | no_return()
                   when Registry :: prometheus_registry:registry(), Name :: name(), LValues :: list().

set_default(Registry, Name)

-callback set_default(Registry, Name) -> any()
                         when Registry :: prometheus_registry:registry(), Name :: name().

value(Name)

-callback value(Name :: name()) -> value() | no_return().

value(Name, LValues)

-callback value(Name :: name(), LValues :: list()) -> value() | no_return().

value(Registry, Name, LValues)

-callback value(Registry, Name, LValues) -> value() | no_return()
                   when Registry :: prometheus_registry:registry(), Name :: name(), LValues :: list().