Quickstart: Start monitoring your Node.js Web application with Azure Application Insights
This quickstart guides you through adding the version 0.22 Application Insights SDK for Node.js to an existing Node.js web application.
With Azure Application Insights, you can easily monitor your web application for availability, performance, and usage. You can also quickly identify and diagnose errors in your application without waiting for a user to report them. With the version 0.20 SDK release onward, you can monitor common third-party packages, including MongoDB, MySQL, and Redis.
To complete this quickstart:
- You need an Azure Subscription and an existing Node.js web application.
If you don't have a Node.js web application, you can create one by following the Create a Node.js web app quickstart.
If you don't have an Azure subscription, create a free account before you begin.
Sign in to the Azure portal
Sign in to the Azure portal.
Enable Application Insights
Application Insights can gather telemetry data from any internet-connected application, regardless of whether it's running on-premises or in the cloud. Use the following steps to start viewing this data.
Select Create a resource > Developer tools > Application Insights.
If this is your first time creating an Application Insights resource you can learn more by visiting the Create an Application Insights Resource doc.
A configuration page appears; use the following table to fill out the input fields.
Settings Value Description Name Globally Unique Value Name that identifies the app you are monitoring Resource Group myResourceGroup Name for the new resource group to host App Insights data. You can create a new resource group or use an existing one. Location East US Choose a location near you, or near where your app is hosted
Configure App Insights SDK
Select Overview and copy your application's Instrumentation Key.
Add the Application Insights SDK for Node.js to your application. From your app's root folder run:
npm install applicationinsights --save
Edit your app's first .js file and add the two lines below to the topmost part of your script. If you are using the Node.js quickstart app, you would modify the index.js file. Replace <instrumentation_key> with your application's instrumentation key.
const appInsights = require('applicationinsights'); appInsights.setup('<instrumentation_key>').start();
Restart your app.
It takes 3-5 minutes before data begins appearing in the portal. If this app is a low-traffic test app, keep in mind that most metrics are only captured when there are active requests or operations occurring.
Start monitoring in the Azure portal
You can now reopen the Application Insights Overview page in the Azure portal, where you retrieved your instrumentation key, to view details about your currently running application.
Select Application map for a visual layout of the dependency relationships between your application components. Each component shows KPIs such as load, performance, failures, and alerts.
Select the App Analytics icon View in Analytics. This opens Application Insights Analytics, which provides a rich query language for analyzing all data collected by Application Insights. In this case, a query is generated for you that renders the request count as a chart. You can write your own queries to analyze other data.
Return to the Overview page and examine the KPI graphs. This dashboard provides statistics about your application health, including the number of incoming requests, the duration of those requests, and any failures that occur.
To enable the Page View Load Time chart to populate with client-side telemetry data, add this script to each page that you want to track:
On the left, select Metrics. Use the metrics explorer to investigate the health and utilization of your resource. You can select Add new chart to create additional custom views or select Edit to modify the existing chart types, height, color palette, groupings, and metrics. For example, you can make a chart that displays the average browser page load time by selecting "Browser page load time" from the metrics drop down and "Avg" from aggregation. To learn more about Azure Metrics Explorer visit Getting started with Azure Metrics Explorer.
To learn more about monitoring Node.js, check out the additional App Insights Node.js documentation.
Clean up resources
When you are done testing, you can delete the resource group and all related resources. To do so follow the steps below.
If you used an existing resource group the instructions below will not work and you will need to just delete the individual Application Insights resource. Keep in mind anytime you delete a resource group all underyling resources that are members of that group will be deleted.
- From the left-hand menu in the Azure portal, select Resource groups and then select myResourceGroup.
- On your resource group page, select Delete, enter myResourceGroup in the text box, and then select Delete.