Parrhesia.Telemetry (parrhesia v0.12.0)

Copy Markdown

Supervision entrypoint and helpers for relay telemetry.

Starts the Prometheus reporter and telemetry poller as supervised children. All relay metrics are namespaced under parrhesia.* and exposed through the /metrics endpoint in Prometheus exposition format.

Summary

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

emit(event_name, measurements, metadata \\ %{})
emit_process_mailbox_depth(process_type, metadata \\ %{})
metrics()
prometheus_reporter()
start_link(init_arg \\ [])

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

emit(event_name, measurements, metadata \\ %{})

@spec emit([atom()], map(), map()) :: :ok

emit_process_mailbox_depth(process_type, metadata \\ %{})

@spec emit_process_mailbox_depth(atom(), map()) :: :ok

metrics()

@spec metrics() :: [Telemetry.Metrics.t()]

prometheus_reporter()

@spec prometheus_reporter() :: atom()

start_link(init_arg \\ [])

@spec start_link(keyword()) :: Supervisor.on_start()