[docs] Document the OpenTelemetry metrics of the message position find by timestamp - #1236
Merged
Merged
Conversation
…d by timestamp Document the pulsar.broker.message.find.* metrics added in apache/pulsar#26751: the duration of a find by timestamp (subscription seek / reset-cursor, message TTL), and the entries and bytes it reads, by storage (BookKeeper or tiered storage). Assisted-by: Claude Code (Claude Opus 5.5) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2 tasks done
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
2 participants
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.
Documents the
pulsar.broker.message.find.*OpenTelemetry metrics added in apache/pulsar#26751, as announced in that PR.A new "Message Find Metrics" section at the end of the broker metrics describes:
pulsar.broker.message.find.duration: the time taken to find the position of a message by timestamp, by reason (seek,expiry) and result (found,not_found,failure).pulsar.broker.message.find.entry.read.countandpulsar.broker.message.find.entry.read.size: the entries and bytes read by the search, by reason and by the storage the ledger of the entry is read from (bookkeeper,offloaded).It also states what is measured (a cursor reset to a timestamp and the message TTL lookups, not the
get-message-idadmin operation), that the metrics are per broker rather than per topic, and that entries served from the broker entry cache are included.The metrics ship in Pulsar 5.0, which is not released yet, so the same section is added to
docs/and toversioned_docs/version-5.0.x/.✅ Contribution Checklist
🤖 Generated with Claude Code