View Source PromEx.MetricTypes.Polling (PromEx v1.9.0)
This struct defines the fields necessary to export a group of pollable metric sources from a plugin.
Link to this section Summary
Types
group_name: A unique identifier for the collection of metrics.measurements_mfa: An MFA tuple that defines what function will be executed that will emit Telemetry events.metrics: A list of Telemetry Metrics structs that define the metrics.poll_rate: An integer representing the millisecond between metrics samples.
Functions
Create a struct that encompasses a group of polling type metrics. The group_name should be unique and should follow
the following convention: <APPLICATION>_<SHORT DESCRIPTION>_manual_metrics. For example, BEAM related memory metrics
have a group_name of: :beam_memory_polling_events
Link to this section Types
Specs
t() :: %PromEx.MetricTypes.Polling{
group_name: atom(),
measurements_mfa: PromEx.measurements_mfa(),
metrics: [PromEx.telemetry_metrics()],
poll_rate: pos_integer()
}
group_name: A unique identifier for the collection of metrics.measurements_mfa: An MFA tuple that defines what function will be executed that will emit Telemetry events.metrics: A list of Telemetry Metrics structs that define the metrics.poll_rate: An integer representing the millisecond between metrics samples.
Link to this section Functions
Specs
build( group_name :: atom(), poll_rate :: pos_integer(), measurements_mfa :: PromEx.measurements_mfa(), metrics :: [PromEx.telemetry_metrics()] ) :: t()
Create a struct that encompasses a group of polling type metrics. The group_name should be unique and should follow
the following convention: <APPLICATION>_<SHORT DESCRIPTION>_manual_metrics. For example, BEAM related memory metrics
have a group_name of: :beam_memory_polling_events