Cloudflare Worker telemetry

Test the integration

Send and verify events with Cloudflare Worker telemetry

Use Cloudflare Worker 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
Edge API monitoring
2
Define the contract
worker_name, route_template, method, status_code, colo, and trigger_type
3
Log the final result
Use ctx.waitUntil only for a delivery promise whose failure is observed; otherwise a Worker can return before telemetry is flushed.
4
Check the stored event
Exercise a known fixture, then inspect edge_request_completed for one correctly typed terminal row.

Before you start

A Worker secret binding for the Telemetry API key
ExecutionContext available for explicitly managed background delivery
Normalized route names and an allowlist for Cloudflare request metadata

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.

cloudflare-workers-install

npm installation

bash

npm install telemetry-sh

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.

cloudflare-workers

Cloudflare Worker telemetry event

javascript

await telemetry.log("edge_request_completed", {
  worker_name: "events-api",
  route_template: "/api/events",
  method: "POST",
  status_code: 202,
  colo: request.cf?.colo,
  latency_ms: 42,
  status: "success",
  release: env.APP_RELEASE,
});

Event schema

worker_name, route_template, method, status_code, colo, and trigger_type

status, latency_ms, cpu_time_ms when available, and error_type

request_id, queue_name, attempt, release, and environment

Check your setup

Checkpoint 1

Use ctx.waitUntil only for a delivery promise whose failure is observed; otherwise a Worker can return before telemetry is flushed.

Checkpoint 2

Record route templates rather than raw URLs, and do not log cookies, authorization headers, request bodies, client IP addresses, or unrestricted cf properties.

Checkpoint 3

Keep Workers Logs for runtime diagnostics and emit compact Telemetry events for reviewed application outcomes instead of duplicating every console record.

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.

cloudflare-workers-verification

Cloudflare Worker telemetry verification query

sql

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

API reliability use case Correlation IDs API reliability by release Cloudflare Workers observability Cloudflare Worker secrets

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.

API reliability10 fields