Dynatrace npm module for PaaS

This module adds enterprise grade monitoring for Node.js in PaaS environments that aren't supported by a dedicated integration. Before using this module, please review the Dynatrace documentation to make sure that there isn't already a marketplace integration or buildpack available for your platform.

Installation

• Sign up for free and follow the instructions
• Click on "Deploy Dynatrace"
• Click on "Set up PaaS Integration"
• Generate a PaaS token
• Run $ npm install --save @dynatrace/oneagent in your project directory
• Using the previously created credentials add the following code block as first statement to your application

try {
  require('@dynatrace/oneagent')({
    environmentid: '<environmentid>',
    apitoken: '<paastoken>',
    endpoint: '<endpoint url>', // specify endpoint url - not needed for SaaS customers
    rejectUnauthorized: true // default is false which allows to use a self-signed certificate, see more below
  });
} catch (err) {
  console.log('Failed to load OneAgent: ', err);
}

The rejectUnauthorized option controls TLS certificate verification for the initial request to /v1/deployment/installer/agent/connectioninfo. It has no impact to other OneAgent code module communication nor the monitored application. By default, certificate verification is only enforced for requests to Dynatrace domains (e.g., dynatrace.com).
To enforce TLS certificate verification for all connections and reject self-signed certificates, set rejectUnauthorized: true.

Emitting debug output

To enable debug output set the DEBUG environment variable to dynatrace*. For more detail see the debug module documentation.

Deployment

Deploying Dynatrace to AWS Lambda

Starting with Dynatrace OneAgent 1.207, Dynatrace offers a dedicated AWS Lambda layer to monitor Node.js based AWS Lambda functions. Please review the Dynatrace product news and documentation to learn more.

Deploying Dynatrace to Heroku

Starting with Dynatrace OneAgent 1.141, Dynatrace offers a dedicated buildpack for Heroku. Please refer to our documentation for further instructions.

Deploying Dynatrace to Cloud Foundry

Starting with Dynatrace OneAgent 1.131 and Cloud Foundry Node.js buildpack 1.6.10 Dynatrace is part of the buildpack. Using the buildpack is preferable to the npm module approach due to several improvements. For instance, you're no longer required to install a dependency on @dynatrace/oneagent in your project directory. You also no longer need to add a require statement as the first statement of your application. Please review the Dynatrace product news and documentation to learn more.

Licence

Licensed under the MIT License. See the LICENSE file for details.