> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeycomb.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Kubernetes Cluster Metrics

> Collect cluster level metrics from the Kubernetes API

<Badge className="hny-badge-enterprise-addon" stroke>Ent+</Badge>

<Note>
  This feature is available as an add-on for the [Honeycomb Enterprise plan](https://www.honeycomb.io/pricing/).
  Please contact your Honeycomb account team for details.
</Note>

## Supported Platforms

| Platform               | Metrics | Logs | Traces |
| :--------------------- | :------ | :--- | :----- |
| Kubernetes Deployment  | ✓       |      |        |
| OpenShift 4 Deployment | ✓       |      |        |

## Configuration Table

| Parameter                      | Type     | Default    | Description                                                                       |
| :----------------------------- | :------- | :--------- | :-------------------------------------------------------------------------------- |
| cluster\_name\*                | `string` |            | The cluster name that will be added as the `k8s.cluster.name` resource attribute. |
| node\_conditions\_to\_report   | `enums`  | all        | Enable or disable which node conditions should be included in metrics collection. |
| allocatable\_types\_to\_report | `enums`  | all        | Allocatable resource types to report.                                             |
| collection\_interval           | `int`    | 60s        | How often to collect metrics from the Kubernetes API                              |
| distribution                   | `enum`   | kubernetes | The Kubernetes distribution. Used to enable support for OpenShift quota metrics.  |

## Example Configuration

The Kubernetes Cluster metrics source has one required parameter:

* Cluster Name: The name of the cluster, which will be inserted as the `k8s.cluster.name` resource attribute
* If running on OpenShift, you can select `OpenShift` as the Kubernetes Distribution in order to collector quota metrics.

<img src="https://mintcdn.com/honeycomb/ibXJI2unoLZRp0G4/_assets/images/htp/xnapper-kubernetes-cluster-source.png?fit=max&auto=format&n=ibXJI2unoLZRp0G4&q=85&s=2f795edcc90aeff046950320594fcc0f" alt="Honeycomb Docs - Kubernetes Cluster Metrics - image 1" width="2166" height="2034" data-path="_assets/images/htp/xnapper-kubernetes-cluster-source.png" />

Once running on an agent, metrics will look like this:

<img src="https://mintcdn.com/honeycomb/ibXJI2unoLZRp0G4/_assets/images/htp/xnapper-kubernetes-cluster-source-2.png?fit=max&auto=format&n=ibXJI2unoLZRp0G4&q=85&s=40a24319285f053e8b518833e914df30" alt="Honeycomb Docs - Kubernetes Cluster Metrics - image 2" width="3224" height="1888" data-path="_assets/images/htp/xnapper-kubernetes-cluster-source-2.png" />
