Example: Send OpenTelemetry Logs with the OpenTelemetry JavaScript SDK

Logs support in the OpenTelemetry JavaScript SDK is currently experimental and subject to change. To check the status for each language, refer to the OpenTelemetry status page.

This example shows how to configure the OpenTelemetry JavaScript SDK to capture Bunyan logging calls and send logs from a JavaScript application to Honeycomb or an OpenTelemetry Collector.

Acquire Dependencies

Install the OpenTelemetry Node.js SDK, Bunyan instrumentation, and Bunyan logging framework packages:

npm install --save @opentelemetry/sdk-node \
    @opentelemetry/instrumentation-bunyan \
    bunyan

Configure the SDK

Create an initialization file (for example, telemetry.js) that sets up the SDK with Bunyan instrumentation. The exporter configuration is provided by the otelconfig.yaml file at runtime.

const { startNodeSDK } = require('@opentelemetry/sdk-node');
const { BunyanInstrumentation } = require('@opentelemetry/instrumentation-bunyan');

const sdk = startNodeSDK({
  instrumentations: [
    new BunyanInstrumentation(),
  ]
});
// Shut down the SDK gracefully before exiting to export all pending logs
process.on('SIGTERM', () => {
    sdk
    .shutdown()
    .finally(() => process.exit(0));
});

Then, in your application, create and use Bunyan loggers to capture interesting things:

const bunyan = require('bunyan');

// Create a logger and use it in your app
const logger = bunyan.createLogger({name: 'myapp', level: 'info'});
logger.info({'app.message':'Something interesting happened'});

Create a Config File

Create an otelconfig.yaml file to configure your exporter.To send logs to Honeycomb:

file_format: "1.1"

resource:
  attributes:
    - name: service.name
      value: ${OTEL_SERVICE_NAME:-my-service}

logger_provider:
  processors:
    - batch:
        exporter:
          otlp_http:
            endpoint: https://api.honeycomb.io
            headers:
              - name: x-honeycomb-team
                value: ${HONEYCOMB_API_KEY}

To send logs to an OpenTelemetry Collector instead:

file_format: "1.1"

resource:
  attributes:
    - name: service.name
      value: ${OTEL_SERVICE_NAME:-my-service}

logger_provider:
  processors:
    - batch:
        exporter:
          otlp_grpc:
            endpoint: http://my-collector:4317

When OTEL_CONFIG_FILE is set, the configuration file is the single source of truth for the SDK. Other OTEL_* environment variables are ignored by design, so set all SDK options in the YAML file. You can still reference environment variables from inside the YAML using ${VAR_NAME} substitution.

Run Your Application

Point the SDK at your configuration file using OTEL_CONFIG_FILE, then run your application:

OTEL_CONFIG_FILE=./otelconfig.yaml node -r ./telemetry.js app.js

Supported Logging Frameworks

The OpenTelemetry JavaScript SDK can automatically create logs from these supported logging frameworks:

Bunyan
Winston

Example: SDK Logs + Java Example: SDK Logs + Go

Instrument Applications

Instrument Infrastructure

CI/CD Observability

Manage Pipelines

Shape Data

Control Data Volume

Use Cases

Example: Send OpenTelemetry Logs with the OpenTelemetry JavaScript SDK

Acquire Dependencies

Configure the SDK

Create a Config File

Run Your Application

Supported Logging Frameworks

Acquire Dependencies

Configure the SDK

Create a Config File

Run Your Application

​Supported Logging Frameworks

Supported Logging Frameworks