ExWapp.Telemetry (ExWapp v0.1.2)

Copy Markdown View Source

Telemetry helpers and canonical event list for ExWapp.

Session events use the [:ex_wapp, :session, ...] prefix. Store, app-state, safety, quota, and client events use their corresponding ExWapp domain prefix.

Summary

Types

event_name()

Functions

attach_many(handler_id, handler, config \\ nil)

Attaches one handler to all ExWapp session events.

detach(handler_id)

Detaches a telemetry handler.

events()

Returns all canonical ExWapp telemetry events.

execute(event, measurements, metadata \\ %{})

Executes an ExWapp session event.

Types

event_name()

@type event_name() :: [atom()]

Functions

attach_many(handler_id, handler, config \\ nil)

@spec attach_many(
  handler_id :: term(),
  handler :: :telemetry.handler_function(),
  config :: term()
) :: :ok | {:error, :already_exists}

Attaches one handler to all ExWapp session events.

detach(handler_id)

@spec detach(term()) :: :ok | {:error, :not_found}

Detaches a telemetry handler.

events()

@spec events() :: [event_name()]

Returns all canonical ExWapp telemetry events.

execute(event, measurements, metadata \\ %{})

@spec execute(atom() | [atom()], map(), map()) :: :ok

Executes an ExWapp session event.