Overview

This check monitors Kubernetes Cluster Autoscaler 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.

Installation

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

Configuration

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

2. Restart the Agent.

Metric collection

Make sure that the Prometheus-formatted metrics are exposed in your kubernetes_cluster_autoscaler cluster. For the Agent to start collecting metrics, the kubernetes_cluster_autoscaler pods need to be annotated.

Kubernetes Cluster Autoscaler has metrics and livenessProbe endpoints that can be accessed on port 8085. These endpoints are located under /metrics and /health-check and provide valuable information about the state of your cluster during scaling operations.

Note: To change the default port, use the --address flag.

To configure the Cluster Autoscaler to expose metrics, do the following:

1. Enable access to the /metrics route and expose port 8085 for your Cluster Autoscaler deployment:

ports:
--name: app
containerPort: 8085

b) instruct your Prometheus to scrape it, by adding the following annotation to your Cluster Autoscaler service:

prometheus.io/scrape: true

Note: The listed metrics can only be collected if they are available. Some metrics are generated only when certain actions are performed.

The only parameter required for configuring the kubernetes_cluster_autoscaler check is openmetrics_endpoint. This parameter should be set to the location where the Prometheus-formatted metrics are exposed. The default port is 8085. To configure a different port, use the METRICS_PORT environment variable. In containerized environments, %%host%% should be used for host autodetection.

apiVersion: v1
kind: Pod
# (...)
metadata:
  name: '<POD_NAME>'
  annotations:
    ad.datadoghq.com/controller.checks: |
      {
        "kubernetes_cluster_autoscaler": {
          "init_config": {},
          "instances": [
            {
              "openmetrics_endpoint": "http://%%host%%:8085/metrics"
            }
          ]
        }
      }      
    # (...)
spec:
  containers:
    - name: 'controller'
# (...)

Validation

Run the Agent’s status subcommand and look for kubernetes_cluster_autoscaler under the Checks section.

Data Collected

Metrics

Events

The Kubernetes Cluster Autoscaler integration does not include any events.

Service Checks

kubernetes_cluster_autoscaler.openmetrics.health
Returns CRITICAL if the Agent is unable to connect to the Kubernetes Cluster Autoscaler OpenMetrics endpoint, otherwise returns OK.
Statuses: ok, critical

Troubleshooting

Need help? Contact Datadog support.