# Kubernetes Cluster Metrics

### Supported Platforms

| Platform            | Metrics | Logs | Traces |
| ------------------- | ------- | ---- | ------ |
| Kubernetes Cluster  | ✓       |      |        |
| OpenShift 4 Cluster | ✓       |      |        |

### Configuration Table

<table><thead><tr><th width="230.8125">Parameter</th><th width="94.2578125">Type</th><th width="107.5">Default</th><th>Description</th></tr></thead><tbody><tr><td>cluster_name*</td><td><code>string</code></td><td></td><td>The cluster name that will be added as the <code>k8s.cluster.name</code> resource attribute.</td></tr><tr><td>node_conditions_to_report</td><td><code>enums</code></td><td>all</td><td>Enable or disable which node conditions should be included in metrics collection.</td></tr><tr><td>allocatable_types_to_report</td><td><code>enums</code></td><td>all</td><td>Allocatable resource types to report.</td></tr><tr><td>collection_interval</td><td><code>int</code></td><td>60s</td><td>How often to collect metrics from the Kubernetes API</td></tr><tr><td>distribution</td><td><code>enum</code></td><td>kubernetes</td><td>The Kubernetes distribution. Used to enable support for OpenShift quota metrics.</td></tr></tbody></table>

<mark style="color:red;">\*</mark>*<mark style="color:red;">required field</mark>*

### 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.

<figure><img src="https://1405008107-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmiOMzBfoNFwmKJFHMcJ%2Fuploads%2Fgit-blob-ebeb36b092c1dfabb50ff09b16c41c8be6db871f%2Fintegrations-sources-kubernetes-cluster-metrics-image-1.png?alt=media" alt="Bindplane docs - Kubernetes Cluster Metrics - image 1"><figcaption></figcaption></figure>

Once running on a collector, metrics will look like this:

<figure><img src="https://1405008107-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmiOMzBfoNFwmKJFHMcJ%2Fuploads%2Fgit-blob-ae2a1a2b040bb0043e65e52998ea1d875ff0653b%2Fintegrations-sources-kubernetes-cluster-metrics-image-2.png?alt=media" alt="Bindplane docs - Kubernetes Cluster Metrics - image 2"><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.bindplane.com/integrations/sources/kubernetes-cluster-metrics.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.