Installing VividCortex

VividCortex is safe, fast, and easy to install. We encourage you to download the Quick Installation Guide, which will get you up and running in a few minutes. Complete installation instructions can be found on the pages below.

There are four installation scenarios. Whenever possible, we recommend the on-host installation method.

  • In on-host installation, the agent is installed and runs on the server it will monitor. The agent will automatically detect and configure any services that can be monitored. We recommend this option for MySQL and PostgreSQL and it is the required installation option for MongoDB and Redis.

  • In off-host installation, the agent is installed on any compatible host, and connects to the monitored host over the network to monitor it. Use this option if you are unable to install the agent to the server, such as with Amazon RDS, Amazon Aurora, or for MySQL and PostgreSQL when necessary (for example, when database traffic is encrypted with SSL).

  • In containerized installation, the agent is configured to run in a virtualization environment such as those provided by Heroku. This is similar to the off-host method however it carries some important particularities.

  • Lastly, you can install VividCortex manually or using systems such as Ansible, Chef, or Puppet.

Starting and Stopping VividCortex

Once installed, agents can be stopped, started, and restarted from the Agents Dashboard. Simply click the ‘gear’ icon on the right side of the screen and select an option. Note that if you stop the supervisor from the Agents Dashboard, you will need to restart the service locally.

To start and stop the service locally, you can use service vividcortex stop, start, and restart, or you may also use /etc/init.d/vividcortex stop, start, and restart, if appropriate.

Uninstalling: Linux and FreeBSD

To uninstall the VividCortex agents from a server, run the following commands as root:

curl https://download.vividcortex.com/install > install
sh install --uninstall

This will stop sending metrics from that host. That host will disappear from the interface and release its license after two hours. If you need to uninstall VividCortex and free a license immediately, you can have the uninstall process delete the host automatically. To do so, run the following commands as root:

curl https://download.vividcortex.com/install > install
sh install --delete

Warning: using the delete option will immediately and permanently delete the host. This is useful if you automate the provisioning of servers and installation of VividCortex and need to release licenses quickly without having to delete the host manually in the interface.

Uninstalling: Windows

Proceed as you would with any other Windows program: Control Panel -> Programs And Features -> select VividCortex and click Uninstall.