Skip to main content

Aiven for OpenSearch® metrics sent to Datadog

Send Aiven for OpenSearch® metrics to Datadog, and choose which metric categories the integration collects.

Prerequisites​

  • A running Aiven for OpenSearch® service on a paid plan. Service integrations, including Datadog, aren't available on free tier services.
  • A Datadog account
  • A Datadog API key
  • A Datadog Metrics integration enabled for your service

Metrics sent to Datadog​

When you enable the Datadog Metrics integration for your Aiven for OpenSearch service, Aiven runs Datadog's Elasticsearch integration check against your service. The check always collects node-level and cluster health metrics.

Four additional metric categories are off by default. You enable each one independently through the opensearch configuration on the Datadog integration.

CategoryConfiguration parameterWhat it collects
Cluster monitoringcluster_stats_enabledCluster-wide disk usage metrics
Index monitoringindex_stats_enabledPer-index metrics, such as document counts and store size
Pending task monitoringpending_task_stats_enabledMetrics for tasks waiting in the cluster task queue
Primary shard monitoringpshard_stats_enabledPrimary shard and index count metrics

For the full list of metrics in each category, see Metrics in the Datadog Elasticsearch integration documentation.

Enable a metric category​

Enable metric categories through the Datadog integration for your Aiven for OpenSearch service.

  1. Find the ID of the Datadog Metrics integration for your service by running the avn service integration-list command:

    avn service integration-list --project PROJECT_NAME SERVICE_NAME

    Use the service_integration_id value from the output as INTEGRATION_ID in the following commands.

  2. Set the categories to collect to true. This example enables all four categories:

    avn service integration-update --project PROJECT_NAME \
       --user-config-json '{
          "opensearch": {
             "cluster_stats_enabled": true,
             "index_stats_enabled": true,
             "pending_task_stats_enabled": true,
             "pshard_stats_enabled": true
          }
       }' \
       INTEGRATION_ID

    Include only the categories to change. Setting one category doesn't affect the others.

  3. Check that the configuration is set correctly:

    avn service integration-list SERVICE_NAME \
       --project PROJECT_NAME \
       --json | jq '.[] | select(.integration_type=="datadog").user_config'

    Expect output similar to the following:

    {
      "opensearch": {
        "cluster_stats_enabled": true,
        "index_stats_enabled": true,
        "pending_task_stats_enabled": true,
        "pshard_stats_enabled": true
      }
    }

  4. Find the collected metrics in the Datadog Metrics Explorer under the elasticsearch. prefix.

Related pages