Skip to content

Docs: document cursor persist truncation OpenTelemetry metrics#1118

Merged
lhotari merged 2 commits intoapache:mainfrom
ng-galien:docs/cursor-persist-truncation-metrics
Apr 21, 2026
Merged

Docs: document cursor persist truncation OpenTelemetry metrics#1118
lhotari merged 2 commits intoapache:mainfrom
ng-galien:docs/cursor-persist-truncation-metrics

Conversation

@ng-galien
Copy link
Copy Markdown
Contributor

@ng-galien ng-galien commented Apr 18, 2026

✅ Contribution Checklist

  • I read the contribution guide
  • I updated the versioned docs — not applicable, these metrics are new and only exist on master (not in any released version yet).

Summary

Document two new OpenTelemetry counters introduced in apache/pulsar#25548:

  • pulsar.broker.managed_ledger.cursor.persist.unacked_ranges.truncated — emitted when a cursor exceeds managedLedgerMaxUnackedRangesToPersist and ack state is truncated at persistence.
  • pulsar.broker.managed_ledger.cursor.persist.batch_deleted_indexes.truncated — emitted when a cursor exceeds managedLedgerMaxBatchDeletedIndexToPersist and batch deleted index state is truncated at persistence.

Both counters are tagged with the cursor's standard attributes (pulsar.namespace, pulsar.managed_ledger.name, pulsar.managed_ledger.cursor.name) — the same set used by the other cursor metrics in this section.

Added under the existing ### Managed Ledger Cursor metrics section of reference-metrics-opentelemetry.md, following the format used by the surrounding metrics in that section.

See apache/pulsar#25548.

After review on apache/pulsar#25548, the two new counters emit the
cursor's standard attribute set (pulsar.namespace, pulsar.managed_ledger.name,
pulsar.managed_ledger.cursor.name) instead of custom managedLedger/cursor
keys. Update the reference doc to match.

See apache/pulsar#25548.
@ng-galien
Copy link
Copy Markdown
Contributor Author

hi @lhotari, I've updated the doc according the code in the broker repo.

Copy link
Copy Markdown
Member

@lhotari lhotari left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lhotari lhotari merged commit 54df315 into apache:main Apr 21, 2026
2 checks passed
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.

2 participants