PromEx v1.1.1
PromEx

PromEx.MetricTypes.Event (PromEx v1.1.1) View Source

This struct defines the fields necessary to export a group of standard metrics from a plugin.

Link to this section Summary

Types

t()
  • group_name: A unique identifier for the collection of metrics.
  • metrics: A list of Telemetry Metrics structs that define the metrics.

Functions

build(group_name, metrics)

Create a struct that encompasses a group of event based metrics. The group_name should be unique and should follow the following convention: <APPLICATION>_<SHORT DESCRIPTION>_event_metrics. For example, Phoenix HTTP related metrics have a group_name of: :phoenix_http_event_metrics

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %PromEx.MetricTypes.Event{
  group_name: atom(),
  metrics: [PromEx.telemetry_metrics()]
}
  • group_name: A unique identifier for the collection of metrics.
  • metrics: A list of Telemetry Metrics structs that define the metrics.

Link to this section Functions

Link to this function

build(group_name, metrics)

View Source

Specs

build(group_name :: atom(), metrics :: [PromEx.telemetry_metrics()]) :: t()

Create a struct that encompasses a group of event based metrics. The group_name should be unique and should follow the following convention: <APPLICATION>_<SHORT DESCRIPTION>_event_metrics. For example, Phoenix HTTP related metrics have a group_name of: :phoenix_http_event_metrics