HostKit.Telemetry (host_kit v0.1.0-beta.1)

Copy Markdown View Source

Helpers for extracting OpenTelemetry collection intent from HostKit projects.

Summary

Functions

Emits a HostKit telemetry event under the [:host_kit, ...] prefix.

Runs a function while emitting :start, :stop, and :exception telemetry events.

Types

event()

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

measurements()

@type measurements() :: map()

metadata()

@type metadata() :: map()

Functions

config(value)

@spec config(keyword()) :: map()

duration_ms(native_duration)

@spec duration_ms(integer()) :: integer()

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

@spec execute(event(), measurements(), metadata()) :: :ok

Emits a HostKit telemetry event under the [:host_kit, ...] prefix.

signals(project)

span(event, metadata \\ %{}, fun)

@spec span(event(), metadata(), (-> result)) :: result when result: term()

Runs a function while emitting :start, :stop, and :exception telemetry events.