@instana/collector

@instana/collector  

Monitor your Node.js applications with Instana!

Installation | Configuration | API | Changelog

---

• Restrictions
• Breaking Changes
• Installation And Usage
• CPU Profiling, Garbage Collection And Event Loop Information
• API / SDK
• Filing Issues

Restrictions

This package is for monitoring Node.js server applications with Instana.

For monitoring JavaScript applications that:

• Run in a browser, see Website Monitoring.

• Run on Amazon Web Services (AWS), see AWS Lambda or AWS Fargate.

• Run on Microsoft Azure, see Azure App Services.

• Run on Google Cloud, see Google Cloud Run.

Installation And Usage

The installation of the Instana Node.js collector is a simple two step process. First, install the @instana/collector package in your application via:

npm install --save @instana/collector

Now that the collector is installed, it needs to be activated from within the application. Do this by requiring and initializing it as the first statement in your application. Please take care that this is the first statement as the collector will otherwise not be able to access certain information.

require('@instana/collector')();

// All other require statements must be done after the collector is initialized.
// Note the () after the require statement of the collector which initializes it.

// const express = require('express');

For more in-depth information, refer to the installation page.

CPU Profiling, Garbage Collection And Event Loop Information

The Node.js collector uses Native addons for some metrics. Check out the native addons documentation for details.

API / SDK

In most cases it is enough to require and initialize @instana/collector and let it do its work. However, there is an API / SDK for more advanced use cases.

Filing Issues

If something is not working as expected or you have a question, instead of opening an issue in this repository, please open a ticket at https://www.ibm.com/mysupport instead. Please refrain from filing issues or tickets if your audit tool (npm audit, Snyk, etc.) reported a CVE for a dependency or a transitive dependency of @instana/collector -- we run these audits with every build and take appropriate action automatically.