Crosswake.Companions.Chimeway.Telemetry (crosswake_chimeway v0.1.0)

Copy Markdown View Source

Stable telemetry contract for Chimeway notification diagnostics.

Chimeway telemetry is diagnostic evidence only. It is not auth, session, route, delivery, or notification-open authority, and it never carries raw token material or provider payload bodies.

Summary

Functions

event_names()
execute(name, measurements \\ %{}, metadata \\ %{})
forbidden_metadata_keys()
metadata(event)
metadata_keys()
new_event(attrs)
to_map(event)
valid_event_name?(name)

Functions

event_names()

@spec event_names() :: [[atom()]]

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

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

forbidden_metadata_keys()

@spec forbidden_metadata_keys() :: [atom()]

metadata(event)

@spec metadata(Crosswake.Companions.Chimeway.Telemetry.Event.t() | map() | keyword()) ::
  map()

metadata_keys()

@spec metadata_keys() :: [atom()]

new_event(attrs)

@spec new_event(keyword()) :: Crosswake.Companions.Chimeway.Telemetry.Event.t()

to_map(event)

@spec to_map(Crosswake.Companions.Chimeway.Telemetry.Event.t()) :: map()

valid_event_name?(name)

@spec valid_event_name?(term()) :: boolean()