Conversation
WalkthroughA new "Iceberg metrics" section has been introduced to the public metrics reference documentation. This addition documents a comprehensive set of new gauges and counters related to the Iceberg REST client and translation processes, including metrics for HTTP request tracking, error counts, data throughput, and translation outcomes. The metrics are categorized and labeled for clarity, and the update extends the documentation without altering or removing any existing content. Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
modules/reference/pages/public-metrics-reference.adoc (2)
232-520: Group and document gauge vs counter metrics more clearly
All Iceberg REST client gauges are listed first, followed by counters, but there’s no visual divider beyond the repeated---. Consider adding subsection headings (e.g., “=== Gauges” and “=== Counters”) or a brief usage note for each group to improve scannability.
522-624: Normalize label ordering and description phrasing in translation metrics
Most translation metrics list labels asredpanda_namespace, thenredpanda_topic, butredpanda_iceberg_translation_invalid_recordsplacesredpanda_causefirst. Please choose a consistent label order—e.g., primary entity first (namespace, topic) followed by cause.
Also, descriptions vary in phrasing (“Number of bytes consumed post-decompression…” vs “Number of raw, potentially compressed bytes…”). Standardize on a concise template such as “Total number of ” and consider shortening or removing parenthetical examples to keep entries uniform.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
modules/reference/pages/public-metrics-reference.adoc(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
|
|
||
| === redpanda_iceberg_rest_client_num_request_timeouts | ||
|
|
||
| Total number of catalog requests that could no longer be retried because they timed out. This may occur if the catalog is not responding. |
There was a problem hiding this comment.
I'm a bit confused about when we say "number" v when we say "total number". What is the rule for this?
There was a problem hiding this comment.
It just comes from the code, and we haven't made an effort to make them consistent yet. There are several instances, so I'd rather handle those in a separate pull request.
asimms41
left a comment
There was a problem hiding this comment.
Looks good. Just a couple of questions around consistency.
Co-authored-by: Angela Simms <102690377+asimms41@users.noreply.github.com>
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-1276
Review deadline: April 29
This pull request adds a new section to the
modules/reference/pages/public-metrics-reference.adocfile, documenting metrics related to the Iceberg REST client and Iceberg translation. These metrics provide detailed insights into HTTP requests, data processing, and error handling for the Iceberg integration.Additions to Iceberg REST client metrics:
GETandPUT), total requests, and bytes sent/received, categorized byrole.commit_table_update,create_namespace,load_table) and their failure rates.Additions to Iceberg translation metrics:
redpanda_namespaceandredpanda_topic.Page previews
Checks
Summary by CodeRabbit