Pino structured event analytics

Test the integration

Send and verify events with Pino structured event analytics

Use Pino structured 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
Node.js API reliability
2
Define the contract
request_id, route_template, method, status_code, and status
3
Log the final result
Keep detailed diagnostic logs in Pino. Send a separate event to Telemetry when the request or workflow finishes.
4
Check the stored event
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.

Before you start

Pino and telemetry-sh initialized once in a trusted Node.js runtime
Stable route templates, workflow names, request IDs, and release identifiers
A field allowlist and Pino redaction rules for credentials and private content

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.

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

pino-node

Pino structured event analytics event

javascript

import pino from "pino";
import telemetry from "telemetry-sh";

const logger = pino();
const startedAt = performance.now();

try {
  const result = await runCheckout();
  const outcome = {
    request_id: requestId,
    route_template: "/api/checkout",
    method: "POST",
    status_code: 200,
    status: "success",
    latency_ms: Math.round(performance.now() - startedAt),
    release: process.env.APP_RELEASE,
  };

  logger.info(outcome, "checkout completed");
  await telemetry.log("api_request_completed", outcome);
  return result;
} catch (error) {
  const outcome = {
    request_id: requestId,
    route_template: "/api/checkout",
    method: "POST",
    status_code: 500,
    status: "failed",
    latency_ms: Math.round(performance.now() - startedAt),
    error_type: classifyError(error),
    release: process.env.APP_RELEASE,
  };

  logger.error({ ...outcome, err: error }, "checkout failed");
  await telemetry.log("api_request_completed", outcome);
  throw error;
}

Event schema

request_id, route_template, method, status_code, and status

latency_ms, error_type, release, environment, and service

account_id or tenant_id only when approved for operational analysis

Check your setup

Checkpoint 1

Keep detailed diagnostic logs in Pino. Send a separate event to Telemetry when the request or workflow finishes.

Checkpoint 2

Share an approved request_id between systems for correlation, but do not copy log messages, request bodies, headers, or exception stacks into the event.

Checkpoint 3

Wait for the Telemetry promise or handle its result before the application exits. Use an outbox if you cannot afford to lose events.

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.

pino-node-verification

Pino 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.

JavaScript SDK API reliability guide Redacting sensitive data Pino documentation Pino redaction guidance

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