Skip to content
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.

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

[exporter/kafkaexporter] Support for configuring SASL handshake version #21074

Closed
eduojeda opened this issue Apr 19, 2023 · 3 comments
Closed
Assignees
Labels

Comments

@eduojeda
Copy link
Contributor

eduojeda commented Apr 19, 2023

Component(s)

exporter/kafka

Is your feature request related to a problem? Please describe.

The Kafka exporter is built on top of Shopify's sarama Kafka client. The sarama library defaults to using SASL handshake V0 (see here), but Kafka > 1.x uses SASL handshake V1. The library allows the version to be set via configuration, but the exporter does not expose this functionality. This leads to connection timeouts when trying to reach a Kafka > 1.x broker.

Describe the solution you'd like

The Kafka exporter should allow SASL users to configure the version as needed. This can easily be done through a new exporters.kafka.auth.sasl.version key in the collector's YAML config. The value should default to 0 for backwards compatibility.

Describe alternatives you've considered

No response

Additional context

We have already created a PR with the required changes. Furthermore, we have built and deployed a custom collector that successfully connects to our Kafka cluster using SASL handshake V1 via the proposed change.

@eduojeda eduojeda added enhancement New feature or request needs triage New item requiring triage labels Apr 19, 2023
@github-actions
Copy link
Contributor

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@eduojeda eduojeda changed the title [exporter/kafkaexporter] Support for configuring SASL protocol version [exporter/kafkaexporter] Support for configuring SASL handshake version Apr 20, 2023
@atoulme atoulme removed the needs triage New item requiring triage label Apr 29, 2023
@github-actions
Copy link
Contributor

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@github-actions github-actions bot added the Stale label Jun 29, 2023
MovieStoreGuy pushed a commit that referenced this issue Jul 11, 2023
…ersion (#21075)

**Description:**
Adds support for configuring SASL handshake version.

The new parameter defaults to 0 just like Sarama, so the change should
be backwards compatible.

**Link to tracking Issue:** #21074 

**Testing:**
- Added a test for the check that the SASL version parameter is within
the acceptable range
- Built a custom collector and tested that the version setting works as
expected.

**Documentation:**
- Updated the README file to document the new SASL configuration
parameter.
@eduojeda
Copy link
Contributor Author

The proposed changes have now been marged upstream.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants