Runic.Runner.Telemetry (Runic v0.1.0-alpha.7)

Copy Markdown View Source

Telemetry event definitions for Runic.Runner.

All events are emitted under the [:runic, :runner, ...] prefix.

Event Groups

Workflow Events

  • [:runic, :runner, :workflow, :start] — workflow started
  • [:runic, :runner, :workflow, :stop] — workflow completed
  • [:runic, :runner, :workflow, :exception] — workflow exception

Runnable Events

  • [:runic, :runner, :runnable, :start] — runnable dispatched
  • [:runic, :runner, :runnable, :stop] — runnable completed
  • [:runic, :runner, :runnable, :exception] — runnable failed

Store Events

  • [:runic, :runner, :store, :start] — store operation started
  • [:runic, :runner, :store, :stop] — store operation completed
  • [:runic, :runner, :store, :exception] — store operation failed

Promise Events

  • [:runic, :runner, :promise, :start] — promise dispatched
  • [:runic, :runner, :promise, :stop] — promise completed

Summary

Functions

Returns all telemetry event names emitted by the Runner.

Emits a promise lifecycle event.

Emits a rehydration completion event with memory measurements.

Emits a runnable lifecycle event.

Emits a runnable completion event with measurements.

Wraps a store operation in a telemetry span.

Emits a workflow lifecycle event.

Wraps a workflow lifecycle operation in a telemetry span.

Functions

event_names()

Returns all telemetry event names emitted by the Runner.

Useful for :telemetry.list_handlers/1 and handler setup.

promise_event(atom, metadata)

Emits a promise lifecycle event.

Event Types

  • :start — promise dispatched for execution
  • :stop — promise completed (includes duration measurement)

promise_event(atom, measurements, metadata)

rehydration_event(atom, measurements, metadata)

Emits a rehydration completion event with memory measurements.

runnable_event(atom, metadata)

Emits a runnable lifecycle event.

Event Types

  • :dispatch — runnable dispatched for execution
  • :complete — runnable completed successfully
  • :exception — runnable failed

runnable_event(atom, measurements, metadata)

Emits a runnable completion event with measurements.

store_span(operation, metadata, fun)

Wraps a store operation in a telemetry span.

Emits [:runic, :runner, :store, :start] and [:runic, :runner, :store, :stop] (or :exception).

workflow_event(atom, metadata)

Emits a workflow lifecycle event.

Event Types

  • :start — workflow started
  • :stop — workflow completed (includes duration measurement)

workflow_event(atom, measurements, metadata)

workflow_span(metadata, fun)

Wraps a workflow lifecycle operation in a telemetry span.

Emits [:runic, :runner, :workflow, :start] and [:runic, :runner, :workflow, :stop] (or :exception).