docs(help): add push style monitor help documentation (#1795) - #4321
Merged
Conversation
paultanay
marked this pull request as ready for review
August 16, 2026 13:58
Aias00
previously approved these changes
Aug 17, 2026
Aias00
left a comment
Contributor
There was a problem hiding this comment.
Review: docs(help): add push style monitor help documentation (#1795)
Verdict: ✅ APPROVED — documentation-only change, accurate and well structured.
What this PR does
- Adds
home/docs/help/push.md(English) and the matchinghome/i18n/zh-cn/.../help/push.md(Chinese) describing HertzBeat's push-style (Prometheus-format) monitoring. - Registers
help/pushinhome/sidebars.json(and correctly adds the missing trailing comma afterhelp/jenkins).
Assessment
- Content quality: The doc is clear, internally consistent, and covers How-It-Works, endpoint, metrics format, config params, and three language examples (curl/Python/Java) plus a troubleshooting section. EN/ZH parity is good.
- Structural correctness:
sidebars.jsonedit is valid JSON; the new doc idpushmatches the sidebar reference. - Risk: None — pure docs, no code path touched.
Minor (non-blocking) suggestions
- The endpoint path
POST /api/push/prometheus/job/{job}/instance/{instance}should be confirmed against the actual push controller (not verifiable from this docs-only PR). If the real path differs, both docs would need a fix. Consider cross-linking to the API reference once merged. job/instanceare documented as[a-zA-Z0-9_]only — worth double-checking this matches the server-side route regex so the "Common Problems" tip is accurate.
No code changes requested. Good contribution.
Contributor
|
thx for your contributon, pls fix ci |
Contributor
|
failed again, pls fix. |
Contributor
Author
Identifying the issue. I will let you know when it's done |
Contributor
Author
|
Ci passed locally, clould you please check now @Aias00 |
Aias00
approved these changes
Aug 17, 2026
Aias00
left a comment
Contributor
There was a problem hiding this comment.
LGTM, thx for your contribution~
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
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.
What's changed?
Added English and Chinese help documentation for the Push Style Monitor (
app-push), which was missing from the docs despite the feature being fully implemented.home/docs/help/push.md— English doc covering how push works, the correct API endpoint, Prometheus text format, shell/Python/Java examples, and common problemshome/i18n/zh-cn/.../help/push.md— Chinese translationhome/sidebars.json— registeredhelp/pushunder theservicecategoryPart of #1795
Checklist
Add or update API