Skip to content

Feature/usm client metrics enabled#2409

Open
Ishita Chourasia (ishitach) wants to merge 2 commits intomasterfrom
feature/usm-client-metrics-enabled
Open

Feature/usm client metrics enabled#2409
Ishita Chourasia (ishitach) wants to merge 2 commits intomasterfrom
feature/usm-client-metrics-enabled

Conversation

@ishitach
Copy link
Member

Description

Introduce a new Ansible variable usm_client_metrics_enabled which, when set to true, configures telemetry properties for external client metrics collection on Kafka Broker and Kafka Controller (KRaft).

This feature enables USM to collect client metrics from Confluent Platform deployments.

Fixes # https://confluentinc.atlassian.net/browse/SETU-1564

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • [x ] New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [x ] This change requires a documentation update

How Has This Been Tested?

  • EC2 instance with RHEL
  • Confluent Platform 7.9.6, 8.1.2, 8.2.0
  • Archive installation method
  • USM Agent configured with CCloud staging environment
    Testing details:

Checklist:

  • Any variable/code changes have been validated to be backwards compatible (doesn't break upgrade)
  • [x ] I have added tests that prove my fix is effective or that my feature works
  • If required, I have ensured the changes can be discovered by cp-ansible discovery codebase
  • [ x] My code follows the style guidelines of this project
  • [ x] I have commented my code, particularly in hard-to-understand areas
  • [ x] I have made corresponding changes to the documentation
  • [ x] My changes generate no new warnings
  • [ x] Any dependent changes have been merged and published in downstream modules

Files Changed

  • roles/variables/defaults/main.yml - Added usm_client_metrics_enabled variable (default: false)
  • roles/variables/vars/main.yml - Added usm_client_metrics block to kafka_controller_properties and kafka_broker_properties
  • roles/variables/tasks/main.yml - Added validation to fail if enabled for Connect
  • docs/VARIABLES.md - Added documentation for the new variable
  • docs/sample_inventories/usm_agent/README_USM_AGENT.md - Added USM Client Metrics section
  • molecule/verify_usm_client_metrics.yml - Added verify playbook for property verification

…ft Controller

- Add usm_client_metrics_enabled variable (default: false)
- Configure telemetry properties when enabled:
  - confluent.telemetry.external.client.metrics.usm.push.enabled
  - confluent.telemetry.external.client.metrics.push.enabled
  - confluent.telemetry.external.client.metrics.delta.temporality
  - confluent.telemetry.external.client.metrics.subscription.interval.ms.list
  - confluent.telemetry.external.client.metrics.subscription.metrics.list
- Add validation to reject Connect (not supported)
- Requires usm_agent to be configured
- Add molecule tests for scram-rhel scenario
- Update documentation (CHANGELOG, VARIABLES.md, README)
- Add sample inventory for USM client metrics
- Remove CHANGELOG entry (not needed for this feature)
- Simplify VARIABLES.md documentation
- Simplify README_USM_AGENT.md documentation
- Remove dedicated sample inventory file (usm_agent_client_metrics.yml)
- Remove USM tests from scram-rhel/verify.yml (not USM-specific scenario)
- Add 5th property (subscription.metrics.list) to verify_usm_client_metrics.yml
@ishitach Ishita Chourasia (ishitach) requested a review from a team as a code owner February 9, 2026 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant