> ## 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.
# CockroachDB
Ent+
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.
## Supported Platforms
| Platform | Metrics | Logs | Traces |
| :------- | :------ | :--- | :----- |
| Linux | ✓ | ✓ | |
| Windows | ✓ | ✓ | |
| macOS | ✓ | ✓ | |
## Configuration Table
| Parameter | Type | Default | Description |
| :------------------------------ | :------------------ | :-------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| telemetry\_types | `telemetrySelector` | `["Logs", "Metrics"]` | Choose Telemetry Type. |
| hostname\* | `string` | "localhost" | The hostname or IP address of the CockroachDB system. Required: true. |
| port | `int` | 8080 | The port to listen on for DB Console HTTP requests. [Read more](https://www.cockroachlabs.com/docs/stable/cockroach-start#networking) |
| username | `string` | "" | The username to use when connecting to CockroachDB. [Read more](https://www.cockroachlabs.com/docs/stable/create-user#create-a-user) |
| password | `string` | "" | The password to use when connecting to CockroachDB. TLS must be configured in the Advanced section if this field is set. Sensitive: true. [Read more](https://www.cockroachlabs.com/docs/stable/create-user#create-a-user-with-a-password) |
| enable\_tls | `bool` | false | Whether or not to use TLS. |
| ca\_file\_path | `string` | "" | File path for CA certification file for CockroachDB (only needed if you have a secure cluster). [Read more](https://www.cockroachlabs.com/docs/stable/cockroach-cert#client-key-and-certificates) |
| cert\_file\_path | `string` | "" | A TLS certificate used for client authentication, if mutual TLS is enabled. [Read more](https://www.cockroachlabs.com/docs/stable/cockroach-cert#client-key-and-certificates) |
| key\_file\_path | `string` | "" | A TLS private key used for client authentication, if mutual TLS is enabled. [Read more](https://www.cockroachlabs.com/docs/stable/cockroach-cert#client-key-and-certificates) |
| server\_name | `string` | "" | The name of the server. [Read more](https://datatracker.ietf.org/doc/html/rfc4366#section-3.1) |
| insecure\_skip\_verify | `bool` | false | Disable validation of the server certificate. |
| collection\_interval | `int` | 60 | How often (seconds) to scrape for metrics. |
| enable\_health\_log\* | `bool` | true | Enable to collect health logs. [Read more](https://www.cockroachlabs.com/docs/stable/logging#health) |
| health\_log\_path\* | `strings` | \["/var/log/cockroach-data/logs/cockroach-health.log"] | The absolute path to the CockroachDB health logs. |
| enable\_dev\_log\* | `bool` | true | Enable to collect general developer logs. [Read more](https://www.cockroachlabs.com/docs/stable/logging#dev) |
| dev\_log\_path\* | `strings` | \["/var/log/cockroach-data/logs/cockroach.log"] | The absolute path to the CockroachDB Dev Logs. |
| enable\_error\_log\* | `bool` | true | Enable to collect stderr logs. |
| error\_log\_path\* | `strings` | \["/var/log/cockroach-data/logs/cockroach-stderr.log"] | The absolute path to the CockroachDB stderr logs. |
| enable\_sql\_schema\_log\* | `bool` | true | Enable to collect sql schema logs. [Read more](https://www.cockroachlabs.com/docs/stable/logging#sql_schema) |
| sql\_schema\_log\_path\* | `strings` | \["/var/log/cockroach-data/logs/cockroach-sql-schema.log"] | The absolute path to the CockroachDB sql schema logs. |
| enable\_telemetry\_log\* | `bool` | true | Enable to collect telemetry logs. [Read more](https://www.cockroachlabs.com/docs/stable/logging#telemetry) |
| telemetry\_log\_path\* | `strings` | \["/var/log/cockroach-data/logs/cockroach-telemetry.log"] | The absolute path to the CockroachDB telemetry logs. |
| enable\_kv\_distribution\_log\* | `bool` | true | Enable to collect kv distribution logs. [Read more](https://www.cockroachlabs.com/docs/stable/logging#kv_distribution) |
| kv\_distribution\_log\_path\* | `strings` | \["/var/log/cockroach-data/logs/cockroach-kv-distribution.log"] | The absolute path to the CockroachDB kv distribution logs. |
| enable\_pebble\_log\* | `bool` | true | Enable to collect cockroachdb pebble logs. [Read more](https://www.cockroachlabs.com/docs/stable/logging#storage) |
| pebble\_log\_path\* | `strings` | \["/var/log/cockroach-data/logs/cockroach-pebble.log"] | The absolute path to the CockroachDB pebble logs. |
| offset\_storage\_dir\* | `string` | "\$OIQ\_OTEL\_COLLECTOR\_HOME/storage" | The directory the offset storage file will be created in. |
| timezone\* | `timezone` | "UTC" | The timezone to use when parsing timestamps. |
| start\_at\* | `enum` | end | Start reading logs from 'beginning' or 'end'. |
| parse\_to\* | `enum` | body | Parse structured log parts to either body or attributes. |
| retain\_raw\_logs\* | `bool` | false | Preserve the original log message in a raw\_log key. |
## Example Configuration
This configuration shows the default values for the CockroachDB Source.
