Containerized Installation

It is possible to run the VividCortex agent in a virtualization environment. This method can be used to monitor databases locally (“on-host”) and remotely (“off-host,” such as for Amazon RDS and Aurora). We have provided buildpacks that will set up agents for Docker and Heroku.

For Docker, you can find instructions and the necessary files here.

For Heroku, you can find instructions in the readme of the buildpack repo, located here. To uninstall VividCortex Buildpack from Heroku see Removing Heroku buildpack.

Generic Container Installation

Set the following environment variables in your container:

Variable Name Description
VC_API_TOKEN The VividCortex API token for your environment. You can find this by clicking the “Add New Host” wizard in the VividCortex web application and select “Containerized.”
VC_DRV_MANUAL_HOST_URI URI of the database you wish to monitor. The acceptable syntax is below this table.
VC_HOSTNAME The name of this container host. This is optional, but providing a human-readable name is highly recommended. Read more about that here
VC_DRV_MANUAL_QUERY_CAPTURE Set to poll if you are monitoring a host outside of the container, such as at Amazon RDS. Set to sniff if your database server will be installed inside the container and you want to monitor traffic via TCP sniffing.

VC_DRV_MANUAL_HOST_URI is a comma-separated list of database URIs. The formats are as follows:

Database URI syntax
MongoDB mongo://user:pass@
MySQL mysql://user:pass@
PostgreSQL postgres://user:pass@
Redis redis://:pass@

Replace user, pass, and port with the VividCortex username, the password for that user, and the database listening port. The user and password cannot contain any of the URI reserved characters ( : / ? # [ ] @ ).

If you are monitoring a remote database, such as Amazon RDS or Aurora, replace with the database address. For PostgreSQL, you may also need to specify the name of the database to connect to, db.

Please contact Support by emailing or by using the in-app chat if you have any questions.