Agent Check: VoltDB

Overview

This check monitors VoltDB through the Datadog Agent.

Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

Note: This check should only be configured on one Agent per cluster. If you are monitoring a cluster spread across several hosts, install an Agent on each host. However, do not enable the VoltDB integration on more than one host, as this results in duplicate metrics.

Installation

The VoltDB check is included in the Datadog Agent package. No additional installation is needed on your server.

Configuration

1. Add a datadog-agent user. You can do so by editing your VoltDB deployment.xml file. Note: No specific roles are required, so assign the built-in user role.

   <users>
       <!-- ... -->
       <user name="datadog-agent" password="<PASSWORD>" roles="user" />
   </users>

2. Edit the voltdb.d/conf.yaml file, in the conf.d/ folder at the root of your Agent's configuration directory to start collecting your VoltDB performance data. See the sample voltdb.d/conf.yaml for all available configuration options.

   init_config:
   
   instances:
     - url: http://localhost:8080
       username: datadog-agent
       password: "<PASSWORD>"

3. Restart the Agent.

TLS support

If TLS/SSL is enabled on the client HTTP port:

1. Export your certificate CA file in PEM format:

   keytool -exportcert -file /path/to/voltdb-ca.pem -keystore <KEYSTORE> -storepass <PASSWORD> -alias voltdb -rfc

2. Export your certificate in PEM format:

   openssl pkcs12 -nodes -in <KEYSTORE> -out /path/to/voltdb.pem -password pass:<PASSWORD>

   The resulting file should contain the unencrypted private key and the certificate:

   -----BEGIN PRIVATE KEY-----
   <Private key contents...>
   -----END PRIVATE KEY-----
   -----BEGIN CERTIFICATE-----
   <Certificate contents...>
   -----END CERTIFICATE-----
   

3. In your instance configuration, point url to the TLS-enabled client endpoint, and set the tls_cert and tls_ca_cert options. For example:

   instances:
   - # ...
     url: https://localhost:8443
     tls_cert: /path/to/voltdb.pem
     tls_ca_cert: /path/to/voltdb-ca.pem

4. Restart the Agent.

Log collection

1. Collecting logs is disabled by default in the Datadog Agent, enable it in your datadog.yaml file:

   logs_enabled: true

2. Add this configuration block to your voltdb.d/conf.yaml file to start collecting your VoltDB logs:

   logs:
     - type: file
       path: /var/log/voltdb.log
       source: voltdb

Change the path value based on your environment. See the sample voltdb.d/conf.yaml file for all available configuration options.

3. Restart the Agent.

To enable logs for Kubernetes environments, see Kubernetes Log Collection.

Validation

Run the Agent's status subcommand and look for voltdb under the Checks section.

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this check.

Events

This check does not include any events.

Service Checks

See service_checks.json for a list of service checks provided by this integration.

Troubleshooting

Need help? Contact Datadog support.

Further Reading

{{< partial name="whats-next/whats-next.html" >}}