Skip to content

docs(pd): document per-store state and leader count gauges - #531

Merged
imbajin merged 1 commit into
apache:masterfrom
arshilkxwork:docs/pd-store-state-metrics
Oct 17, 2026
Merged

imbajin merged 1 commit into
apache:masterfrom
arshilkxwork:docs/pd-store-state-metrics

Conversation

@arshilkxwork

@arshilkxwork arshilkxwork commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Docs for apache/hugegraph#3357 (apache/hugegraph#3357), which adds two per-store gauges to PD's /actuator/prometheus.

Updated in both EN and CN, in quickstart/hugegraph/hugegraph-pd.md, as a paragraph after the one that lists PD's hg_* meters:

  • hg_store_state{store,state} is 1 for the store's current state and 0 for the other five.
  • hg_store_leader_count{store} counts the shard groups whose leader is on the store.

The paragraph says the gauges exist only in versions after 1.7.0, and that every PD member reports the same values, so readers should select one instance before aggregating.

The text matches apache/hugegraph#3357 at 1ae51c9. This should merge after that PR, since no released PD exports these gauges yet.

I ran git diff --check. I did not build the site locally.

PD exports hg_store_state{store,state} and hg_store_leader_count{store}
on /actuator/prometheus from apache/hugegraph#3357. List them on the PD
quickstart page, EN and CN, next to the other hg_* meters.

@imbajin imbajin left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Blocking: no. Summary: The English and Chinese quickstart pages accurately document the per-store state and leader-count gauges added by merged #3357. Evidence: Static comparison of #531 at 5612f7a with #3357 merged at 1ae51c92da89176b8c838c08116a453ba51b2323. Score: 9/10

@imbajin
imbajin merged commit dd0693f into apache:master Oct 17, 2026
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