Application Insights for Node.js (Beta)

Important: Breaking changes were introduced in version 3.0.0-beta.7, please take a look at release details.

Application Insights SDK monitors your backend services and components after you deploy them to help you discover and rapidly diagnose performance and other issues. Add this SDK to your Node.js services to include deep info about Node.js processes and their external dependencies such as database and cache services. You can use this SDK for your Node.js services hosted anywhere: your datacenter, Azure VMs and Web Apps, and even other public clouds. This solution is based on OpenTelemetry, to learn more about OpenTelemetry concepts, see the OpenTelemetry overview or OpenTelemetry FAQ.

Important: The Azure Monitor OpenTelemetry-based Offerings for Node.js applications are currently in preview. See the Supplemental Terms of Use for Microsoft Azure Previews for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.

Limitations of current preview release

Consider whether this preview is right for you. It enables distributed tracing, metrics, logs and excludes:

Live Metrics
Autopopulation of Cloud Role Name and Cloud Role Instance in Azure environments
Autopopulation of User ID and Authenticated User ID when you use the Application Insights JavaScript SDK
Autopopulation of User IP (to determine location attributes)
Ability to override Operation Name
Ability to manually set User ID or Authenticated User ID
Propagating Operation Name to Dependency Telemetry

Warning: This SDK only works for Node.js environments. Use the Application Insights JavaScript SDK for web and browser scenarios.

Get started

Application Insights SDK internally consumes Azure Monitor OpenTelemetry for JavaScript, all relevant documentation is available in that package repository, it also exposes previous functionalities and APIs that were previously available to have a smother transtion for customers using previous versions of the package, including manual track APIs, for new customers we recommend to use @azure/monitor-opentelemetry instead.

Prerequisites

Azure subscription: Create an Azure subscription for free
Application Insights resource: Create an Application Insights resource
Application using an officially supported version of Node.js runtime:
- OpenTelemetry supported runtimes
- Azure Monitor OpenTelemetry Exporter supported runtimes

Install the library

npm install applicationinsights@beta

Enable Application Insights

Important: useAzureMonitor must be called before you import anything else. There may be resulting telemetry loss if other libraries are imported first.

const { useAzureMonitor, ApplicationInsightsOptions } = require("applicationinsights");

const config : ApplicationInsightsOptions = {
    azureMonitorExporterConfig: {
        connectionString: process.env["APPLICATIONINSIGHTS_CONNECTION_STRING"] || "<your connection string>"
    }
};
useAzureMonitor(config);

If the Connection String is set in the environment variable APPLICATIONINSIGHTS_CONNECTION_STRING, TelemetryClient constructor can be called with no arguments. This makes it easy to use different connection strings for different environments.

Configuration

The ApplicationInsightsConfig object provides a number of options to setup SDK behavior.

const config : ApplicationInsightsOptions = {
     azureMonitorExporterConfig: {
        // Offline storage
        storageDirectory: "c://azureMonitor",
        // Automatic retries
        disableOfflineStorage: false,
        // Application Insights Connection String
        connectionString:   process.env["APPLICATIONINSIGHTS_CONNECTION_STRING"] || "<your connection string>",
    },
    samplingRatio: 1,
    enableAutoCollectExceptions: true,
    enableAutoCollectStandardMetrics: true,
    enableAutoCollectPerformance: true,
    instrumentationOptions: {
        azureSdk: { enabled: true },
        http: { enabled: true },
        mongoDb: { enabled: true },
        mySql: { enabled: true },
        postgreSql: { enabled: true },
        redis: { enabled: true },
        redis4: { enabled: true },
    },
    resource: resource,
    logInstrumentationOptions: {
        console: { enabled: true},
        bunyan: { enabled: true},
        winston: { enabled: true},
    },
    extendedMetrics:{
        gc: true,
        heap: true,
        loop: true
    }

};
useAzureMonitor(config);

Property	Description	Default
...	Azure Monitor OpenTelemetry Configuration More info here
enableAutoCollectExceptions	Sets the state of exception tracking. If true uncaught exceptions will be sent to Application Insights	true
logInstrumentationOptions	Allow configuration of Log Instrumentations.	{"console": { enabled: false },"bunyan": { enabled: false },"winston": { enabled: false }}
extendedMetrics	Enable/Disable specific extended Metrics(gc, heap and loop).	{"gc":false,"heap":false,"loop":false}

Configuration could be set using configuration file applicationinsights.json located under root folder of applicationinsights package installation folder, Ex: node_modules/applicationinsights. These configuration values will be applied to all ApplicationInsightsClients created in the SDK.

{
    "azureMonitorExporterConfig": {"connectionString":"<YOUR_CONNECTION_STRING>"},
    "samplingRatio": 0.8,
    "enableAutoCollectExceptions": true,
    "instrumentationOptions":{
        "azureSdk": {
            "enabled": false
        }
    },
    "logInstrumentationOptions":{
        "console": {
            "enabled": true
        }
    }
    ...
}

Custom JSON file could be provided using APPLICATIONINSIGHTS_CONFIGURATION_FILE environment variable.

process.env.APPLICATIONINSIGHTS_CONFIGURATION_FILE = "C:/applicationinsights/config/customConfig.json"

// Application Insights SDK setup....

Troubleshooting

Self-diagnostics

APPLICATIONINSIGHTS_INSTRUMENTATION_LOGGING_LEVEL environment varialbe could be used to set desired log level, supporting the following values: NONE, ERROR, WARN, INFO, DEBUG, VERBOSE and ALL.

Logs could be put into local file using APPLICATIONINSIGHTS_LOG_DESTINATION environment variable, supported values are file and file+console, a file named applicationinsights.log will be generated on tmp folder by default, including all logs, /tmp for *nix and USERDIR/AppData/Local/Temp for Windows. Log directory could be configured using APPLICATIONINSIGHTS_LOGDIR environment variable.

process.env.APPLICATIONINSIGHTS_INSTRUMENTATION_LOGGING_LEVEL = "VERBOSE";
process.env.APPLICATIONINSIGHTS_LOG_DESTINATION = "file";
process.env.APPLICATIONINSIGHTS_LOGDIR = "C:/applicationinsights/logs";

// Application Insights SDK setup....

Support

For help and questions about using this project, please create a Support request issue on https://github.com/microsoft/ApplicationInsights-node.js/issues.

For OpenTelemetry issues, contact the OpenTelemetry JavaScript community directly. Support Policy

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Data Collection

As this SDK is designed to enable applications to perform data collection which is sent to the Microsoft collection endpoints the following is required to identify our privacy statement.

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.

License

MIT

Current Tags

3.0.0-beta.12 ... beta (8 months ago)
3.2.0 ... latest (4 months ago)

148 Versions

3.2.0 ... 4 months ago
3.1.0 ... 6 months ago
3.0.1 ... 7 months ago
3.0.0 ... 7 months ago
3.0.0-beta.12 ... 8 months ago
2.9.5 ... 8 months ago
2.9.4 ... 9 months ago
2.9.3 ... 9 months ago
3.0.0-beta.11 ... 10 months ago
2.9.2 ... 10 months ago
2.9.1 ... a year ago
3.0.0-beta.10 ... a year ago
2.9.0 ... a year ago
2.8.0 ... a year ago
3.0.0-beta.9 ... a year ago
3.0.0-beta.8 ... a year ago
2.7.3 ... a year ago
2.7.2 ... a year ago
2.7.1 ... a year ago
3.0.0-beta.7 ... a year ago
3.0.0-beta.6 ... a year ago
2.7.0 ... a year ago
3.0.0-beta.5 ... 2 years ago
2.6.0 ... 2 years ago
3.0.0-beta.4 ... 2 years ago
2.5.1 ... 2 years ago
3.0.0-beta.3 ... 2 years ago
3.0.0-beta.2 ... 2 years ago
2.5.0 ... 2 years ago
3.0.0-beta.1 ... 2 years ago
2.4.2 ... 2 years ago
2.4.1 ... 2 years ago
2.4.0 ... 2 years ago
3.0.0-beta.0 ... 2 years ago
2.3.6 ... 2 years ago
2.3.5 ... 2 years ago
2.3.4 ... 2 years ago
2.3.3 ... 3 years ago
2.3.2 ... 3 years ago
2.3.1 ... 3 years ago
2.3.0 ... 3 years ago
2.2.2 [deprecated] ... 3 years ago
2.2.1 ... 3 years ago
2.2.0 ... 3 years ago
2.1.9 ... 3 years ago
2.1.8 ... 3 years ago
2.1.7 ... 3 years ago
2.1.6 ... 3 years ago
2.1.5 ... 3 years ago
2.1.4 ... 3 years ago
2.1.3 ... 3 years ago
2.1.2-beta.0 ... 3 years ago
2.1.2 ... 3 years ago
2.1.1 ... 3 years ago
2.1.0-beta.1 ... 3 years ago
2.1.0 ... 3 years ago
2.1.0-beta.0 ... 3 years ago
2.0.0 ... 4 years ago
1.8.10 ... 4 years ago
1.8.9 ... 4 years ago
2.0.0-beta.201103.0 ... 4 years ago
1.8.8 ... 4 years ago
2.0.0-beta.201004.0 ... 4 years ago
1.8.7 ... 4 years ago
1.8.6 ... 4 years ago
2.0.0-beta.200831.2 ... 4 years ago
2.0.0-beta.200831.1 ... 4 years ago
2.0.0-beta.200828.1 ... 4 years ago
1.8.5 ... 4 years ago
1.8.4 ... 4 years ago
1.8.3 ... 4 years ago
2.0.0-beta.200714.1 ... 4 years ago
2.0.0-beta.200713.1 ... 4 years ago
1.8.2 ... 4 years ago
1.8.1 ... 4 years ago
2.0.0-beta.200707.1 ... 4 years ago
1.8.0 ... 4 years ago
1.7.6 ... 4 years ago
1.7.5 ... 5 years ago
1.7.4 ... 5 years ago
1.7.3 ... 5 years ago
1.7.2 ... 5 years ago
1.7.1 ... 5 years ago
1.8.0-beta.1 ... 5 years ago
1.8.0-beta.0 ... 5 years ago
1.7.0 ... 5 years ago
1.6.0 ... 5 years ago
1.5.0 ... 5 years ago
1.4.2 ... 5 years ago
1.4.1 ... 5 years ago
1.4.0 ... 5 years ago
1.3.1 ... 6 years ago
1.3.0 ... 6 years ago
1.2.0 ... 6 years ago
1.1.0 ... 6 years ago
1.1.0-beta.0 ... 6 years ago
1.0.8 ... 6 years ago
1.0.7 ... 6 years ago
1.0.6 ... 6 years ago
1.0.5 ... 6 years ago
1.0.4 ... 6 years ago
1.0.3 ... 6 years ago
1.0.2 ... 7 years ago
1.0.1 ... 7 years ago
1.0.0 ... 7 years ago
0.22.0 ... 7 years ago
0.21.0 ... 7 years ago
0.20.1 ... 7 years ago
0.20.0 ... 8 years ago
0.19.0 ... 8 years ago
0.18.0 ... 8 years ago
0.17.2 ... 8 years ago
0.17.1 ... 8 years ago
0.17.0 ... 8 years ago
0.16.0 ... 8 years ago
0.15.19 ... 8 years ago
0.15.18 ... 8 years ago
0.15.17 ... 8 years ago
0.15.16 ... 9 years ago
0.15.15 ... 9 years ago
0.15.14 ... 9 years ago
0.15.13 ... 9 years ago
0.15.12 ... 9 years ago
0.15.11 ... 9 years ago
0.15.10 ... 9 years ago
0.15.8 ... 9 years ago
0.15.7 ... 9 years ago
0.15.6 ... 9 years ago
0.15.5 ... 9 years ago
0.15.4 ... 9 years ago
0.15.3 ... 9 years ago
0.15.2 ... 9 years ago
0.15.1-d ... 10 years ago
0.15.1-c ... 10 years ago
0.15.1-b ... 10 years ago
0.15.1-a ... 10 years ago
0.15.1 ... 10 years ago
0.15.0 ... 10 years ago
0.12.5 ... 10 years ago
0.12.4 ... 10 years ago
0.12.3 ... 10 years ago
0.12.2 ... 10 years ago
0.12.1 ... 10 years ago
0.12.0 ... 10 years ago
0.10.3 ... 10 years ago
0.10.2 ... 10 years ago
0.10.1 ... 10 years ago
0.10.0 ... 10 years ago