transactions: add info about preventing OOM #1425
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis PR updates Redpanda transaction documentation with operational guidance. It adds two new best-practices sections to the transactions guide—one covering producer ID limits with configuration bounds and monitoring metrics, and another addressing transaction timeout configuration and coordinator-side tuning. Additionally, it refines the descriptions of Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
modules/develop/pages/transactions.adoc (2)
303-305: Add explicit anchor for transaction coordinator disk management section.The section "Manage transaction coordinator disk usage" exists at line 166 in disk-utilization.adoc, but the anchor
[[manage-transaction-coordinator-disk-usage]]is not explicitly defined. Add the anchor before the section heading to fix the broken reference:[[manage-transaction-coordinator-disk-usage]] == Manage transaction coordinator disk usage
298-302: Update line 298 xref to match the consistent format used elsewhere in the file.The reference to
max_transactions_per_coordinatoron line 298 uses an incomplete path format. Other property references in the same file (lines 275, 290) use the formatxref:reference:properties/cluster-properties.adoc#, but line 298 usesxref:reference:cluster-properties#, which is missing the/properties/path component and.adocextension. Update it to:xref:reference:properties/cluster-properties.adoc#max_transactions_per_coordinator
🧹 Nitpick comments (1)
modules/develop/pages/transactions.adoc (1)
279-281: Clarify the upper bound formula definition.The upper bound formula (
topic_partitions_per_shard×kafka_connections_max) may be ambiguous. The reasoning states it "assumes producers connect to all shards," but the mathematical interpretation could be unclear to users:
- Does this mean: (partitions per shard) × (total connections in cluster)?
- Or: For each of the (partitions per shard), multiply by the connections that might touch that partition?
Consider rephrasing to be more explicit about what this maximum represents, or provide a concrete example to illustrate the calculation.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
modules/develop/pages/transactions.adoc(1 hunks)modules/reference/pages/properties/cluster-properties.adoc(4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (4)
modules/reference/pages/properties/cluster-properties.adoc (2)
6357-6379: Cross-referenced sections match between properties.The Related topics section correctly references the same
tune-producer-id-limitsanchor and provides bidirectional cross-linking withmax_concurrent_producer_ids. This creates good navigation between related configuration concerns.
4067-4089: No issues found—cross-reference is valid and correctly anchored.The section "=== Tune producer ID limits" exists at line 273 in
modules/develop/pages/transactions.adocwith the correct auto-generated anchortune-producer-id-limits. The cross-reference in the cluster properties file will resolve correctly.modules/develop/pages/transactions.adoc (2)
287-289: No issues found. Both referenced metrics exist ininternal-metrics-reference.adocwith matching anchor definitions. The xref links will resolve correctly.
273-307: No action required—anchor reference is correctly structured.The section
=== Tune producer ID limitsat line 273 in transactions.adoc will automatically generate the anchortune-producer-id-limits, which matches the cross-reference from cluster-properties.adoc at lines 4071, 4085, and 6377. The xref syntax is correct and will resolve properly without requiring an explicit anchor directive.
|
Not sure how many self-hosted customers set kafka_connections_max Even if they do ...there can be cases where clients do not efficiently use producer-ids .. generating more producer-ids than there are connections.../never re-used... (such as flink in wiki example) .. So it might be worth having some notes on best practices regarding client apps and producer-ids Additionally.. transactional_id_expiration_ms is worth mentioning . the default is 7 days... which is way more than most transactions are typically open for.. and setting that to a sane value can help in this area too.. |
Description
Resolves https://redpandadata.atlassian.net/browse/DOCS-1758
Review deadline: Oct 31st
Related code PR redpanda-data/redpanda#28233
Page previews
Transactions - tune producer ID limits
max_concurrent_producer_ids reference
transactional_id_expiration_ms reference
Checks