OpenTelemetry Context in Structured Events

Implementation evidence

OpenTelemetry Context in Structured Events: from boundary to verified row

Use OpenTelemetry Context in Structured Events at a controlled application boundary, keep the event contract small, and verify a known outcome before building aggregate views.

1
Choose the outcome
Trace-to-event correlation
2
Define the contract
trace_id and span_id from the active span
3
Instrument the boundary
This pattern enriches a Telemetry event with OpenTelemetry context; it does not send OTLP data to Telemetry.
4
Verify the evidence
Exercise a known fixture, then inspect checkout_completed for one correctly typed terminal row.

Before you start

Prerequisites and boundaries

An existing OpenTelemetry SDK and context propagation setup
The telemetry-sh package initialized server-side
A defined business event that complements span-level diagnostics

Delivery setup

Install and initialize server-side

Import telemetry-sh in server-only code and initialize it once with process.env.TELEMETRY_API_KEY. Keep ingestion credentials out of browser bundles, client-visible environment variables, source control, logs, and exception messages.

opentelemetry-install

npm installation

bash

npm install telemetry-sh

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.

opentelemetry

OpenTelemetry Context in Structured Events event

javascript

import { trace } from "@opentelemetry/api";

const spanContext = trace.getActiveSpan()?.spanContext();

await telemetry.log("checkout_completed", {
  status: "success",
  latency_ms: 684,
  trace_id: spanContext?.traceId,
  span_id: spanContext?.spanId,
  checkout_version: "v2",
  account_id: account.id,
});

Event contract

trace_id and span_id from the active span

workflow name, status, duration, and error category

Safe account, release, or feature dimensions

Implementation checkpoints

Checkpoint 1

This pattern enriches a Telemetry event with OpenTelemetry context; it does not send OTLP data to Telemetry.

Checkpoint 2

Emit the business outcome once, while spans retain dependency-level timing.

Checkpoint 3

Treat trace and span IDs as correlation fields for lookup, not chart dimensions.

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.

opentelemetry-verification

OpenTelemetry Context in Structured Events verification query

sql

SELECT *
FROM checkout_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.

Logs, metrics, traces, and events Correlation IDs OpenTelemetry JavaScript

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.

API reliability10 fields