Skip to content

Files

Latest commit

 

History

History

tokumx

README.md

Agent Check: TokuMX

Overview

This integration is in maintenance mode. It can only work with Python 2. It is not included with the Agent newer than v7.37. Agent 6 bugfix releases will continue to include it.

This check collects TokuMX metrics, including:

  • Opcounters.
  • Replication lag.
  • Cache table utilization and storage size.

Setup

Installation

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

Configuration

Prepare TokuMX

  1. Install the Python MongoDB module on your MongoDB server using the following command:

    sudo pip install --upgrade "pymongo<3.0"

  2. You can verify that the module is installed using this command:

    python -c "import pymongo" 2>&1 | grep ImportError && \
echo -e "\033[0;31mpymongo python module - Missing\033[0m" || \
echo -e "\033[0;32mpymongo python module - OK\033[0m"

  3. Start the Mongo shell. In the shell, create a read-only user for the Datadog Agent in the admin database:

    # Authenticate as the admin user.
use admin
db.auth("admin", "<YOUR_TOKUMX_ADMIN_PASSWORD>")
# Add a user for Datadog Agent
db.addUser("datadog", "<UNIQUEPASSWORD>", true)

  4. Verify that you created the user with the following command (not in the Mongo shell).

    python -c 'from pymongo import Connection; print Connection().admin.authenticate("datadog", "<UNIQUEPASSWORD>")' | \
grep True && \
echo -e "\033[0;32mdatadog user - OK\033[0m" || \
echo -e "\033[0;31mdatadog user - Missing\033[0m"

For more details about creating and managing users in MongoDB, see the MongoDB Security documentation.

Host

To configure this check for an Agent running on a host:

  1. Edit the tokumx.d/conf.yaml file in the conf.d/ folder at the root of your Agent's configuration directory. See the sample tokumx.d/conf.yaml for all available configuration options:

    init_config:

instances:
  - server: "mongodb://<USER>:<PASSWORD>@localhost:27017"

  2. Restart the Agent to start sending TokuMX metrics to Datadog.

Containerized

For containerized environments, see the Autodiscovery Integration Templates for guidance on applying the parameters below.

Parameter Value
<INTEGRATION_NAME> tokumx
<INIT_CONFIG> blank or {}
<INSTANCE_CONFIG> {"server": "mongodb://<USER>:<PASSWORD>@%%host%%:27017"}

Validation

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

Data Collected

Metrics

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

Events

Replication state changes:

This check emits an event each time a TokuMX node has a change in its replication state.

Service Checks

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

Troubleshooting

Need help? Contact Datadog support.

Further Reading