View Source Zexbox.Metrics (Zexbox v0.8.0)

A module for handling and standardising metrics in Zexbox applications.

If you want to attach metrics to other events, you can use Zexbox.Metrics.attach_telemetry/3:

Examples

def start(_type, _args) do
  Zexbox.Metrics.attach_telemetry(:my_event, [:my, :params], &my_handler/1)
end

Public API

The following functions are provided by this module:

Summary

Functions

Attaches metrics to the Phoenix endpoint stop event.

Attaches metrics to the given event with the given params.

Functions

Link to this function

attach_controller_metrics()

View Source
@spec attach_controller_metrics() :: :ok

Attaches metrics to the Phoenix endpoint stop event.

Examples

iex> Zexbox.Metrics.attach_controller_metrics()
:ok
Link to this function

attach_telemetry(event, params, function)

View Source
@spec attach_telemetry(
  event_name :: binary(),
  event_params :: [atom() | :stop],
  callback :: (any(), any(), any(), any() -> any())
) :: :ok

Attaches metrics to the given event with the given params.

Note: The metrics will only be attached if the application environment variable :capture_telemetry_events is set to true.

Examples

iex> Zexbox.Metrics.attach_telemetry(:my_event, [:my, :event], &MyAppHandler.my_handler/3)
:ok