Ruby on Rails Structured Event Analytics

Implementation evidence

Ruby on Rails Structured Event Analytics: from boundary to verified row

Use Ruby on Rails Structured Event Analytics at a controlled application boundary, keep the event contract small, and verify a known outcome before building aggregate views.

1
Choose the outcome
Rails request monitoring
2
Define the contract
controller_action, method, and status_code
3
Instrument the boundary
Send an allowlisted payload rather than serializing request parameters.
4
Verify the evidence
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.

Before you start

Prerequisites and boundaries

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.

1Prepare one reusable server-side delivery client with bounded network behavior.
2Add the outcome event at the success, failure, retry, or timeout boundary.
3Send controlled fixtures 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 contract

controller_action, method, and status_code

status, latency_ms, and error_type

request_id, account_id, and release

Implementation checkpoints

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

Production boundary

Keep the outcome event small and recoverable

This pattern provides

A bounded, SQL-ready outcome beside the upstream workflow.
Stable fields for dashboards, alerts, and cross-event correlation.
A fixture-driven path for validating success, failure, retry, and timeout behavior.

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

Event schema starting points

Review the row grain, emit boundary, required types, privacy classes, example payload, and validation checklist before adapting a query or snippet to production.

Product lifecycle7 fields