Overview

This check monitors Kube_apiserver_metrics.

Setup

Installation

The Kube_apiserver_metrics check is included in the Datadog Agent package, so you do not need to install anything else on your server.

Configuration

If your Kubernetes clusters have master nodes and is running a pod and container for the kube-apiserver image, the Datadog Agent automatically discovers this pod and configures the integration relative to its kube_apiserver_metrics.d/auto_conf.yaml file.

However, if you are using a managed Kubernetes distribution like GKE, EKS, or AKS you may not have a running kube-apiserver pod present for the Agent to discover.

In this case, you can setup the integration against the kubernetes Service in the default namespace.

• The main use case to run the kube_apiserver_metrics check is as a Cluster Level Check.
• You can do this with annotations on your service, or by using a local file through the Datadog Operator, Helm Chart or manually.
• To collect metrics, set the following parameters and values in an Autodiscovery template.

You can review all available configuration options in the kube_apiserver_metrics.yaml.

Annotate service

You can annotate the kubernetes service in your default namespace with the following:

ad.datadoghq.com/endpoints.checks: |
  {
    "kube_apiserver_metrics": {
      "instances": [
        {
          "prometheus_url": "https://%%host%%:%%port%%/metrics"
        }
      ]
    }
  }   

annotations:
  ad.datadoghq.com/endpoints.check_names: '["kube_apiserver_metrics"]'
  ad.datadoghq.com/endpoints.init_configs: '[{}]'
  ad.datadoghq.com/endpoints.instances:
    '[{ "prometheus_url": "https://%%host%%:%%port%%/metrics"}]'

Then the Datadog Cluster Agent schedules the check(s) for each endpoint onto Datadog Agent(s).

Local file

You can also run the check by configuring the endpoints directly in the kube_apiserver_metrics.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to dispatch as a Cluster Check.

Note: You must add cluster_check: true to your configuration file if using a local file or ConfigMap to configure Cluster Checks.

Provide a configuration to your Cluster Agent to setup a Cluster Check:

clusterAgent:
  confd:
    kube_apiserver_metrics.yaml: |-
      advanced_ad_identifiers:
        - kube_endpoints:
            name: "kubernetes"
            namespace: "default"
      cluster_check: true
      init_config:
      instances:
        - prometheus_url: "https://%%host%%:%%port%%/metrics"      

spec:
#(...)
  override:
    clusterAgent:
      extraConfd:
        configDataMap:
          kube_apiserver_metrics.yaml: |-
            advanced_ad_identifiers:
              - kube_endpoints:
                  name: "kubernetes"
                  namespace: "default"
            cluster_check: true
            init_config:
            instances:
              - prometheus_url: "https://%%host%%:%%port%%/metrics"            

These configurations trigger the Agent to make a request to the kubernetes service in the default namespace at its defined Endpoint IP Addresses and defined port.

Validation

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

Data Collected

Metrics

Service Checks

Kube_apiserver_metrics does not include any service checks.

Events

Kube_apiserver_metrics does not include any events.

Troubleshooting

Need help? Contact Datadog support.