Ruby on Rails structured event analytics

Test the integration

Send and verify events with Ruby on Rails structured event analytics

Use Ruby on Rails structured event analytics 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
Rails request monitoring
2
Define the contract
controller_action, method, and status_code
3
Log the final result
Send an allowlisted payload rather than serializing request parameters.
4
Check the stored event
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.

Before you start

A server-side TELEMETRY_API_KEY
A small HTTP client with explicit open and read timeouts
Normalized controller action or route names

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.

ruby-rails

Ruby on Rails structured event analytics event

ruby

payload = {
  table: "api_request_completed",
  data: {
    controller_action: "#{controller_name}##{action_name}",
    method: request.method,
    status_code: response.status,
    status: response.server_error? ? "failed" : "success",
    latency_ms: ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at) * 1000).round,
    request_id: request.request_id
  }
}

TelemetryHttp.log(payload)

Event schema

controller_action, method, and status_code

status, latency_ms, and error_type

request_id, account_id, and release

Check your setup

Checkpoint 1

Send an allowlisted payload rather than serializing request parameters.

Checkpoint 2

Handle ingestion failures without printing the API key or changing a completed customer response.

Checkpoint 3

Use the same field types in controllers and Active Job workers.

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.

ruby-rails-verification

Ruby on Rails structured event analytics verification query

sql

SELECT *
FROM api_request_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 guide Redacting sensitive data Rails debugging and logging

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.

Product lifecycle7 fields