Sidekiq job telemetry

Test the integration

Send and verify events with Sidekiq job telemetry

Use Sidekiq job telemetry where your app knows the final result. Collect only the fields you need, then verify a test event before building charts.

1
Choose the outcome
Sidekiq retry monitoring
2
Define the contract
job_id, job_name, queue_name, attempt, status, duration_ms, and release
3
Log the final result
The initializer registers server middleware. The same logical jid is retained across Sidekiq retries; the first attempt is 1 and retry_count 0 means attempt 2. Invalid retry metadata stays unknown.
4
Check the stored event
Exercise a known fixture, then inspect job_attempt_completed for one correctly typed terminal row.

Before you start

A server-side TELEMETRY_API_KEY with write access
Put this example in config/initializers/telemetry_sidekiq.rb, loaded once in each worker process
Sidekiq 7 or later with Sidekiq::ServerMiddleware

Delivery setup

Install and initialize server-side

Use a small Net::HTTP wrapper with a server-side key plus explicit open and read timeouts. Keep ingestion credentials out of browser bundles, client-visible environment variables, source control, logs, and exception messages.

1Create one reusable server-side client. Set its timeout and retry limit.
2Log an event when the operation succeeds, fails, retries, or times out.
3Send test events with known results and inspect the stored rows before enabling an alert.

Snippet

Start with one structured event

Add this shape where the workflow completes, fails, or retries. Then build the dashboard from real fields.

sidekiq

Sidekiq job telemetry event

ruby

# config/initializers/telemetry_sidekiq.rb
require "sidekiq"
require "json"
require "net/http"
require "uri"

module TelemetrySidekiqAttempts
  def self.delivery_failed
    warn "Telemetry job event delivery failed."
  rescue StandardError
    # A broken diagnostic sink must not change the job outcome.
  end

  def self.log(fields)
    key = ENV["TELEMETRY_API_KEY"]
    return if key.nil? || key.empty?

    uri = URI("https://api.telemetry.sh/log")
    request = Net::HTTP::Post.new(uri)
    request["Authorization"] = key
    request["Content-Type"] = "application/json"
    request.body = { table: "job_attempt_completed", data: fields }.to_json
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true
    http.open_timeout = 1
    http.read_timeout = 1
    http.write_timeout = 1
    http.max_retries = 0
    response = http.start { |client| client.request(request) }
    delivery_failed unless response.is_a?(Net::HTTPSuccess)
  rescue StandardError
    delivery_failed
  end
end

class TelemetryOutcomeMiddleware
  include Sidekiq::ServerMiddleware

  def call(_job_instance, job, queue)
    started = Process.clock_gettime(Process::CLOCK_MONOTONIC)
    status = "not_returned"
    begin
      result = yield
      status = "returned"
      result
    rescue StandardError
      status = "raised"
      raise
    ensure
      begin
        retry_count = job["retry_count"]
        attempt = if !job.key?("retry_count")
          1
        elsif retry_count.is_a?(Integer) && retry_count >= 0
          retry_count + 2
        end
        TelemetrySidekiqAttempts.log({
          job_id: job["jid"],
          job_name: job["class"],
          queue_name: queue,
          attempt: attempt,
          status: status,
          duration_ms: ((Process.clock_gettime(
            Process::CLOCK_MONOTONIC
          ) - started) * 1000).round(2),
          release: ENV["APP_RELEASE"]
        })
      rescue StandardError
        TelemetrySidekiqAttempts.delivery_failed
      end
    end
  end
end

Sidekiq.configure_server do |config|
  config.server_middleware do |chain|
    chain.add TelemetryOutcomeMiddleware
  end
end

Event schema

job_id, job_name, queue_name, attempt, status, duration_ms, and release

No job arguments, result bodies, exception messages, or application account data

Check your setup

Checkpoint 1

The initializer registers server middleware. The same logical jid is retained across Sidekiq retries; the first attempt is 1 and retry_count 0 means attempt 2. Invalid retry metadata stays unknown.

Checkpoint 2

A returned job block is not proof of downstream delivery. StandardError is recorded as raised and re-raised unchanged; other non-returning exits remain not_returned.

Checkpoint 3

The example does not measure queue wait, retry exhaustion, or Active Job's separate retry policy. Add those at their own verified lifecycle hooks.

Checkpoint 4

Duration uses a monotonic clock and excludes the synchronous export time. Export still occupies the worker and adds processing latency.

Checkpoint 5

Transport, non-2xx, encoding, metadata, and diagnostic failures are contained. A missing key skips export without changing the job result or original exception.

Checkpoint 6

Open, read, and write timeouts are one second each, not a hard total deadline. There is no export retry, durable queue, or shutdown drain; use an application-owned outbox when loss is unacceptable.

Verification

Prove the event arrived

Run this after exercising known success and failure cases. Replace the fallback table name if your final event contract differs from the snippet.

sidekiq-verification

Sidekiq job telemetry verification query

sql

SELECT *
FROM job_attempt_completed
ORDER BY timestamp_utc DESC
LIMIT 20;

Confirm one terminal row per logical outcome, with the expected status, identifiers, units, and UTC time.

Inspect the inferred schema and verify that retries do not change field types or generate a new logical event ID.

Search the stored fields for credentials, raw payloads, prompts, private content, and unbounded error messages.

Exercise a provider timeout, ingestion rejection, and process shutdown before treating the dashboard as complete.

Implementation references

Review the event contract, data-safety guidance, and upstream primary documentation before enabling a new production path.

Ruby HTTP integration Queue worker guide Retry-storm SQL Sidekiq middleware Sidekiq error handling

Where to log

Keep the outcome event small and recoverable

This pattern provides

Record the outcome as an event you can query with SQL.
Stable fields for dashboards, alerts, and cross-event correlation.
Test events for checking success, failure, retries, and timeouts.

This pattern does not provide

An OTLP exporter, automatic collection pipeline, or replacement for detailed traces and diagnostic logs.
Exactly-once delivery merely because the payload contains an event ID.
Permission to collect raw provider payloads, user content, credentials, or regulated data.

Delivery and idempotency Batching and shutdown Troubleshoot ingestion

Example event schemas

Check what each event records, when to send it, and which field types it needs. Review the example payload and privacy checklist before using it in production.

Async reliability11 fields