Next.js server event analytics

Test the integration

Send and verify events with Next.js server event analytics

Use Next.js server 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
Existing route handler outcomes
2
Define the contract
invocation_id, route_template, and method
3
Log the final result
Use the linked helper in a Node.js App Router route handler on a current patched Next.js release.
4
Check the stored event
Exercise a known fixture, then inspect nextjs_route_observed for one correctly typed terminal row.

Before you start

A server-only TELEMETRY_API_KEY environment variable
The withTelemetry server helper from the linked Next.js App Router recipe
A named workflow whose success and failure definitions are documented

Delivery setup

Install and initialize server-side

This server-side example sends events through the Log API with a server-side key and a bounded fetch request; no Telemetry SDK initialization is needed. 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.

nextjs

Next.js server event analytics event

javascript

import { withTelemetry } from "@/lib/with-telemetry";

// Copy the helper from the linked Next.js App Router recipe.
// Keep your existing POST handler's authentication and business logic.
export const POST = withTelemetry(existingPOST, "/api/projects");

Event schema

invocation_id, route_template, and method

handler_outcome and status_code

latency_ms and environment

Check your setup

Checkpoint 1

Use the linked helper in a Node.js App Router route handler on a current patched Next.js release.

Checkpoint 2

The linked helper preserves the handler response when event delivery fails; background delivery is best effort, not a durable queue.

Checkpoint 3

Do not put API keys in NEXT_PUBLIC variables or send raw form data.

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.

nextjs-verification

Next.js server event analytics verification query

sql

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

Next.js App Router recipe JavaScript SDK Sensitive-data controls Next.js Route Handlers

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