Skip to content

819-196-TEST-input-kafka #1912

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: 8.19
Choose a base branch
from
Draft

819-196-TEST-input-kafka #1912

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 51 additions & 51 deletions docs/plugins/inputs/kafka.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,17 +149,17 @@ See the https://kafka.apache.org/{kafka_client_doc}/documentation for more detai
| <<plugins-{type}s-{plugin}-request_timeout_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-retry_backoff_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-sasl_client_callback_handler_class>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_oauthbearer_token_endpoint_url>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_oauthbearer_scope_claim_name>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_iam_jar_paths>> |<<array,array>>|No
| <<plugins-{type}s-{plugin}-sasl_jaas_config>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_kerberos_service_name>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_login_callback_handler_class>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_login_connect_timeout_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-sasl_login_read_timeout_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-sasl_login_retry_backoff_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-sasl_login_retry_backoff_max_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-sasl_jaas_config>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_kerberos_service_name>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_login_retry_backoff_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-sasl_mechanism>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_oauthbearer_scope_claim_name>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_oauthbearer_token_endpoint_url>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-schema_registry_key>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-schema_registry_proxy>> |<<uri,uri>>|No
| <<plugins-{type}s-{plugin}-schema_registry_secret>> |<<string,string>>|No
Expand Down Expand Up @@ -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 <<string,string>>
* 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 <<string,string>>
* 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 <<array,array>>
Expand All @@ -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 <<string,string>>
* 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 <<string,string>>
* 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 <<string,string>>
Expand All @@ -632,46 +645,19 @@ 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 <<number,number>>
* 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 <<number,number>>
* Default value is `10000` milliseconds.

(optional) The maximum duration, in milliseconds, for HTTPS call attempts.

[id="plugins-{type}s-{plugin}-sasl_jaas_config"]
===== `sasl_jaas_config`

* Value type is <<string,string>>
* 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 <<string,string>>
* 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 <<number,number>>
* 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`
Expand All @@ -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 <<string,string>>
* 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 <<string,string>>
* Default value is `"scope"`

(optional) The override name of the scope claim.

Comment on lines +673 to +686
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These two need to be flipped (_scope then _token).

[id="plugins-{type}s-{plugin}-schema_registry_key"]
===== `schema_registry_key`

Expand Down