Agent Installation for Windows
- JRE version should be 1.7 or later. JRE version 1.8 is recommended. JRE should be available in system registry.
- If JRE version is 32 bit, then CMON MSI should be 32 bit.
- If JRE version is 64 bit, then CMON MSI should be 64 bit.
- CMON-ND Agent should be installed with admin privileges.
Configure Service Account for CMON
When CMON is installed, CavMonAgent service is installed on the windows server as “Local System” by default. In this case, all access rights, which are applicable for “Local System” are granted. If user wants to run CavMonAgent with specific user account, then that account should be specified in “Log on as service” policy. Following are the steps to grant “Log on as service” rights to an account on windows servers:
- To open Local Security Policy, go to Control Panel > Administrative Tools, and then double-click Local Security Policy.
- In the console tree, double-click Local Policies, and then, click User Rights Assignment.
- In the details pane, double-click Log on as a service.
- Click Add User or Group, and then add the appropriate account to the list of accounts that possess the Log on as a service right.
Follow the below mentioned steps for installing CMON-ND for windows server:
Step – 1: Get CMON-ND MSI from Cavisson Systems Inc.
User needs to get the CMON-ND MSI file from Cavisson Systems Inc. to install it on the windows server.
|There is no need to change any environment variable for java. It automatically gets the latest java version from system registry. If java version is of 64 bit, then use MSI of 64 bit and if java version is of 32 bit, then use MSI of 32 bit.|
CMON-ND MSI must be installed with admin user privileges, so that monitors can be applied easily on application deployed on server.
Step – 2: Execute CMON-ND MSI
Double-click on the CMON-ND MSI file. The CMON-ND Agents Setup Wizard is displayed. Click the Next button.
Step – 3: Accept the License Agreement
Accept the License Agreement by selecting the I accept the terms in the License Agreement check box. Click the Next button.
Step – 4: Setup the Destination Folder
Specify the destination folder where CMON-ND agents need to be installed. To install CMON-ND agents at the default location (i.e. C:\Program Files (x86)\opt\), simply click the Next button. To install them on any other location, first click the Change button, browse the location for installation, and then click the Next button.
Step – 5: Setup the Account Service for CavMonAgent
Provide account details to run CavMonAgent with specific service account. By default, it is log on as “LocalSystem”.
- Account Name (domain\user)
|User needs to enter correct account details, because account details are NOT validated in installation.|
Step – 6: Auto Registration of CMON-ND Agents (Optional)
To perform auto registration of CMON-ND agents, provide the following details:
- Controller Host/IP:Port
- Tier Name
- Server Host/IP
- Instance Name (Only for NetDiagnostics)
|For more details, refer Auto Registration of CMON-ND Agents section.|
Step – 7: Initiate the Installation Process
Click the Install button to initiate the CMON-ND agents’ installation process.
Step – 8: Finish the Installation Process
Click the Finish button to finish the installation process and exit from the setup wizard. The CMON-ND agents get installed at the specified location.
Silent Installation and Un-installation
Installation of CMON-ND can be done from command line also. To do this, follow the below mentioned steps:
Step – 1: Open Command prompt as Administrator
Step – 2: Use ‘msiexec’ tool for silent installation
- To install CMON, use /package or /i
Syntax: msiexec /package <cmon-nd msi> Example: msiexec /package G:\setup\cmon-nd.msi
- To quiet the display option, use /quiet or /qn
Syntax: msiexec /package <cmon-nd msi> /qn Example: msiexec /package G:\setup\cmon-nd.msi /qn
- For un-installation, use /uninstall or /x
Syntax: msiexec /uninstall <cmon-nd msi> Example: msiexec /uninstall G:\setup\cmon-nd.msi
For CavMonAgent run as service account, following parameters are used:
|Parameter Name||Parameter Value||Description|
|ACCOUNT||<domain\user name>||To run CavMonAgent as service, use this parameter. In this parameter, user needs to provide windows server domain\username.|
|PASSWORD||<Password>||This parameter is required if user has given account name.|
|Service Account details should be correct. Installer does not validate the details. If user has provided incorrect details, CavMonAgent service is NOT installed on windows server.|
Syntax: msiexec.exe /package <cmon-nd msi> /qn ACCOUNT=<domain\username> PASSWORD=<password>
Example: msiexec.exe /i “C:\Users\compass-56\Downloads\cmon-nd.x220.127.116.11.58 .msi” /qn ACCOUNT=compass-56-PC\compass-56 PASSWORD=*****
For auto registration, user can provide command line parameters as following:
|Parameter Name||Parameter Value||Description|
|INSTALLDIR||<Absolute Directory Path>||This is used to change installation directory path|
|CONTROLLER||<Controller Host: PORT>||Provide ND Controller Host and Port for auto registration|
|TIER||<TIER Name>||Used to provide Tier Name|
|SERVER||<Windows Server Host/IP>||From this parameter, user can register windows server host/IP (with NDE) for auto registration|
|INSTANCE||<Instance>||This parameter is for NDE. Here, user provides instance name of the application where ND Agent is plugged|
Syntax : msiexec /package <cmon-nd msi> /qn INSTALLDIR=<Installation Directory Path> CONTROLLER=<Controller Host:Port> TIER:<Tier Name> SERVER=<Server IP/Host> INSTANCE=<Instance Name>
Example : msiexec /package G:\setup\cmon.msi INSTALLDIR=C:\home CONTROLLER=10.10.60.11:7895 TIER=WEBSTORE SERVER=10.10.30.65 INSTANCE=USER_APP_INSTANCE
Checking CMON-ND Installation
Follow the below mentioned steps to check that CMON-ND is successfully installed or not.
Step – 1: Go to Programs and Features
To check that CMON-ND agents is installed, go to Programs and Features.
Step – 2: Go to Task Manager
To check the CavMonAgent service is running, open the Task Manager by pressing CTRL + ALT + DEL keys.
Step – 3: Go to Services tab and check ‘CavMonAgent’
To check that CMON is successfully installed or not, search for CavMonAgent service. If it is there in the services list, it means it is successfully installed. If it is not, it means it is not installed. In this case, retry with the installation process.
Step – 4: Validate NetDiagnostics Installation
After installation is completed, please follow the below steps to validate ND is installed correctly.
- Go to C: Program Files(x86), check opt directory is present.
- Inside opt\cavisson directory, netdiagnostics directory should be present.
- Inside netdiagnostics directory, following directories are displayed.
Description of each directory is as follows:
- logs: A directory which contains all log files after the agent starts with application instance.
- lib: A directory containing all essential jars for ndAgent.
- etc: A directory containing version file, which is actual build information of ndAgent at appServer.
- config: A directory containing all entry point files if needed to be configured at server side.
- samples: A directory containing all config files (inside the config directory) for sample.
- schema: Containing a schema file for all instrumentation profile validations.
- thirdparty: A directory containing thirdparty jars (optional).
Start/Stop of CMON Service
User can start/stop/restart CMON service from DOS prompt or from control panel.
Starting of CMON Service
Start CavMonAgent from command line using following command:
net start CavMonAgent
Stopping of CMON Service
Stop CavMonAgent from command line using following command:
net stop CavMonAgent
Start/Stop CavMonAgent from GUI
- Open Services.
- Select CavMonAgentServices.
- Click On Start/Stop CavMonAgent Services as:
4. After selecting, click on start/stop.
Auto Registration of CMON-ND Agents
This is an optional feature, only in the case where NetDiagnostics Auto scaling capabilities need to be enabled.
The NetDiagnostics has a provision of auto scaling by which it can detect and start monitoring of any new instance or a server. However, if auto-scaling is disabled then NetDiagnostics is not be able to automatically detect and monitor the newly added server.
For NetDiagnostics to automatically monitor the newly added server, the auto registration of the agents is needed, where we provide the information of the tier, server, NetDiagnostics IP address as well as the NetDiagnostics port to the CMON agent. This is referred to as auto registration of agent.
To auto register new server, and to enable auto scaling, user needs to define certain configuration details in the following file:
C:\Program Files (x86)\opt\cavisson\monitors\sys\cmon.env
- NDE Controller Address (Host and Port): User can configure NDE Controller as following:
- Tier Name: At the time of enabling of auto-scale feature, user needs to define tier name. It is an optional field. Upon defining the tier name, the newly added server becomes the part of this tier. If the tier name is not defined, then the server becomes the part of default tier.
- Server: At the time of enabling of auto-scale feature, user needs to define server name. This server is registered with the specified tier. It is an optional field.
- Instance: At the time of enabling of auto-scale feature, user needs to define instance name of the application where ndAgent is plugged in. This instance is registered with the specified server. It is an optional field.
#NDE Controller Host and Port - Mandatory CONTROLLER=10.10.40.13:7890
#Tier and Server – Optional TIER=WebStore SERVER=<ip address or host name of server>
CMON Directory Structure
Following directories are created when the CavMonAgent package is installed in the following directory:
C:\Program Files (x86)\opt\cavisson\monitors
- lib: Contains essential library files and jars required by CavMonAgent.
- bin: Contains latest CavMon binaries and monitor programs/class files.
- logs: Contains log files created by CavMonAgent and other monitor programs.
- conf: Contains configuration information for running CavMon on windows based system.
- thirdparty: Contains third party tools and programs.
- etc: Contains version information.
- sys: env file (this is created by user, for setting environments specific to user).