Purpose

This document provides pre-requisites and SOPs for installing Cavisson agents (Machine Agent, APMs, and Log Agent) for PHP & Java programming framework using Cavisson Agent Installer.

Prerequisites

1. Need to run by the root user.
2. Installation of PHP 5.4 or later and any Server (Apache/Nginx) on the machine.
3. Storage requirement – 1 GB.

Supported Platforms

It can run on below Linux environments:

• Ubuntu
• Fedora
• OpenSuse
• Redhat Enterprise
• Suse Enterprise
• CentOS
• CoreOS
• Amazon Linux
• Alpine Linux
• Oracle Linux
• php(proxy)
• NodeJS
• Go
• Python
• Machine agent
• Log agent

Installation Steps

1. Download the Cavisson Agent Installer from the Build Hub.

       Path: http://Public-IP/others/AGENTS-INSTALLER
       Sample Installer file name: CavissonAgentInstaller-4.5.0.93.bin

2. Store the file on your machine and provide execute permission.

       chmod +x CavissonAgentInstaller-x.x.x.xx.bin

3. Execute the installer file.

Usage

Case1: All Agents with default values

./CavissonAgentsInstaller<x.y.z.build_number>.bin –cavisson-server=”Provide Cavisson server <hostname:443>” –tier=”Provide Tier name” –index-prefix=”Provide Index Prefix” –setup-name=”Provide Setup-name” –gateway-server=”Provide Gateway Server(Required for PHP Agent) <Gateway Server:port>”

Case2: Application and Machine Agents only

./CavissonAgentsInstaller<x.y.z.build_number>.bin –cavisson-server=”Provide Cavisson server <hostname:443>” –tier=”Provide Tier name” –gateway-server=”Provide Gateway Server(Required for PHP Agent) <Gateway Server:port>” –no-log-agent

./CavissonAgentsInstaller<x.y.z.build_number>.bin –cavisson-server=”Provide Cavisson server <hostname:port>” –tier=”Provide Tier name” –log-server=”Provide Log Server <hostname:443>” –index-prefix=”Provide Index Prefix” –setup-name=”Provide Setup-name” –gateway-server=”Provide Gateway Server(Required for PHP Agent) <Gateway Server:port>”

Installation with All arguments

./CavissonAgentsInstaller<x.y.z.build_number>.bin –basedir=”Provide Basedir-Default: /opt” –user=”Provide user account-Default: cavisson” –cavisson-server=”Provide Cavisson server <hostname:443>” –tier=”Provide Tier name-Default: Default” –server=”Provide Server Name-Default: Hostname” –log-server=”Provide Log Server <hostname:443>” –index-prefix=”Provide Index Prefix” –setup-name=”Provide Setup-name like Prod” –cavisson-server-protocol=”Provide Protocol-Default: wss” –gateway-server=”Provide Gateway Server(Required for PHP Agent) <Gateway Server:port>” –verbose=”Provide verbose option-Default: true” –heap-size=”Default is 256MB.(eg:-Xms256m -Xmx512m)”

Notes: All parameters are optional and if not provided on the command line are picked from the bundled configuration file in binary. The default values in the configuration file provided in table “Keywords and their Values” in Appendix 1.

Installation only with python agent

bash CavissonAgentInstaller-Jdk-x.y.z.build.bin –basedir=”/opt” –user=” Provide user account-Default: cavisson ” –cavisson-server=”hostname:443″ –tier=” Provide Tier name-Default: Default ” –server=” Provide Server Name-Default: Hostname ” –cavisson-server-protocol=”TCP” –verbose=”true” –no-machine-agent –no-log-agent –no-nodejs-agent –no-php-agent –no-java-agent –no-go-agent

Execute installer as below to view help section

./CavissonAgentsInstaller.bin –-help

root@ubuntu:/home/cavisson/work# bash CavissonAgentInstaller-4.5.0.102.bin –help

10:09:58 Info: Distribution: Ubuntu 16.04

PLEASE EXECUTE THIS SHELL FROM “ROOT” USER

1. Use this installer to install/upgrade Cavisson Agent modules like Machine Agent Module, Application Agent Modules.

 

2. Options

[-b|–basedir] : Installation base dir eg: /home or /opt (default is /opt).

[-t|–tier] : Name to be given to a cluster of application servers running same application services

[-c|–cavisson-server]: Cavisson Server to which Application and Machine agents will be posting the captured data. Input format is <hostname:port>

3. Advanced Options

[-u|–user]: User account to be used to start Cavisson Agent services. If this account doesn’t exist, installer will create this account. Default is cavisson.

[-s|–server]: Application server name. Default value will be the hostname of the server.

[-p|–cavisson-server-protocol]: Default is WSS(Web Secure Socket).Possible values WSS,WS,TCP.

[-x|–heap-size] : Default is 256MB. (eg:-Xms256m -Xmx256m)  User can customize it from /BASE_DIR/cavisson/monitors/sys/cmon.env

[-d|–endpointprefix]: EndPointPrefix to be given in ndsetting.conf (default is Collector)

[-f|–nd-endpoint-prefix]: ND_ENDPOINT_PREFIX to be given in cmon.env (default is collector)
[-T|–tags]: TAGS name to be given in ndsetting.conf file.

[-A|–attributes]: ATTRIBUTES name to be given in ndsetting.conf file.

4. Log Agent Module Configurations

[-i|–index-prefix]: Prefix string that will be prefixed to all log indices managed by Log server

[-o|–log-server]: Centralized log server to which application logs will be sent in <hostname:port> format.

[-e|–setup-name]: Setup-name

[-n|–nf-endpoint-prefix]: NF_ENDPOINT_PREFIX to be given in nf.env (default value is netforest)

5. PHP Agent Module Configuration

[-y|–gateway-server] : Gateway Server <Gateway Server:port>

6. Use the below options to omit/exclude any of the Agent installation

[-m|–no-machine-agent]: for Machine Agent

[-a|–no-java-agent]: for Application Agent(Java)

[-l|–no-log-agent]: for Log Agent

[-w|–no-php-agent]: for Application Agent(PHP)

[-j|–no-python-agent]: for Python Agent

[-z|–no-nodejs-agent]: for NodeJS Agent

[-g|–no-gateway]: for Gateway

7. Python Agent Module Configuration

• [-k|–python-version]: Python version (default is python3)
•  

NOTE:

[uninstall.sh]: Uninstall.sh is created in “BASE_DIR”(given by user). This file can be used to uninstall the deployed Agent Modules.

Syntax for long arguments

Eg:-./CavissonAgentsInstaller<x.y.z.build_number>.bin –basedir=”/opt” –user=”cavisson” –cavisson-server=” Provide Cavisson server <hostname:443>” –tier=” Provide Tier name-Default: Default” –server=” Provide Server Name-Default: Hostname” –index-prefix=” Provide Index Prefix ” –log-server=“Provide Log Server <hostname:443>” –setup-name=” Provide Setup-name like Prod” –cavisson-server-protocol=” Provide Protocol-Default: wss ” –gateway-server=” Provide Gateway Server(Required for PHP Agent) <Gateway Server:port>“-Xms256m -Xmx256m” –nf-endpoint-prefix=”netforest” –endpointprefix=”Collector” –nd-endpoint-prefix=”collector” –verbose= “ Provide verbose option-Default: true“key=inline:value:value1, key1=env:NDHOME:value2,key2=nds:proxyMode: value3 “attributes= “key=inline:value:value1, key1=env:LD_LIBRARY_PATH:value2, key2=nds:instance:value3″”

Syntax for short-hand arguments

Eg:-./CavissonAgentInstaller-<x.y.z.build_number>.bin -b”/ Provide Basedir-Default:” -u” Provide Cavisson server <hostname:443>” -c” Provide Cavisson server <hostname:443>” -t” Provide Tier name-Default: Default ” -s” Provide Server Name-Default: Hostname ” -i” Provide Index Prefix ” -o” Provide Log Server <hostname:443>” -e” Provide Setup-name like Prod ” -p” Provide Protocol-Default: wss” -y” Provide Gateway Server(Required for PHP Agent) <Gateway Server:port>” -x” Default is 256MB.(eg:-Xms256m -Xmx512m ” -n”netforest” -d”Collector” -f”collector” -v” Provide verbose option-Default: true ” -T”key=inline:value:value1,key1=env:NDHOME:value2,

key2=nds:proxyMode:value3″ –

A”key=inline:value:value1,key1=env:LD_LIBRARY_

PATH:value2,key2=nds:instance:value3\

Verification of Installation

Once you execute the installer, you can see the messages that show that agents are successfully installed.