Winston Structured Event Analytics

Implementation evidence

Winston Structured Event Analytics: from boundary to verified row

Use Winston Structured Event Analytics at a controlled application boundary, keep the event contract small, and verify a known outcome before building aggregate views.

1
Choose the outcome
Node.js workflow monitoring
2
Define the contract
operation, request_id or job_id, status, and release
3
Instrument the boundary
Use Winston transports and formats for diagnostic logs; send only the terminal fields required for a defined Telemetry question.
4
Verify the evidence
Exercise a known fixture, then inspect job_completed for one correctly typed terminal row.

Before you start

Prerequisites and boundaries

Winston and telemetry-sh initialized once in a server or worker process
Stable operation names, correlation IDs, error categories, and releases
A shutdown policy for both Winston transports and outstanding Telemetry requests

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.

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

winston-node

Winston Structured Event Analytics event

javascript

import winston from "winston";
import telemetry from "telemetry-sh";

const logger = winston.createLogger({
  format: winston.format.json(),
  transports: [new winston.transports.Console()],
});

const startedAt = performance.now();
try {
  const result = await processImport();
  const outcome = {
    operation: "customer_import",
    job_id: jobId,
    status: "success",
    duration_ms: Math.round(performance.now() - startedAt),
    item_count: result.itemCount,
    release: process.env.APP_RELEASE,
  };

  logger.info("customer import completed", outcome);
  await telemetry.log("job_completed", outcome);
  return result;
} catch (error) {
  const outcome = {
    operation: "customer_import",
    job_id: jobId,
    status: "failed",
    duration_ms: Math.round(performance.now() - startedAt),
    error_type: classifyError(error),
    release: process.env.APP_RELEASE,
  };

  logger.error("customer import failed", { ...outcome, error });
  await telemetry.log("job_completed", outcome);
  throw error;
}

Event contract

operation, request_id or job_id, status, and release

duration_ms, error_type, retry_count, and item_count

service, environment, feature, and approved account context

Implementation checkpoints

Checkpoint 1

Use Winston transports and formats for diagnostic logs; send only the terminal fields required for a defined Telemetry question.

Checkpoint 2

Do not create a Winston transport that forwards arbitrary log records unless every message and metadata field has a reviewed schema and redaction policy.

Checkpoint 3

Test delivery rejection and shutdown behavior separately because completing one transport does not flush another network client.

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.

winston-node-verification

Winston Structured Event Analytics verification query

sql

SELECT *
FROM job_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 Batching and shutdown Event schema design Winston repository and documentation

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