Skip to content

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@wildum
wildum committed Apr 11, 2024
1 parent d535338 commit 00e7914
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 37 deletions.
72 changes: 36 additions & 36 deletions docs/sources/flow/reference/components/prometheus.exporter.kafka.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,42 +27,42 @@ prometheus.exporter.kafka "LABEL" {
You can use the following arguments to configure the exporter's behavior.
Omitted fields take their default values.

| Name | Type | Description | Default | Required |
| ----------------------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -------- |
| `kafka_uris` | `array(string)` | Address array (host:port) of Kafka server. | | yes |
| `instance` | `string` | The`instance`label for metrics, default is the hostname:port of the first kafka_uris. You must manually provide the instance value if there is more than one string in kafka_uris. | | no |
| `use_sasl` | `bool` | Connect using SASL/PLAIN. | | no |
| `use_sasl_handshake` | `bool` | Only set this to false if using a non-Kafka SASL proxy. | `true` | no |
| `sasl_username` | `string` | SASL user name. | | no |
| `sasl_password` | `string` | SASL user password. | | no |
| `sasl_mechanism` | `string` | The SASL SCRAM SHA algorithm sha256 or sha512 as mechanism. | | no |
| `sasl_disable_pafx_fast` | `bool` | Configure the Kerberos client to not use PA_FX_FAST. | | no |
| `use_tls` | `bool` | Connect using TLS. | | no |
| `tls_server_name` | `string` | Used to verify the hostname on the returned certificates unless tls.insecure-skip-tls-verify is given. The kafka server's name should be given. | | no |
| `ca_file` | `string` | The optional certificate authority file for TLS client authentication. | | no |
| `cert_file` | `string` | The optional certificate file for TLS client authentication. | | no |
| `key_file` | `string` | The optional key file for TLS client authentication. | | no |
| `insecure_skip_verify` | `bool` | If set to true, the server's certificate will not be checked for validity. This makes your HTTPS connections insecure. | | no |
| `kafka_version` | `string` | Kafka broker version. | `2.0.0` | no |
| `use_zookeeper_lag` | `bool` | If set to true, use a group from zookeeper. | | no |
| `zookeeper_uris` | `array(string)` | Address array (hosts) of zookeeper server. | | no |
| `kafka_cluster_name` | `string` | Kafka cluster name. | | no |
| `metadata_refresh_interval` | `duration` | Metadata refresh interval. | `1m` | no |
| `gssapi_service_name` | `string` | Service name when using Kerberos Authorization | | no |
| `gssapi_kerberos_config_path` | `string` | Kerberos config path. | | no |
| `gssapi_realm` | `string` | Kerberos realm. | | no |
| `gssapi_key_tab_path` | `string` | Kerberos keytab file path. | | no |
| `gssapi_kerberos_auth_type` | `string` | Kerberos auth type. Either 'keytabAuth' or 'userAuth'. | | no |
| `offset_show_all` | `bool` | If true, the broker may auto-create topics that we requested which do not already exist. | `true` | no |
| `topic_workers` | `int` | Minimum number of topics to monitor. | `100` | no |
| `allow_concurrency` | `bool` | If set to true, all scrapes trigger Kafka operations. Otherwise, they will share results. WARNING: Disable this on large clusters. | `true` | no |
| `allow_auto_topic_creation` | `bool` | If true, the broker may auto-create topics that we requested which do not already exist. | | no |
| `max_offsets` | `int` | The maximum number of offsets to store in the interpolation table for a partition. | `1000` | no |
| `prune_interval_seconds` | `int` | Deprecated (no-op), use `metadata_refresh_interval` instead. | `30` | no |
| `topics_filter_regex` | `string` | Regex filter for topics to be monitored. | `.*` | no |
| `topics_exclude_regex` | `string` | Regex that determines which topics to exclude. | `^$` | no |
| `groups_filter_regex` | `string` | Regex filter for consumer groups to be monitored. | `.*` | no |
| `groups_exclude_regex` | `string` | Regex that determines which consumer groups to exclude. | `^$` | no |
| Name | Type | Description | Default | Required |
| ----------------------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -------- |
| `kafka_uris` | `array(string)` | Address array (host:port) of Kafka server. | | yes |
| `instance` | `string` | The`instance`label for metrics, default is the hostname:port of the first kafka_uris. You must manually provide the instance value if there is more than one string in kafka_uris. | | no |
| `use_sasl` | `bool` | Connect using SASL/PLAIN. | | no |
| `use_sasl_handshake` | `bool` | Only set this to false if using a non-Kafka SASL proxy. | `true` | no |
| `sasl_username` | `string` | SASL user name. | | no |
| `sasl_password` | `string` | SASL user password. | | no |
| `sasl_mechanism` | `string` | The SASL SCRAM SHA algorithm sha256 or sha512 as mechanism. | | no |
| `sasl_disable_pafx_fast` | `bool` | Configure the Kerberos client to not use PA_FX_FAST. | | no |
| `use_tls` | `bool` | Connect using TLS. | | no |
| `tls_server_name` | `string` | Used to verify the hostname on the returned certificates unless tls.insecure-skip-tls-verify is given. If you don't provide the Kafka server name, the hostname is taken from the URL. | | no |
| `ca_file` | `string` | The optional certificate authority file for TLS client authentication. | | no |
| `cert_file` | `string` | The optional certificate file for TLS client authentication. | | no |
| `key_file` | `string` | The optional key file for TLS client authentication. | | no |
| `insecure_skip_verify` | `bool` | If set to true, the server's certificate will not be checked for validity. This makes your HTTPS connections insecure. | | no |
| `kafka_version` | `string` | Kafka broker version. | `2.0.0` | no |
| `use_zookeeper_lag` | `bool` | If set to true, use a group from zookeeper. | | no |
| `zookeeper_uris` | `array(string)` | Address array (hosts) of zookeeper server. | | no |
| `kafka_cluster_name` | `string` | Kafka cluster name. | | no |
| `metadata_refresh_interval` | `duration` | Metadata refresh interval. | `1m` | no |
| `gssapi_service_name` | `string` | Service name when using Kerberos Authorization | | no |
| `gssapi_kerberos_config_path` | `string` | Kerberos config path. | | no |
| `gssapi_realm` | `string` | Kerberos realm. | | no |
| `gssapi_key_tab_path` | `string` | Kerberos keytab file path. | | no |
| `gssapi_kerberos_auth_type` | `string` | Kerberos auth type. Either 'keytabAuth' or 'userAuth'. | | no |
| `offset_show_all` | `bool` | If true, the broker may auto-create topics that we requested which do not already exist. | `true` | no |
| `topic_workers` | `int` | Minimum number of topics to monitor. | `100` | no |
| `allow_concurrency` | `bool` | If set to true, all scrapes trigger Kafka operations. Otherwise, they will share results. WARNING: Disable this on large clusters. | `true` | no |
| `allow_auto_topic_creation` | `bool` | If true, the broker may auto-create topics that we requested which do not already exist. | | no |
| `max_offsets` | `int` | The maximum number of offsets to store in the interpolation table for a partition. | `1000` | no |
| `prune_interval_seconds` | `int` | Deprecated (no-op), use `metadata_refresh_interval` instead. | `30` | no |
| `topics_filter_regex` | `string` | Regex filter for topics to be monitored. | `.*` | no |
| `topics_exclude_regex` | `string` | Regex that determines which topics to exclude. | `^$` | no |
| `groups_filter_regex` | `string` | Regex filter for consumer groups to be monitored. | `.*` | no |
| `groups_exclude_regex` | `string` | Regex that determines which consumer groups to exclude. | `^$` | no |

## Exported fields

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/static/configuration/integrations/kafka-exporter-config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Full reference of options:
# Connect using TLS
[use_tls: <bool>]

# Used to verify the hostname on the returned certificates unless tls.insecure-skip-tls-verify is given. The kafka server's name should be given.
# Used to verify the hostname on the returned certificates unless tls.insecure-skip-tls-verify is given. If you don't provide the Kafka server name, the hostname is taken from the URL.
[tls_server_name: <string>]

# The optional certificate authority file for TLS client authentication
Expand Down

0 comments on commit 00e7914

Please sign in to comment.