Node.js — Containers & VMs

This guide covers Node.js applications running on ECS, EC2, Kubernetes, or any container/VM environment. For AWS Lambda, see the Node.js Lambda guide.

1. Install the OpenTelemetry SDK

npm install --save @opentelemetry/auto-instrumentations-node

2. Enable Auto Instrumentation

Enable auto instrumentation by requiring the auto-instrumentations-node module using the --require flag:

node --require '@opentelemetry/auto-instrumentations-node/register' app.js

3. Set Environment Variables

Add these environment variables to your service. Replace YOUR_TRACE0_ENV_API_KEY with the API key from your Trace0 environment.

Variable	Value
`OTEL_EXPORTER_OTLP_ENDPOINT`	`https://app.trace0hq.com/api`
`OTEL_EXPORTER_OTLP_HEADERS`	`X-API-KEY=YOUR_TRACE0_ENV_API_KEY`
`OTEL_EXPORTER_OTLP_PROTOCOL`	`http/protobuf`

4. Add Logger

To correlate logs with traces in Trace0, your application must use an OpenTelemetry-supported logger. We recommend using Pino, a low overhead JavaScript logger for Node.js. The instructions below use Pino, but the same approach applies to other supported loggers such as Winston. First, install the library:

npm install pino

Then create a logger.js file:

import pino from 'pino';

const logger = pino({
  mixin() {
    return {
      'service.name': process.env['OTEL_SERVICE_NAME'],
    };
  },

  formatters: {
    level: (label) => {
      return { level: label };
    },
  },
});

export default logger;

Finally, use the logger in your app:

import logger from './logger.js';

logger.info(`Hello world!`);

All logs will now be exported to the Trace0 ingest endpoint.

5. Kubernetes Setup

If your application runs on Kubernetes, including Amazon EKS, Google Kubernetes Engine or Azure Kubernetes Service, add the following environment variables to your container specification.

env:
  - name: K8S_POD_UID
    valueFrom:
      fieldRef:
        fieldPath: metadata.uid

  - name: K8S_POD_NAME
    valueFrom:
      fieldRef:
        fieldPath: metadata.name

  - name: K8S_NAMESPACE_NAME
    valueFrom:
      fieldRef:
        fieldPath: metadata.namespace

  - name: K8S_CONTAINER_NAME
    value: my-container-name

  - name: OTEL_RESOURCE_ATTRIBUTES
    value: k8s.pod.uid=$(K8S_POD_UID),k8s.pod.name=$(K8S_POD_NAME),k8s.namespace.name=$(K8S_NAMESPACE_NAME),k8s.container.name=$(K8S_CONTAINER_NAME)

6. Deploy Service

Deploy your service and watch traces, metrics, and logs appear in the Trace0 dashboard within seconds.

Example Service

See our example apps for working Node.js services with Trace0 installed:

Example	Environment
Node.js Express Docker example app	Docker
Node.js Express EC2 example app	AWS EC2
OpenTelemetry demo app	Docker/Kubernetes

Introduction

Getting Started

Platform

Agents

Setup Guides

Pricing

Security

FAQ

Node.js — Containers & VMs

1. Install the OpenTelemetry SDK

2. Enable Auto Instrumentation

3. Set Environment Variables

4. Add Logger

5. Kubernetes Setup

6. Deploy Service

Example Service

​1. Install the OpenTelemetry SDK

​2. Enable Auto Instrumentation

​3. Set Environment Variables

​4. Add Logger

​5. Kubernetes Setup

​6. Deploy Service

​Example Service

1. Install the OpenTelemetry SDK

2. Enable Auto Instrumentation

3. Set Environment Variables

4. Add Logger

5. Kubernetes Setup

6. Deploy Service

Example Service