| Platform | Metrics | Logs | Traces |
|---|---|---|---|
| Linux | ✓ | ✓ | |
| Windows | ✓ | ✓ | |
| macOS | ✓ | ✓ |
| 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 |
| username | string |
"" | The username to use when connecting to CockroachDB. Read more |
| 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 |
| 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 |
| cert_file_path | string |
"" | A TLS certificate used for client authentication, if mutual TLS is enabled. Read more |
| key_file_path | string |
"" | A TLS private key used for client authentication, if mutual TLS is enabled. Read more |
| server_name | string |
"" | The name of the server. Read more |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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. |
This configuration shows the default values for the CockroachDB Source.
