Skip to content

Add fine tuned oath/sasl configuration to kafka client#189

Merged
donoghuc merged 9 commits intologstash-plugins:mainfrom
donoghuc:GH-180-additional-config-options
Jan 7, 2025
Merged

Add fine tuned oath/sasl configuration to kafka client#189
donoghuc merged 9 commits intologstash-plugins:mainfrom
donoghuc:GH-180-additional-config-options

Conversation

@donoghuc
Copy link
Contributor

@donoghuc donoghuc commented Jan 6, 2025

Add plugin configuration options for both input/output to support oauth and sasl authentication.

This PR aggregates #183 and #181 and adds some unit tests.

I found it difficult to spin up a valid test environment to fully test the integrations, but looking at the options in https://github.com/apache/kafka/blob/trunk/clients/src/main/java/org/apache/kafka/common/config/SaslConfigs.java I think the added unit tests show that we are piping through the requested configuration to the kafka clients.

Closes #180

This commit updates the plugin defaults to align with the default (or lack of
default) values in the underlying kafka client library.

https://github.com/apache/kafka/blob/3.8.1/clients/src/main/java/org/apache/kafka/common/TopicIdPartition.java
donoghuc and others added 4 commits January 7, 2025 11:22
Co-authored-by: Mashhur <99575341+mashhurs@users.noreply.github.com>
Co-authored-by: Mashhur <99575341+mashhurs@users.noreply.github.com>
Co-authored-by: Mashhur <99575341+mashhurs@users.noreply.github.com>
Co-authored-by: Mashhur <99575341+mashhurs@users.noreply.github.com>
Copy link
Contributor

@mashhurs mashhurs left a comment

Choose a reason for hiding this comment

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

LGTM!
Thank you so much Cas.
The last failed CI seems to me transient.

@donoghuc
Copy link
Contributor Author

donoghuc commented Jan 7, 2025

Reload yeilded a green run. Going to merge and release.

@donoghuc donoghuc merged commit 6de2996 into logstash-plugins:main Jan 7, 2025
1 check passed
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

Left suggestion inline to use order options alphabetically.

Comment on lines +134 to +140
| <<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_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
Copy link
Contributor

Choose a reason for hiding this comment

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

The one got by me.
For next time: Options should be in alpha order in both option list and descriptions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment