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

# Kafka Cluster

<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 |
| :------- | :------ | :--- | :----- |
| Linux    | ✓       |      |        |
| Windows  | ✓       |      |        |
| macOS    | ✓       |      |        |

## Configuration Table

| Parameter               | Type      | Default                    | Description                                                                                                                         |
| :---------------------- | :-------- | :------------------------- | :---------------------------------------------------------------------------------------------------------------------------------- |
| cluster\_name\*         | `string`  |                            | Friendly name used for the resource kafka.cluster.name.                                                                             |
| protocol\_version       | `enum`    | "2.0.0"                    | The Kafka protocol version to use when communicating with brokers. Valid values are: `"2.2.1"`, `"2.2.0"`, `"2.0.0"`, or `"1.0.0"`. |
| brokers                 | `strings` | localhost:9092             | List of brokers to scrape for metrics.                                                                                              |
| client\_id              | `string`  | otel-metrics-receiver      | The consumer client ID that the receiver will use.                                                                                  |
| collection\_interval    | `int`     | 60                         | Sets how often (seconds) to scrape for metrics.                                                                                     |
| enable\_auth            | `bool`    | false                      |                                                                                                                                     |
| auth\_type              | `enum`    | basic                      | `basic`, `sasl`, or `kerberos`                                                                                                      |
| basic\_username         | `string`  |                            |                                                                                                                                     |
| basic\_password         | `string`  |                            |                                                                                                                                     |
| sasl\_username          | `string`  |                            |                                                                                                                                     |
| sasl\_password          | `string`  |                            |                                                                                                                                     |
| sasl\_mechanism         | `enum`    | SCRAM-SHA-256              | `SCRAM-SHA-256`, `SCRAM-SHA-512`, or `PLAIN`                                                                                        |
| kerberos\_service\_name | `string`  |                            |                                                                                                                                     |
| kerberos\_realm         | `string`  |                            |                                                                                                                                     |
| kerberos\_config\_file  | `string`  | /etc/krb5.conf             |                                                                                                                                     |
| kerberos\_auth\_type    | `enum`    | keytab                     | `keytab` or `basic`                                                                                                                 |
| kerberos\_keytab\_file  | `string`  | /etc/security/kafka.keytab |                                                                                                                                     |
| kerberos\_username      | `string`  |                            |                                                                                                                                     |
| kerberos\_password      | `string`  |                            |                                                                                                                                     |