Module prometheus_metric

This module defines the prometheus_metric behaviour.
Required callback functions: new/1, declare/1, set_default/2, remove/1, remove/2, remove/3, reset/1, reset/2, reset/3, value/1, value/2, value/3.

Data Types

counter_value()

counter_value() = number()

duration_unit()

duration_unit() = prometheus_time:duration_unit()

gauge_value()

gauge_value() = number()

help()

help() = binary() | nonempty_string()

histogram_value()

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

label_values()

label_values() = [prometheus:label_value()]

labels()

labels() = [name()]

name()

name() = atom() | binary() | nonempty_string() | iolist()

spec()

spec() = proplists:proplist() | #{name := name(), help := help(), registry => prometheus_registry:registry(), constant_labels => [{atom(), term()}], labels => labels(), data => term(), atom() => term()}

summary_value()

summary_value() = {Count::number(), Sum::number()}

value()

value() = counter_value() | gauge_value() | summary_value() | histogram_value() | undefined

Function Index

check_mf_exists/3
check_mf_exists/4
deregister_mf/2
deregister_mf/3
insert_mf/3
insert_new_mf/3
metrics/2
mf_constant_labels/1
mf_data/1
mf_duration_unit/1
mf_labels/1
remove_labels/4

Function Details

check_mf_exists/3

check_mf_exists(Table, Registry, Name) -> false | tuple()

check_mf_exists/4

check_mf_exists(Table, Registry, Name, LabelValues) -> dynamic() | no_return()

deregister_mf/2

deregister_mf(Table, Registry) -> boolean() | no_return()

deregister_mf/3

deregister_mf(Table, Registry, Name) -> boolean() | no_return()

insert_mf/3

insert_mf(Table, Module, Spec) -> boolean()

insert_new_mf/3

insert_new_mf(Table, Module, Spec) -> ok | no_return()

metrics/2

metrics(Table::ets:table(), Registry::prometheus_registry:registry()) -> dynamic()

mf_constant_labels/1

mf_constant_labels(MF::tuple()) -> dynamic()

mf_data/1

mf_data(MF::tuple()) -> dynamic()

mf_duration_unit/1

mf_duration_unit(MF::tuple()) -> dynamic()

mf_labels/1

mf_labels(MF::tuple()) -> dynamic()

remove_labels/4

remove_labels(Table, Registry, Name, LValues) -> boolean() | no_return()


Generated by EDoc