Module oc_stat_view
Data Types
description()
description() = binary() | string()
name()
name() = atom() | binary() | string()
view_data()
view_data() = #{name => name(), description => description(), ctags => oc_tags:tags(), data => oc_stat_aggregation:data()}
Function Index
'__init_backend__'/0 | |
add_sample/3 | |
batch_subscribe/1 |
Subscribe many Views at once. |
deregister/1 | |
export/1 | |
measure_views/1 | |
register/5 | |
registered/1 |
Checks whether a view Name is registered. |
subscribe/1 | |
subscribe/5 | |
subscribed/0 | |
subscribed/1 | |
unsubscribe/1 |
Function Details
'init_backend'/0
__init_backend__() -> any()
add_sample/3
add_sample(X1, ContextTags, Value) -> any()
batch_subscribe/1
batch_subscribe(Views::[name() | map()]) -> ok
Subscribe many Views
at once.
deregister/1
deregister(Name::name()) -> ok
export/1
export(X1::tuple()) -> view_data()
measure_views/1
measure_views(Measure) -> any()
register/5
register(Name::name(), Description::description(), Tags::oc_tags:tags(), Measure::measure_name(), Aggregation::aggregation()) -> ok
registered/1
registered(Name::name()) -> boolean()
Checks whether a view Name
is registered.
subscribe/1
subscribe(Name::map() | name()) -> ok
subscribe/5
subscribe(Name::name(), Description::description(), Tags::oc_tags:tags(), Measure::measure_name(), Aggregation::aggregation()) -> ok
subscribed/0
subscribed() -> any()
subscribed/1
subscribed(X1) -> any()
unsubscribe/1
unsubscribe(Name::name()) -> ok