shigoto_telemetry (shigoto v1.9.10)

Telemetry events for Shigoto job lifecycle, queue operations, and resilience.

Every event is emitted through telemetry:execute/3. The tables below are the stable event contract: attach a handler to any of these event names to feed a metrics reporter (telemetry_metrics, Prometheus, StatsD, ...). See the Telemetry guide for a worked telemetry_metrics example.

Measurement units:

count is always 1 (increment a counter/sum).
duration is in native time units (erlang:monotonic_time/0 deltas).
duration_ms, queue_wait_ms, retry_after_ms are milliseconds.
progress is a percentage (0..100).
claimed is a job count (jobs claimed by that poll).

Every event carries domain => [shigoto] in its metadata (used by the OTP logger for filtering); it is omitted from the tables below for brevity.

Job Events

Event	Measurements	Metadata
`[shigoto, job, inserted]`	`count`	job_id, worker, queue, attempt, priority
`[shigoto, job, claimed]`	`count, queue_wait_ms`	job_id, worker, queue, attempt, priority
`[shigoto, job, completed]`	`count, duration, duration_ms, queue_wait_ms`	job_id, worker, queue, attempt, priority
`[shigoto, job, failed]`	`count, duration, duration_ms, queue_wait_ms`	job_id, worker, queue, attempt, priority, reason
`[shigoto, job, snoozed]`	`count`	job_id, worker, queue, attempt, priority, snooze_reason
`[shigoto, job, discarded]`	`count`	job_id, worker, queue, attempt, priority
`[shigoto, job, cancelled]`	`count`	job_id, worker, queue, attempt, priority
`[shigoto, job, progress]`	`progress`	job_id, worker, queue, attempt, priority, progress

Queue Events

Event	Measurements	Metadata
`[shigoto, queue, poll]`	`count, claimed`	queue
`[shigoto, queue, paused]`	`count`	queue
`[shigoto, queue, resumed]`	`count`	queue

Resilience Events

Event	Measurements	Metadata
`[shigoto, resilience, rate_limited]`	`count, retry_after_ms`	worker
`[shigoto, resilience, circuit_open]`	`count`	worker
`[shigoto, resilience, bulkhead_full]`	`count`	worker
`[shigoto, resilience, load_shed]`	`count`	priority

Batch Events

Event	Measurements	Metadata
`[shigoto, batch, completed]`	`count`	batch_id, total_jobs, completed_jobs, discarded_jobs

Cron Events

Event	Measurements	Metadata
`[shigoto, cron, scheduled]`	`count`	name, worker, schedule

Testing Events

Event	Measurements	Metadata
`[shigoto, testing, mode_armed]`	`count`	mode

Emitted once at boot when a non-production testing mode (inline/manual) is armed. Its presence in a production metrics stream is a red flag — test-only insert behaviour is active. See shigoto_config:testing_mode/0.

Summary

Functions

batch_completed(Batch)

cron_scheduled(Name, Worker, Schedule)

job_cancelled(Job)

job_claimed(Job)

job_completed(Job, Duration)

job_discarded(Job)

job_failed(Job, Reason, Duration)

job_inserted(Job)

job_progress(Job, Progress)

job_snoozed(Job, Reason)

queue_paused(Queue)

queue_poll(Queue, Claimed)

queue_resumed(Queue)

resilience_bulkhead_full(Worker)

resilience_circuit_open(Worker)

resilience_load_shed(Priority)

resilience_rate_limited(Worker, RetryAfterMs)

testing_mode_armed(Mode)