diff --git a/docs/plugins/inputs/kafka.asciidoc b/docs/plugins/inputs/kafka.asciidoc index aa61edc22..f8f13de7c 100644 --- a/docs/plugins/inputs/kafka.asciidoc +++ b/docs/plugins/inputs/kafka.asciidoc @@ -149,17 +149,17 @@ See the https://kafka.apache.org/{kafka_client_doc}/documentation for more detai | <> |<>|No | <> |<>|No | <> |<>|No -| <> |<>|No -| <> |<>|No | <> |<>|No +| <> |<>|No +| <> |<>|No | <> |<>|No | <> |<>|No | <> |<>|No -| <> |<>|No | <> |<>|No -| <> |<>|No -| <> |<>|No +| <> |<>|No | <> |<>|No +| <> |<>|No +| <> |<>|No | <> |<>|No | <> |<>|No | <> |<>|No @@ -589,20 +589,6 @@ to a given topic partition. This avoids repeated fetching-and-failing in a tight The SASL client callback handler class the specified SASL mechanism should use. -[id="plugins-{type}s-{plugin}-sasl_oauthbearer_token_endpoint_url"] -===== `sasl_oauthbearer_token_endpoint_url` - * Value type is <> - * There is no default value for this setting. - -The URL for the OAuth 2.0 issuer token endpoint. - -[id="plugins-{type}s-{plugin}-sasl_oauthbearer_scope_claim_name"] -===== `sasl_oauthbearer_scope_claim_name` - * Value type is <> - * Default value is `"scope"` - -(optional) The override name of the scope claim. - [id="plugins-{type}s-{plugin}-sasl_iam_jar_paths"] ===== `sasl_iam_jar_paths` * Value type is <> @@ -611,6 +597,33 @@ The URL for the OAuth 2.0 issuer token endpoint. Contains the list of paths to jar libraries that contains cloud providers MSK IAM's clients. There is one jar per provider and can be retrieved as described in <<"plugins-{type}s-{plugin}-aws_msk_iam_auth">>. +[id="plugins-{type}s-{plugin}-sasl_jaas_config"] +===== `sasl_jaas_config` + + * Value type is <> + * There is no default value for this setting. + +JAAS configuration setting local to this plugin instance, as opposed to settings using config file configured using `jaas_path`, which are shared across the JVM. This allows each plugin instance to have its own configuration. + +If both `sasl_jaas_config` and `jaas_path` configurations are set, the setting here takes precedence. + +Example (setting for Azure Event Hub): +[source,ruby] + input { + kafka { + sasl_jaas_config => "org.apache.kafka.common.security.plain.PlainLoginModule required username='auser' password='apassword';" + } + } + +[id="plugins-{type}s-{plugin}-sasl_kerberos_service_name"] +===== `sasl_kerberos_service_name` + + * Value type is <> + * There is no default value for this setting. + +The Kerberos principal name that Kafka broker runs as. +This can be defined either in Kafka's JAAS config or in Kafka's config. + [id="plugins-{type}s-{plugin}-sasl_login_callback_handler_class"] ===== `sasl_login_callback_handler_class` * Value type is <> @@ -632,13 +645,6 @@ The SASL login callback handler class the specified SASL mechanism should use. (optional) The duration, in milliseconds, for HTTPS read timeout. -[id="plugins-{type}s-{plugin}-sasl_login_retry_backoff_ms"] -===== `sasl_login_retry_backoff_ms` - * Value type is <> - * Default value is `100` milliseconds. - -(optional) The duration, in milliseconds, to wait between HTTPS call attempts. - [id="plugins-{type}s-{plugin}-sasl_login_retry_backoff_max_ms"] ===== `sasl_login_retry_backoff_max_ms` * Value type is <> @@ -646,32 +652,12 @@ The SASL login callback handler class the specified SASL mechanism should use. (optional) The maximum duration, in milliseconds, for HTTPS call attempts. -[id="plugins-{type}s-{plugin}-sasl_jaas_config"] -===== `sasl_jaas_config` - - * Value type is <> - * There is no default value for this setting. - -JAAS configuration setting local to this plugin instance, as opposed to settings using config file configured using `jaas_path`, which are shared across the JVM. This allows each plugin instance to have its own configuration. - -If both `sasl_jaas_config` and `jaas_path` configurations are set, the setting here takes precedence. - -Example (setting for Azure Event Hub): -[source,ruby] - input { - kafka { - sasl_jaas_config => "org.apache.kafka.common.security.plain.PlainLoginModule required username='auser' password='apassword';" - } - } - -[id="plugins-{type}s-{plugin}-sasl_kerberos_service_name"] -===== `sasl_kerberos_service_name` - - * Value type is <> - * There is no default value for this setting. +[id="plugins-{type}s-{plugin}-sasl_login_retry_backoff_ms"] +===== `sasl_login_retry_backoff_ms` + * Value type is <> + * Default value is `100` milliseconds. -The Kerberos principal name that Kafka broker runs as. -This can be defined either in Kafka's JAAS config or in Kafka's config. +(optional) The duration, in milliseconds, to wait between HTTPS call attempts. [id="plugins-{type}s-{plugin}-sasl_mechanism"] ===== `sasl_mechanism` @@ -684,6 +670,20 @@ This may be any mechanism for which a security provider is available. For AWS MSK IAM authentication use `AWS_MSK_IAM`. GSSAPI is the default mechanism. +[id="plugins-{type}s-{plugin}-sasl_oauthbearer_token_endpoint_url"] +===== `sasl_oauthbearer_token_endpoint_url` + * Value type is <> + * There is no default value for this setting. + +The URL for the OAuth 2.0 issuer token endpoint. + +[id="plugins-{type}s-{plugin}-sasl_oauthbearer_scope_claim_name"] +===== `sasl_oauthbearer_scope_claim_name` + * Value type is <> + * Default value is `"scope"` + +(optional) The override name of the scope claim. + [id="plugins-{type}s-{plugin}-schema_registry_key"] ===== `schema_registry_key`