Purpose
Cavisson Agent Installer is a robust software tool designed for deploying monitoring agents across diverse environments. It facilitates seamless integration into applications, servers, and networks, enabling comprehensive performance monitoring and diagnostics. With its adaptable configurations, Cavisson Agent Installer ensures efficient deployment and management of monitoring agents, enhancing overall system reliability and performance optimization efforts.
Included Agents
- Application Agent(s): Monitor PHP, Java, Python, NodeJS & Go based application performance and metrics.
- Machine Agent: Monitors system-level metrics such as CPU, memory, and disk usage.
Pre-Requisites
Before installing the Cavisson Agent Installer, ensure the following prerequisites are met for specific Agent installation:
Supported Operating System(s):
- Linux (64 bit)
- Ubuntu 20.04
- Ubuntu 16
- CentOS
- RHEL
Software Dependencies:
- Java : Minimum version required is Java 8.
- Node.js: Minimum version required is Node v12
- Python: Minimum version required is Python 3.6
- PHP: Ensure PHP is installed. Supported versions are 5.6, 5.4, 7.0, 7.1, 7.2, 7.3, 7.4, 8.0, and 8.1
- Permissions: Administrator or root privileges required for installing and configuring agents.
- Disk Space: Ensure at least 1 GB of disk space is available for the installation and operation of agents
Installation Steps
- Download the Installer:
Connect with your Customer Support representative to obtain the Cavisson Agent Installer package from the official Cavisson download page. Link: https://nde.cav-test.com/HUB/CavissonAgentInstaller.version#>.bin. Sample Agent Installer File Name: CavissonAgentInstaller.4.14.0.63.bin - Once you have received the link, use the wget command to download the file. For e.g:
wget https://nde.cav-test.com/HUB/CavissonAgentInstaller.4.14.0.63.bin
- Store the file on your machine and provide execute permission.
chmod +x CavissonAgentInstaller-x.x.x.xx.bin
- Execute the installer file. For e.g.
- Using long Arguments –> ./CavissonAgentInstaller.4.14.0.63.bin –basedir=/opt –user=cavisson –cavisson-server=10.10.30.100:443 –tier=Cavisson-NS_East –server=CC-NCMON –cavisson-server-protocol=WSS –gateway-server=10.10.30.100:443 –machine-agent
- Using Short Arguments–> ./CavissonAgentInstaller.4.14.0.63.bin -c 10.10.30.1000:443 -t Cavisson-NS_East -s CC-NCMON -m
- After successfully installing the required agent, the agent can be found in the following path: <$BASE_DIR>/cavisson/netdiagnostics/<agent-name> (e.g., /opt/cavisson/netdiagnostics/java, /opt/cavisson/netdiagnostics/php, etc.)
Note: For the Machine agent, the installation path is <$BASE_DIR>/cavisson/monitors/ (e.g., /opt/cavisson/monitors).
- To check the AgentInstallation log, go to the installation path where you downloaded the CavissonAgentInstaller, as shown in the snapshot below.
Install Machine Agent:
Example:
For installation of machine agent run the below command with appropriate parameters:
./CavissonAgentInstaller.4.14.0.63.bin –cavisson-server=”<hostname:port>” –tier=”enter_tier_name” –server=”enter_server_name” –cavisson-server-protocol=”WSS” –machine-agent
Example: ./CavissonAgentInstaller.4.14.0.63.bin –cavisson-server=10.10.30.100:443 –tier=Cavisson-NS_East –server=CC-NCMON –cavisson-server-protocol=WSS –gateway-server=10.10.30.100:443 –machine-agent
To check if the agent is installed successfully, run the command :
ps -ef | grep cmon.
The installation path for Machine Agent is <$BASE_DIR>/cavisson/monitors/ (e.g., /opt/cavisson/monitors).
Install Php Agent:
Example:
For installation of Php Agent run the below command with appropriate parameters:
./CavissonAgentInstaller.4.14.0.63.bin –cavisson-server=”10.10.30.100:443″ –tier=”Cavisson-NS_East” –server=”CC-NCMON” –gateway-server=”10.10.30.100:443″ –php-agent
The installation path for Php Agent is <$BASE_DIR>/cavisson/netdiagnostics/php
Note: For Go ,Python and Php agent installations, proxy is used, so in that cases, the proxy will be installed.
- Similarly, if you want to install other agents like Go, Nodejs, Application Agent(Java), or Python, proceed with the above installation procedure and install the required agent with the appropriate parameters.
- To know which parameters are used for each agent, refer to the Appendix section, where all the keywords associated with each agent are listed.
Note: To know more about the installer and various parameters, run the following command:
./CavissonAgentInstaller.4.14.0.63.bin –help
or
Appendix:
Keywords and Their Values:
Keywords | Default | Mandatory | Machine Agent | PHP Agent | Java Agent | Python Agent | NodeJS Agent |
–basedir | opt | No | Yes | Yes | Yes | Yes | Yes |
–user | cavisson | No | Yes | Yes | Yes | Yes | Yes |
–cavisson-server | Empty | Yes | Yes | Yes | Yes | Yes | Yes |
–node-app-dir | current working dir | No | No | No | No | No | Yes |
–tier | Empty | Yes | Yes | Yes | Yes | Yes | Yes |
–server | Empty | Yes | Yes | Yes | Yes | Yes | Yes |
–cavisson-server-protocol | WSS | No | Yes | Yes | Yes | Yes | Yes |
–gateway-server | <server:1111> | No | No | Yes | No | Yes | No |
proxyConType | 0 | No | No | Yes | No | Yes | No |
proxyMode | 1 | No (If using proxy) | No | Yes | No | Yes | No |
–heap-size | -Xms256m -Xmx256m | No | Yes | No | No | No | No |
–index-prefix | Empty | No | No | No | No | No | No |
–log-server | <ServerHost:Port> | Yes | No | No | No | No | No |
–setup-name | Empty | No | No | No | No | No | No |
–nf-endpoint-prefix | netforest | No | No | No | No | No | No |
–endpointprefix | Collector | No | No | No | Yes | No | No |
–nd-endpoint-prefix | collector | No | Yes | No | No | No | No |
–python-version | python3 | No | No | No | No | Yes | No |
maxUDPProcesses | 5 (If using Proxy) | No | No | No | No | No | No |
Uninstallation Steps:
The uninstall.sh script is designed to remove the Cavisson Machine Agent , Java , python, php, proxy, go and NodeJs agents from the system. The script will check for required permissions, stop relevant processes, and delete associated files and directories.
Running the Uninstallation Script
To execute the uninstall.sh script, navigate to the BASE_DIR/cavisson directory (eg.,default BASE_DIR path is /opt) and run the following command:
./uninstall.sh
Script Execution Flow
- The script first verifies if the user has root privileges. If the user has a root
privileges, the uninstallation process will proceed.
- The script prompts the user to confirm if they want to uninstall the Agent and clear all associated changes.
- If the user presses y, the script stops the process, removes the agent directories and files, and completes the uninstallation of the specific agent. If the user presses n, the script aborts the uninstallation process.