[SETU-2783] Raise USM catalog snapshot size limit and exporter request timeout#2495
Open
Varun PV (varunpv) wants to merge 3 commits into
Open
[SETU-2783] Raise USM catalog snapshot size limit and exporter request timeout#2495Varun PV (varunpv) wants to merge 3 commits into
Varun PV (varunpv) wants to merge 3 commits into
Conversation
…t timeout Raise the catalog collector's per-snapshot byte cap from the 850 KB default to 50 MB, and align the USM HTTP exporter request timeout to the AHC readTimeout default of 60 s. * Controller `usm_agent_telemetry` block: add all three keys (`_usm.client.request.timeout.ms=60000`, `_usm.events.client.request.timeout.ms=60000`, `catalog.collector.max.bytes.per.snapshot=52428800`). * Broker `usm_agent_telemetry` block: add `_usm.client.request.timeout.ms=60000` unconditionally. * Broker `usm_agent_telemetry_zk_mode` (new block, gated on `not kraft_enabled`): add `_usm.events.client.request.timeout.ms=60000` and `catalog.collector.max.bytes.per.snapshot=52428800`. Mirrors CFK's broker `IsZookeeperMode` block — the broker hosts the catalog collector and events exporter only when running in ZK mode. Test coverage: new `molecule/verify_usm_catalog_and_timeout.yml` uses the canonical `confluent.test/check_property.yml` task to assert each key against rendered `server.properties`. Imported by `scram-rhel`, `oauth-plain-rhel`, and `oauth-rbac-plain-rhel8` scenarios (already USM-enabled per their existing `verify_usm_client_metrics.yml` import). Gated on `'usm_agent' in groups` everywhere; non-USM deployments are unchanged. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the cp-ansible USM Kafka configuration to prevent large catalog snapshots from being dropped and to align USM HTTP exporter request timeouts with the AHC default read timeout.
Changes:
- Set
confluent.catalog.collector.max.bytes.per.snapshotto 50 MB for controller (and broker in ZK mode). - Set
_usm.client.request.timeout.ms/_usm.events.client.request.timeout.msto 60s for relevant roles. - Add a new Molecule verify playbook and wire it into existing USM-focused scenarios.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| roles/variables/vars/main.yml | Adds/adjusts Kafka controller and broker USM-related properties, including a new ZK-only broker block. |
| molecule/verify_usm_catalog_and_timeout.yml | New Molecule verification playbook asserting the new properties in rendered server.properties. |
| molecule/scram-rhel/verify.yml | Imports the new verification playbook into the scenario. |
| molecule/oauth-rbac-plain-rhel8/verify.yml | Imports the new verification playbook into the scenario. |
| molecule/oauth-plain-rhel/verify.yml | Imports the new verification playbook into the scenario. |
Comments suppressed due to low confidence (1)
molecule/verify_usm_catalog_and_timeout.yml:82
- Same issue as above: use
not (kraft_enabled|bool)to avoid incorrect condition evaluation whenkraft_enabledis provided as a string via extra vars.
when:
- "'usm_agent' in groups"
- not kraft_enabled
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| confluent.consumer.group.status.enabled: "true" | ||
| confluent.consumer.lag.calculator.empty.lag.retention.ms: 86400000 | ||
| usm_agent_telemetry_zk_mode: | ||
| enabled: "{{ 'usm_agent' in groups and not kraft_enabled }}" |
Comment on lines
+68
to
+71
| when: | ||
| - "'usm_agent' in groups" | ||
| - not kraft_enabled | ||
|
|
master and 8.1.x/8.2.x/8.3.x are KRaft-only; ZK-mode broker keys only apply on 7.9.x (handled in a separate backport PR). Also dropping the new molecule verify playbook per scope clarification — the property plumbing on master is just the controller and the unconditional broker `_usm.client.request.timeout.ms`. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Tests dropped from this PR per scope clarification. Reverts the verify_usm_catalog_and_timeout.yml imports added in the first commit to scram-rhel, oauth-plain-rhel, and oauth-rbac-plain-rhel8. Net result: this PR is just the vars/main.yml change. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Member
mansi sinha (mansisinha)
left a comment
mansi sinha (mansisinha)
left a comment
There was a problem hiding this comment.
This PR should be raised against branch 8.1.x if we want to patch this config in all kafka versions for usm. Post merge to 8.1.x, pint merge has to be performed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
confluent.catalog.collector.max.bytes.per.snapshotfrom the 850 KB default to 50 MB on the kafka_controllerusm_agent_telemetryblock (KRaft mode hosts the catalog collector on the controller).confluent.telemetry.exporter._usm.client.request.timeout.msto 60 s on both controller and broker; sets_usm.events.client.request.timeout.msto 60 s on the controller. The 60 s value aligns the USM HTTP exporter request timeout with the AHCreadTimeoutdefault of 60 s.usm_agent_telemetry_zk_modeblock holding the events-timeout and max-bytes keys.'usm_agent' in groupscheck; non-USM deployments are unchanged.Jira: SETU-2783. Companion CFK PR: confluentinc/confluent-operator#4312.
Test plan
🤖 Generated with Claude Code