On-Host Installation

In on-host monitoring, the agent runs on the server it will monitor. In this configuration, the agent can inspect its host operating system to auto-detect and auto-configure any services that can be monitored (see our list of supported systems). Please note that Cassandra installation has an initial prerequisite step, described here.

This is the preferred configuration because it gives an opportunity to get as much data as possible about server performance and behavior. It allows process inspection, for example, as well as query monitoring via libpcap / WinPcap to interpret the database network protocol. Note that this currently supports unencrypted TCP traffic only; if you are using an encrypted connection (or any connection other than TCP), you will need to use the off-host installation method instead.

A step-by-step wizard will guide you through the process the first time you log into the application. If you would like to restart the installation wizard, or to add additional hosts in the future, you can do that from the Hosts List at any time. If you have any issues or questions during installation, do not hesitate to contact us by clicking the button in the lower right of your screen to talk to an engineer.

On the Inventory page, begin by opening the wizard, either by clicking “Setup your first host” if this is the first time you are adding a host, or “Add New Host” if it is not.

Once the wizard has opened, select “On-Host.”

The next page will give you two commands to run, as root, on the server you wish to monitor.

This will download the agent, which will then detect the services that can be monitored. Select the service you wish to monitor from the list which appears below and click “Set Credentials.”

Install Wizard

On the Set Credentials screen, enter the address and login information for the service you wish to monitor. This page will look slightly different depending on the kind of service (MySQL, PostgreSQL, etc.). During installation on Cassandra hosts, you will also enter the address of Jolokia, which needs to be downloaded and installed.

Install Wizard

This will be the login that VividCortex uses to connect. You can use either the environment’s default credentials, or set custom credentials if necessary. For more information about setting and configuring credentials, see here. Then select “Create User.”

For MySQL, PostgreSQL, and MongoDB, if you have not already created a user with the correct permissions for allowing VividCortex to monitor the database, you can do that now (note this step will not display for Cassandra and Redis). For more information on the privileges required for monitoring and the purpose each privilege serves, refer to our Privileges documentation.

Install Wizard

Then select “Check Agents.”

Install Wizard

After ensuring that the plugins have correctly checked-in, you can proceed to the last step and create additional users within your organization so that they will have access to VividCortex.

Cassandra setup

Cassandra requires the installation of Jolokia, used by our agent to capture Cassandra metrics via JMX. Download the JVM-Agent, and place the jar file under Cassandra’s installation “lib” subdirectory. Then append a javaagent option to the $JVM_OPTS variable in your cassandra-env.sh configuration file like follows:


Note the actual jar filename must match that from the version you have downloaded. You may want to restrict Jolokia’s access further by making it bind to localhost instead and/or require authentication, in which case you will need to adapt the arguments used with javaagent to match your setup. Finally, you will need to restart Cassandra for the changes to take effect.