Node

Embed
Preview of the card
<a href="https://forumulate.com/p/watchtower/docs/onboarding-node"><img src="https://forumulate.com/api/public/orgs/watchtower/spaces/docs/pages/167bd1f7-30f4-41ee-820a-b28810587385/social-card.svg?v=3e7ae33eec8b" alt="Node" width="600" height="315"></a>

<!-- status: ga language: node -->

Node.js

Send traces from a Node.js service to Watchtower over OTLP/HTTP with the standard OpenTelemetry SDK. Nothing Watchtower-specific is installed: the SDK reads the standard OTEL_* variables.

  1. Create a project, then an ingestion key (wti_...) with the ingest:traces scope. The key is shown once.

  2. Point the SDK at the gateway and pass the key in the x-watchtower-key header (Authorization: Bearer wti_... works too):

export OTEL_EXPORTER_OTLP_ENDPOINT=https://ingest.example.com
export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
export OTEL_EXPORTER_OTLP_HEADERS=x-watchtower-key=wti_YOUR_KEY
export OTEL_SERVICE_NAME=my-service

  1. Add the SDK and run this once. The endpoint above is the gateway's base URL; the SDK appends /v1/traces.

npm install @opentelemetry/sdk-node @opentelemetry/exporter-trace-otlp-http @opentelemetry/api
// tracing.js, loaded first: node --require ./tracing.js app.js
const { NodeSDK } = require('@opentelemetry/sdk-node');
const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-http');
const { trace } = require('@opentelemetry/api');

const sdk = new NodeSDK({ traceExporter: new OTLPTraceExporter() }); // reads OTEL_EXPORTER_OTLP_*
sdk.start();

trace.getTracer('onboarding').startSpan('hello-watchtower').end();
process.on('beforeExit', () => sdk.shutdown());

  1. Open the project's onboarding screen. It polls GET /v1/projects/{prj}/onboarding/first-event and turns green when the first span arrives. Then open the trace in the trace explorer.

Updated