OpenTelemetry interoperability in Node.js

OneAgent version 1.229+

OpenTelemetry interoperability connects the Dynatrace AWS Lambda extension to the OpenTelemetry Node.js instrumentation to use the instrumentation packages and extensions. You can then monitor technologies like databases or messaging frameworks that aren't supported by Dynatrace AWS Lambda extension out of the box.

Before you start

Use OpenTelemetry Node.js instrumentation

When using an OpenTelemetry Node.js instrumentation, the configuration of all necessary OpenTelemetry SDK components and the registration of a TracerProvider are automatically handled by the Dynatrace AWS Lambda extension, so you don't need to register another TracerProvider.

Instrumentation packages for JavaScript can be found in the OpenTelemetry JavaScript contributions repository. Note that

const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const { PgInstrumentation } = require('@opentelemetry/instrumentation-pg');

// You must create the PgInstrumentation (and other instrumentations)
// before loading any corresponding modules, such as `require('pg')`.
registerInstrumentations({
  instrumentations: [
    new PgInstrumentation(),
  ],
});

const { Client } = require('pg');

exports.handler = async function myHandler(event, context) {
  let client;
  try {
    client = new Client(/* DB connection information */);
    await client.connect();
    const result = await client.query('SELECT * FROM users;');
    return result.rows;
  } finally {
    client?.end();
  }
}

To instrument the AWS SDK for JavaScript, OpenTelemetry provides the opentelemetry/instrumentation-aws-sdk instrumentation package.

const AWS = require('aws-sdk');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const { AwsInstrumentation } = require('@opentelemetry/instrumentation-aws-sdk');

registerInstrumentations({
  instrumentations: [
    new AwsInstrumentation()
  ]
});

exports.handler = function(event, context) {
  const ddb = new AWS.DynamoDB();

  const dbParamsGetDelete = {
    TableName: 'E2E_test_table',
    Key: {
      'svnr': { N: '1234'}
    }
  };
  ddb.getItem(dbParamsGetDelete, function(err, data) {
    if (err) {
      console.error('Error', err);
    } else {
      console.log('Success', data.Item);
    }
  });
};

Use OpenTelemetry Node.js API

OpenTelemetry JavaScript can be used in an SDK-like approach to trace additional operations that aren't covered by an instrumentation package.

const opentelemetry = require('@opentelemetry/api');

const tracer = opentelemetry.trace.getTracer('my-package-name');

exports.handler = function(event, context) {
  // create a span using the OTel API
  const span = tracer.startSpan('do some work');
  span.setAttribute('foo', 'bar');
  span.end();

  // ...

  const response = {
    statusCode: 200,
    body: JSON.stringify('Hello from Node.js'),
  };
  return response;
};

Trace AWS SQS and SNS messages with Node.js

OneAgent version 1.253+ for SQS OneAgent version 1.257+ for SNS

You can use @opentelemetry/instrumentation-aws-sdk package to trace AWS SQS and SNS messages and collect the traces via Dynatrace AWS Lambda extension.

Install the required dependencies

Set up tracing

Send an SQS/SNS message

Receive an SQS/SNS message

Install the required dependencies

npm install @opentelemetry/api @opentelemetry/instrumentation-aws-sdk @opentelemetry/instrumentation aws-sdk

Set up tracing

Use the following code to set up tracing for sending SQS messages to an SQS queue from a Dynatrace-monitored Node.js application:

const { AwsInstrumentation } = require('@opentelemetry/instrumentation-aws-sdk');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

// The instrumentation must be registered before importing the aws-sdk module!
registerInstrumentations({
  instrumentations: [
    new AwsInstrumentation()
  ]
});

// You can now import the aws-sdk module if needed:
const AWS = require('aws-sdk');

Send an SQS/SNS message

Receive an SQS/SNS message