VividCortex Agent Plugins

Here’s a quick overview of each VividCortex plugin’s functionality. For information on the the actual configuration settings available please refer to the general configuration and configuration flags pages.

vc-agent-007

This plugin gathers basic identifying information about the host operating system and database server (MySQL, PostgreSQL…), and registers them with VividCortex’s API, so the agent can refer to a host ID when sending metrics. It installs, upgrades, starts, stops, and supervises the plugins.

vc-aggregator

This is an aggregator/gateway similar to StatsD. It listens for UDP packets with time-series metrics and sends them to VividCortex’s APIs periodically.

vc-cstar-metrics

This Cassandra monitoring plugin captures Cassandra metrics via JMX, using Jolokia.

vc-cstar-query

This Cassandra monitoring plugin decodes network traffic and sends metrics about requests to Cassandra nodes to vc-aggregator. Queries are digested but this plugin will occasionally capture samples as well, although you can disable this feature if required. This plugin is a completely passive observer.

vc-mongo-metrics

This MongoDB monitoring plugin primarily watches serverStatus() once per second, capturing metrics that will later display as charts in our interface. It detects server restarts, that are reported as events in VividCortex. It will run buildInfo() as well upon startup, or every time the server is restarted.

vc-mongo-query

This MongoDB monitoring plugin decodes network traffic and sends metrics about requests to MongoDB to vc-aggregator. Query shapes are captured, but this plugin will occasionally capture samples as well, although you can disable this feature if required. This plugin is a completely passive observer.

vc-mysql-metrics

This MySQL monitoring plugin primarily watches SHOW STATUS once per second. It also captures data about replication delay and server configuration changes. It runs some commands occasionally, such as SHOW PROCESSLIST (during a fault, it runs these commands more frequently). It’s also able to capture queries out of MySQL’s PERFORMANCE_SCHEMA, thus reading query metrics even if the setup doesn’t allow us to decode the MySQL network protocol (see vc-mysql-query).

vc-mysql-query

This MySQL monitoring plugin decodes the database network protocol and sends metrics about query behavior to vc-aggregator. The metric names are created with a checksum, so no sensitive information is revealed. This plugin does NOT connect to or interact with MySQL in any way. It is a completely passive observer.

vc-pgsql-metrics

This PostgreSQL monitoring plugin primarily watches status and metric views once per second. It’s also able to capture queries out of PostgreSQL’s pg_stat_statements, provided the extension is available. This makes up for query metrics in situations where decoding the PostgreSQL network protocol is not possible (see vc-pgsql-query), like for Amazon RDS instances.

vc-pgsql-query

This PostgreSQL monitoring plugin decodes network traffic and sends metrics about query behavior to vc-aggregator. The metric names are created with a checksum, so no sensitive information is revealed. This plugin does NOT connect to or interact with PostgreSQL in any way. It is a completely passive observer.

vc-redis-metrics

This Redis monitoring plugin primarily runs the INFO command once a second. It also detects server configuration changes and faults.

vc-redis-query

This Redis monitoring plugin decodes network traffic and sends metrics about requests to Redis to vc-aggregator.

vc-os-metrics

This agent plugin from the /proc filesystem and sends time-series metrics such as disk, CPU, memory, and network stats to vc-aggregator.