Skip to content

[feature] support Kafka client SCRAM authentication - #4320

Open
goutamadwant wants to merge 1 commit into
apache:masterfrom
goutamadwant:feature-kafka-client-scram-auth
Open

[feature] support Kafka client SCRAM authentication#4320
goutamadwant wants to merge 1 commit into
apache:masterfrom
goutamadwant:feature-kafka-client-scram-auth

Conversation

@goutamadwant

Copy link
Copy Markdown

What's changed?

Adds optional SCRAM authentication to Kafka Client monitoring.

  • add PLAINTEXT, SASL_PLAINTEXT, and SASL_SSL security protocol options
  • support SCRAM-SHA-256 and SCRAM-SHA-512 with username and password credentials
  • configure the Kafka AdminClient with the selected security settings while preserving unauthenticated monitoring by default
  • isolate cached AdminClient connections by authentication settings and keep passwords out of protocol diagnostics
  • document the new settings in the English and Chinese Kafka Client monitoring guides

Closes #4209

Verification

  • KafkaProtocolTest (23 tests)
  • KafkaCollectTest (7 tests)
  • YamlCheckScript through the 22-module manager reactor
  • repository Markdown lint (567 files)

Checklist

  • I have read the Contributing Guide
  • I have written the necessary doc or comment.
  • I have added the necessary unit tests and all cases have passed.

Add or update API

  • I have added the necessary e2e tests and all cases have passed.

Not applicable: this change does not add or update an API. SCRAM validation, AdminClient property mapping, credential escaping, cache isolation, and plaintext compatibility are covered by unit tests.

if (!hasSaslAuthentication()) {
return StringUtils.isNotBlank(saslMechanism)
|| StringUtils.isNotBlank(username)
|| StringUtils.isNotBlank(password);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could this cause the existing monitoring to become unavailable after the upgrade?

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

Labels

backend collector doc Improvements or additions to documentation monitoring-template

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature] Support Kafka SCRAM authentication in Kafka Client monitoring

2 participants