Node.js and Express structured logging

Test the integration

Send and verify events with Node.js and Express structured logging

Use Node.js and Express structured logging 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
API error-rate monitoring
2
Define the contract
route_template, method, and status_code
3
Log the final result
Attach the listener before calling next so it records the final response status.
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 environment variable
The telemetry-sh package initialized during application startup
Stable route templates rather than raw request URLs

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.

node-express-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.

node-express

Node.js and Express structured logging event

javascript

app.use((req, res, next) => {
  const startedAt = performance.now();

  res.on("finish", async () => {
    await telemetry.log("api_request_completed", {
      route_template: req.route?.path ?? "unmatched",
      method: req.method,
      status_code: res.statusCode,
      status: res.statusCode >= 500 ? "failed" : "success",
      latency_ms: Math.round(performance.now() - startedAt),
      request_id: req.id,
      release: process.env.APP_RELEASE,
    });
  });

  next();
});

Event schema

route_template, method, and status_code

status and categorized error_type

latency_ms, request_id, and release

Check your setup

Checkpoint 1

Attach the listener before calling next so it records the final response status.

Checkpoint 2

Use the matched Express route pattern and router base URL; never send query strings or raw request bodies.

Checkpoint 3

Decide whether aborted requests need a separate status and exercise that branch in a test.

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.

node-express-verification

Node.js and Express structured logging 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.

Structured logging guide Correlation IDs Express middleware guide

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