Supported Systems

VividCortex supports 64-bit Linux and FreeBSD on x86 processors provided the platform meets the minimum requirements for Go. We also support containerized installation.

Versions of MySQL

VividCortex supports version 5.5 and above of MySQL, including MariaDB, Percona Server, and the most recent MySQL releases from Oracle. We also support Amazon RDS and Aurora for MySQL.

We cannot capture queries that are sent to the server by a Unix socket, shared memory, replication, or any methods other than by the TCP network. If your application connects to MySQL as localhost, it will probably use one of these non-supported connection protocols, and you should point it to a hostname or IP address instead. A simple fix is to use 127.0.0.1, which will make the MySQL client library connect via TCP instead of Unix socket.

We support Amazon RDS for MySQL by using an alternative method to capture queries. Instead of decoding the network protocol, we can capture performance statistics from the PERFORMANCE_SCHEMA tables, provided you’re using MySQL version 5.6.14 or newer. Note that the statements_digest consumer (table setup_consumers) needs to be enabled for this to work and, if you want samples to be captured, the events_statements_current and events_statements_history_long consumers have to be enabled as well. Note also that this approach is not exclusive to Amazon RDS. We can use it for any instance where decoding traffic is not an option, like off-host installations and TCP connections using SSL.

We also support Amazon Aurora for MySQL, and the same PERFORMANCE_SCHEMA instructions apply to Aurora instances as other Amazon RDS instances. In addition to supporting an Aurora instance as a MySQL replica (i.e. replicating from a traditional MySQL instance to Aurora), we also monitor the status of Aurora Replicas within an Aurora cluster. This currently includes the server ID of the primary, the number of replicas, and metrics on replica lag (average and max). When monitoring an Aurora cluster, you will need to install the agent and monitor each node as a separate instance, using the instance endpoints; do not use the general read/write endpoints.

Versions of PostgreSQL

VividCortex supports all commonly used, non-EOL versions of PostgreSQL. The oldest non-EOL version of PostgreSQL is currently 9.4.20. We also support Amazon RDS and Aurora for PostgreSQL.

We support both Citus and PgBouncer. To monitor PgBouncer, VividCortex must be installed using the local, on-host configuration.

W cannot capture queries sent on anything other than a TCP socket. Check your driver documentation for specific details on how to connect.

We support Amazon RDS and Aurora for PostgreSQL by using an alternative method to capture queries: we can take our metrics out of the pg_stat_statements view, provided the pg_stat_statements extension is installed and enabled.

Note that the pg_stat_statements approach is not exclusive to Amazon RDS. We can use it for any instance where decoding the database network protocol is not an option, like off-host installations and TCP connections using SSL.

Versions of Redis

VividCortex supports Redis versions 2.0.0 and above, although versions prior to 2.6.0 will not report their full set of parameters. The agent will work regardless, but we may miss some configuration changes for older servers. We do not support Redis Sentinel instances.

Versions of MongoDB

VividCortex supports all generally available non-EOL MongoDB versions. Currently, the oldest non-EOL version of MongoDB is 3.2. For more information on MongoDB versions from the official documentation, please visit https://www.mongodb.com/support-policy.

We capture data from the currentOp() command for versions which support it (3.2+).

Unsupported Systems

We do not support Darwin (macOS), Solaris, Windows, or other non-Linux/FreeBSD platforms.