API Reference prometheus v#5.1.1

View Source

Modules

Boolean metric, to report booleans and flags.

A collector for a set of metrics.

Counter is a Metric that represents a single numerical value that only ever goes up. That implies that it cannot be used to count items whose number can also go down, e. g. the number of currently running processes. Those \"counters\" are represented by prometheus_gauge.

Module that implements this behaviour can be used as foramt parameter for exporters.

Gauge metric, to report instantaneous values.

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

HTTP instrumentation helpers

This module provides functions and types for managing Prometheus metrics in Erlang.

Mnesia instrumentation helpers.

Collects Mnesia metrics mainly using mnesia:system_info/1.

Helpers for working with Prometheus data model. For advanced users.

Serializes Prometheus registry using protocol buffer format.

Summary metric, to track the size of events and report quantiles Based on prometheus_summary

A registry of Collectors.

Summary metric, to track the size of events.

Serializes Prometheus registry using the latest text format.

Measuring time intervals with Prometheus.erl. Measuring time intervals is trivial - you just have to be sure you are using monotonic time source. Basically interval is a difference between start time and end time. Erlang has the standard erlang:monotonic_time/0 function that returns so called native time units. Native time units are meaningless and have to be converted to seconds (or other units) using erlang:convert_time_unit/3. However as erlang:convert_time_unit/3 documentation warns

Collects information about the sockets and processes involved in the Erlang distribution mechanism.

Collects information about memory dynamically allocated by the Erlang emulator using erlang:memory/0, also provides basic (D)ETS statistics.

Collects microstate accounting metrics using [erlang:statistics(microstate_accounting)] (http://erlang.org/doc/man/erlang.html#statistics_microstate_accounting).

Collects Erlang VM metrics using erlang:statistics/1.

Collects Erlang VM metrics using erlang:system_info/1.