Membrane.Telemetry.TimescaleDB.TelemetryHandler (Membrane Telemetry TimescaleDB v0.1.0) View Source

Declares handle_event/4 and metrics register functionality required for :telemetry package.

Link to this section Summary

Functions

Returns handler name.

Registers given metrics by attaching handle_event/4 to :telemetry package. Handler is being attached with name returned by get_handler_name/0.

Unregisters handler from :telemetry package.

Link to this section Functions

Specs

get_handler_name() :: any()

Returns handler name.

By default it is "membrane-timescaledb-handler" but it can be configured via config.exs.

Link to this function

handle_event(event_name, measurement, meta, config)

View Source

Specs

handle_event([atom()], map(), map(), map()) :: :ok

Handles event names previously registered by register_metrics/1 and passes them to Membrane.Telemetry.TimescaleDB.Reporter.send_measurement/3.

Link to this function

register_metrics(metrics)

View Source

Specs

register_metrics(map()) :: :ok | {:error, any()}

Registers given metrics by attaching handle_event/4 to :telemetry package. Handler is being attached with name returned by get_handler_name/0.

Metrics should be of format specified by membrane's core.

Specs

unregister_handler() :: :ok | {:error, :not_found}

Unregisters handler from :telemetry package.