Trianz Appdynamics Agent Documentation
Installation and Config Document
Appd Agents: Node.JS Agent
Ed Dr0.1 Appdynamics NodeJs agent deployment Trianz 1/13
Copyright © 2017 Trianz Pvt Ltd. All rights reserved.
Trianz Appdynamics Agent Documentation
Document Approval
Names of the persons approving this document for release.
Trianz Internal Approval
Role Architect
Name Jaya Krishna P
Role Senior Project Manager
Name Sathish KrishnaMurthy
Role
Name
Document History
The purpose of this section is to capture all changes made to the content of document
Edition Date Author Details of Change
Draft 0.1 22/03/20 M Sekhara Reddy Initial Draft prepared for Appd – Node.Js Agent
17
Table 1 – Document History
Ed Dr0.1 Appdynamics NodeJs agent deployment Trianz 2/13
Copyright © 2017 Trianz Pvt Ltd. All rights reserved.
Trianz Appdynamics Agent Documentation
Document Location
Location of document in the Trianz Trinet
Electronic Location
Table 2 – Document Location
Ed Dr0.1 Appdynamics NodeJs agent deployment Trianz 3/13
Copyright © 2017 Trianz Pvt Ltd. All rights reserved.
Trianz Appdynamics Agent Documentation
Table of Contents
1. Introduction.................................................................................................6
1.1 Purpose................................................................................................ 6
1.2 Scope.................................................................................................. 6
1.3 Referenced Documents.............................................................................6
1.4 Acronyms and Terms................................................................................6
1.5 Additional remarks and agreements..............................................................6
2. Appdynamics Agent Installation.........................................................................7
2.1 Node.js agent Installation & configuration steps...............................................7
2.1.1 Downloading Node.js agent.............................................................7
2.1.2 Installing and configuring nodejs agent...............................................7
2.1.3 Starting NodeJs Agent...................................................................9
3. Monitoring NodeJS dashboard && Metrics...........................................................10
3.1 Accessing MYSQL Dashboard......................................................................10
3.1.1 Login in Controller UI using your credentials and click on
applications, you can see below screen.............................................10
3.1.2 Click on Sekharnodejs from above screen, you will see below real
time dashboard showing Node JS various performance metrics as like
below.....................................................................................11
3.1.3 Metric Browser for Node Js............................................................12
3.1.3.1 Overall Application Monitoring KPI’s............................................................12
3.1.3.2 Node Js Platform/Core Metrics can be seen here.............................................12
4. Trobleshooting NodeJS Agent..........................................................................13
Ed Dr0.1 Appdynamics NodeJs agent deployment Trianz 4/13
Copyright © 2017 Trianz Pvt Ltd. All rights reserved.
Trianz Appdynamics Agent Documentation
Table of Tables
Table 1 – Document History................................................................................2
Table 2 – Document Location..............................................................................3
Table 3 – References Documents..........................................................................6
Table 4 – Acronyms and Terms............................................................................6
Ed Dr0.1 Appdynamics NodeJs agent deployment Trianz 5/13
Copyright © 2017 Trianz Pvt Ltd. All rights reserved.
Trianz Appdynamics Agent Documentation
1. Introduction
1.1 Purpose
The purpose of the document is to understand the steps involved to install & configure
appdynamics agents as part of client onboarding.
1.2 Scope
Appdynamics agents covered in this document –> Node.Js agent
1.3 Referenced Documents
Ref Document Number Document Title Version
Table 3 – References Documents
1.4 Acronyms and Terms
Specific acronyms and terms used in this document are listed below.
APP Appdynami
D cs
Table 4 – Acronyms and Terms
1.5 Additional remarks and agreements
Not Applicable.
Ed Dr0.1 Appdynamics NodeJs agent deployment Trianz 6/13
Copyright © 2017 Trianz Pvt Ltd. All rights reserved.
Trianz Appdynamics Agent Documentation
2. Appdynamics Agent Installation
2.1 Node.js agent Installation & configuration steps
2.1.1 Downloading Node.js agent
Go to this URL https://download.appdynamics.com/download/ by using client partnership
ID’s or get the node.js agent software from client repository
As you can see, there is no software that can be downloaded directly from appdynamics
website, instead nodejs will get installed during run time, by following below steps from
appdynamics link as below.
https://docs.appdynamics.com/display/PRO42/Install+the+Node.js+Agent
Note: Node.JS server should have internet access to download required appd libraries from
external repository of appdynamics
2.1.2 Installing and configuring nodejs agent
1. Login in Node js application installed server with write access priviliges and go to
node.js application home directory
2. To install the latest version you can run 'npm install appdynamics' for each application
you want to monitor, but we recommend matching the agent version to your
AppDynamics Controller version:
Command: npm install appdynamics@<version>
For example, if your AppDynamics controller version is 4.1.0, we recommend installing
the 4.1.0 Node.js Agent:
Ed Dr0.1 Appdynamics NodeJs agent deployment Trianz 7/13
Copyright © 2017 Trianz Pvt Ltd. All rights reserved.
Trianz Appdynamics Agent Documentation
3. To install the latest agent use: npm install appdynamics@next
Installation ScreenShot:
As you can see above, above command will get appdynamics node js agent required
libraries from internet and will get stored under node_modules directory in your
application
Important Steps, which requires application restart
4. Paste the following require statement in your application. Replace the variables with
the values for your setup. To find your account name and access key,
5. AppDynamics recommends that you insert the AppDynamics require statement as the
very first line of your application source code, before any other require statement. Or,
if your first line of code is a require statement of another script that contains the
require(“appdynamics”) call before any other require()s, that works too
require("appdynamics").profile({
controllerHostName: '<controller host name>',
controllerPort: <controller port number>,
controllerSslEnabled: false, // Set to true if
controllerPort is SSL
accountName: '<AppDynamics_account_name>',
accountAccessKey: '<AppDynamics_account_key>', //required
applicationName: 'your_app_name',
tierName: 'choose_a_tier_name',
nodeName: 'choose_a_node_name',
});
Note: You can get the account name and access key from Controller UI like shown in below
(click on fog icon or settings icon shown right upper corner side in UI)
Ed Dr0.1 Appdynamics NodeJs agent deployment Trianz 8/13
Copyright © 2017 Trianz Pvt Ltd. All rights reserved.
Trianz Appdynamics Agent Documentation
2.1.3 Starting NodeJs Agent
Note 1: There is no command to start Node JS agent/monitoring from appdynamics side
By Default when Node Js deployed application is restarted post above config, it will
automatically starts the node js proxy service/process part of appdynamics monitoring
libraries (it will get called from above cod e)
Post restart of Node Js deployed application, wait for 30/60 seconds and check the agent
staus in Controller UI as like below
You can see node js agent is registerd with appdynamics controller
Note 2: No need of any other configurations for nodejs monitoring configutration in Controller
UI, as we already specified Tier/Application details in Section 2.1.2
Ed Dr0.1 Appdynamics NodeJs agent deployment Trianz 9/13
Copyright © 2017 Trianz Pvt Ltd. All rights reserved.
Trianz Appdynamics Agent Documentation
3. Monitoring NodeJS dashboard && Metrics
Note: Please generate traffic by accessing Node Js application to see transactions statistics
in Appdynamics Dashboards
3.1 Accessing MYSQL Dashboard
3.1.1 Login in Controller UI using your credentials and click on applications, you
can see below screen
Befor Generating traffic
After Generating Traffic from Application
Ed Dr0.1 Appdynamics NodeJs agent deployment Trianz 10/13
Copyright © 2017 Trianz Pvt Ltd. All rights reserved.
Trianz Appdynamics Agent Documentation
3.1.2 Click on Sekharnodejs from above screen, you will see below real time
dashboard showing Node JS various performance metrics as like below
Main Dashboard
Business Transactions View
Remote Services View
Ed Dr0.1 Appdynamics NodeJs agent deployment Trianz 11/13
Copyright © 2017 Trianz Pvt Ltd. All rights reserved.
Trianz Appdynamics Agent Documentation
3.1.3 Metric Browser for Node Js
Click on Metric browsers shown at lefside bottom of the page, post that you can see below
Important Metrics for Node Js as like below
3.1.3.1 Overall Application Monitoring KPI’s
3.1.3.2 Node Js Platform/Core Metrics can be seen here
By using above Node Js and Application Metrics, Health Rules can be written to suit client
requirements
Ed Dr0.1 Appdynamics NodeJs agent deployment Trianz 12/13
Copyright © 2017 Trianz Pvt Ltd. All rights reserved.
Trianz Appdynamics Agent Documentation
4. Trobleshooting NodeJS Agent
Issue: If you don’t see any Business Transactions are not reported to Controller
UI/Dashboards eventhough your application is generating usage traffic
Solution: Check if appd proxy is running on Node Js server or not as like below
If proxy is stopped you can start it manualy by using below command
nohup /<application_root_dir>/node_modules/appdynamics-proxy/proxy/runProxy -j
/<application_root_dir>/node_modules/appdynamics-jre/jre –
/tmp/appd/proxy_ctrl_dir /tmp/appd/logs &
********************** END of the Document **************************************
Ed Dr0.1 Appdynamics NodeJs agent deployment Trianz 13/13
Copyright © 2017 Trianz Pvt Ltd. All rights reserved.
