Skip to content

docs: add upgrade observability checklist#1144

Open
Annaxs wants to merge 1 commit into
apache:mainfrom
Annaxs:docs/upgrade-observability-checklist
Open

docs: add upgrade observability checklist#1144
Annaxs wants to merge 1 commit into
apache:mainfrom
Annaxs:docs/upgrade-observability-checklist

Conversation

@Annaxs
Copy link
Copy Markdown
Contributor

@Annaxs Annaxs commented May 11, 2026

Motivation

There is currently no documentation covering what operators should monitor during and after a Pulsar cluster upgrade. This gap means teams either rely on tribal knowledge or discover issues after they've impacted production traffic.

Changes

Adds a new page administration-upgrade-observability.md with:

  • Pre-upgrade baseline guidance — which metrics to record before starting
  • Per-component monitoring — what to watch during ZooKeeper, BookKeeper, broker, and proxy rolling upgrades (GC pause duration, ledger write latency, topic ownership rebalance, bookie disk pressure, client reconnect behaviour)
  • Post-upgrade validation checklist — CLI commands and metric thresholds to confirm cluster health
  • Rollback decision criteria — specific, actionable conditions that should trigger a rollback

The page is added to the sidebar under the existing Administration section, immediately after the Upgrade Guide.

Verifying this change

The new page renders correctly and links to the existing Upgrade Guide, Monitoring, and Reference Metrics pages.


Related discussion: Apache Pulsar Slack – #dev, May 2026

Adds a new page covering metrics to monitor during and after a Pulsar
cluster upgrade, including:
- Pre-upgrade baseline guidance
- Per-component metrics to watch (ZooKeeper, BookKeeper, brokers, proxies)
- Post-upgrade validation checklist
- Rollback decision criteria

Closes: N/A
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.

1 participant