Skip to content

Node.js

Collect Node.js/V8 runtime and HTTP metrics from your services and get curated dashboards and alerts for them with a single import.

Node.js apps instrumented with the OpenTelemetry SDK export their metrics over OTLP to your LeanSignal agent gateway (one per cluster or environment) — never to a remote or third-party endpoint. The gateway keeps full fidelity locally and forwards only the demanded subset to your central dataplane. This integration covers the Node/V8 runtime (event-loop utilization and delay, V8 heap, GC pauses) plus HTTP server request metrics.

Metric names follow the standard OTLP → Prometheus normalization (dots become underscores, unit/_total suffixes are added), so nodejs.eventloop.utilization becomes nodejs_eventloop_utilization and http.server.request.duration becomes http_server_request_duration_seconds. The demands below are built against those names.

  • A LeanSignal agent gateway deployed and connected — one per cluster or environment. If you haven’t deployed it yet, follow Install the agent (source: LeanSignal/leansignal-agent). It should show as Connected under Agents in the LeanSignal app.
  • Network reachability to the gateway’s OTLP port4317 (gRPC) or 4318 (HTTP). See Agent configuration.
  • Your Node.js app instrumented with the OpenTelemetry SDK, exporting metrics over OTLP to the gateway — configured in Setup.
  • Editor or admin role in the LeanSignal app (importing a demand creates dashboards and alert rules).

Install the SDK, HTTP auto-instrumentation, the runtime instrumentation, and the OTLP exporters for all three signals, then point the SDK at your LeanSignal agent gateway (OTLP gRPC :4317 / HTTP :4318) — not a SaaS endpoint.

Terminal window
npm i @opentelemetry/sdk-node @opentelemetry/sdk-metrics \
@opentelemetry/auto-instrumentations-node \
@opentelemetry/instrumentation-runtime-node \
@opentelemetry/exporter-metrics-otlp-grpc \
@opentelemetry/exporter-trace-otlp-grpc \
@opentelemetry/api-logs @opentelemetry/sdk-logs \
@opentelemetry/exporter-logs-otlp-grpc
Terminal window
export OTEL_EXPORTER_OTLP_ENDPOINT="http://<gateway-host>:4317"
export OTEL_SERVICE_NAME="my-node-service"
export OTEL_SEMCONV_STABILITY_OPT_IN="http" # emit stable http.server.request.duration

Create instrument.js and load it before your app:

const { NodeSDK } = require('@opentelemetry/sdk-node');
const { PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics');
const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-grpc');
const { getNodeAutoInstrumentations } = require('@opentelemetry/auto-instrumentations-node');
const { RuntimeNodeInstrumentation } = require('@opentelemetry/instrumentation-runtime-node');
const sdk = new NodeSDK({
metricReader: new PeriodicExportingMetricReader({ exporter: new OTLPMetricExporter() }),
instrumentations: [
getNodeAutoInstrumentations(), // includes instrumentation-http
new RuntimeNodeInstrumentation({ monitoringPrecision: 5000 }),
],
});
sdk.start();
Terminal window
node -r ./instrument.js app.js # or --import for ESM

The SDK bootstrap from Setup wires a metric reader; the same NodeSDK carries traces and logs to the gateway too — the exporter packages are already on the install line above. Extend instrument.js:

const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-grpc');
const { OTLPLogExporter } = require('@opentelemetry/exporter-logs-otlp-grpc');
const { BatchLogRecordProcessor } = require('@opentelemetry/sdk-logs');
const sdk = new NodeSDK({
// …metricReader and instrumentations from Setup…
traceExporter: new OTLPTraceExporter(),
logRecordProcessors: [new BatchLogRecordProcessor(new OTLPLogExporter())],
});
  • Traces — with the trace exporter in place, the auto-instrumentations do the rest: inbound HTTP requests and outbound calls emit spans with no further code.

  • LogsgetNodeAutoInstrumentations() already includes the @opentelemetry/instrumentation-pino and -winston bridges, so once the log record processor is registered your existing logger is exported as-is:

    const logger = require('pino')();
    logger.info('hello'); // also exported to the gateway as an OTLP log record

    Or keep logging to stdout and ship files with a collector or shipper instead.

See the Node.js OpenTelemetry docs.

Node.js ships as a ready-made demand in three variants. You don’t copy any JSON — in the LeanSignal app go to Demands, press the ˅ arrow on the Add Demand button (the arrow opens the import menu), choose Import from catalog…, and pick the variant. Each variant below lists the slug that identifies its published bundle. See Integrations for the full import flow.

The variants are nested — Standard is a superset of Essential, Extended a superset of Standard. Pick whichever is closest to what you need and treat it as a starting point: after import everything is a normal, editable copy, so retune thresholds, add or drop panels, and adjust queries for your environment — your edits reshape the demand automatically. Start small and re-import a larger variant later if you outgrow it.

The golden signals. 1 dashboard · 4 panels · 3 alerts — traffic, errors, latency, and event-loop saturation at a glance.

Import this variant from the catalog. Its demand slug:

Demand slug
nodejs-otel-demand-essential

Dashboard — HTTP request rate, HTTP 5xx error rate, HTTP request duration p95, and Event-loop utilization.

Alerts (3)

AlertSeverityFires when
High HTTP 5xx error ratecritical5xx ratio > 5% for 5m
High HTTP p95 latencywarningp95 latency > 1s for 5m
Event-loop saturatedcriticalELU > 90% for 5m

Review the bundle JSON →

Each variant imports one Node.js dashboard, its panels grouped into collapsible sections. Every dashboard carries an Instance filter (on the instance label), so one import covers the whole fleet — view every instance at once, or focus on one. Legends are sortable tables showing last/mean/max per series, so the outlier instance stands out. Dashboards are demand-driven: importing one tells your agents to forward exactly the timeseries its panels query, and nothing else. Panels are ordinary Perses panels — edit queries, add panels, or retune them after import, and your changes reshape the demand automatically.

Thresholds are conservative starting points — tune them to your workload.

Was this page helpful?