docs(metrics): add METRICS_CHANGELOG.md#6730
Open
warku123 wants to merge 1 commit intotronprotocol:developfrom
Open
docs(metrics): add METRICS_CHANGELOG.md#6730warku123 wants to merge 1 commit intotronprotocol:developfrom
warku123 wants to merge 1 commit intotronprotocol:developfrom
Conversation
Add a single discovery point for Prometheus metric additions, changes, and removals so node operators and dashboard maintainers do not need to scan individual pull requests. Sectioning mirrors java-tron GitHub Releases (Notice / New Features / ... grouped by module) for consistency with the rest of the repository. The 4.8.2 section records the two metrics introduced in tronprotocol#6624 (`tron:block_transaction_count`, `tron:sr_set_change`) and a Pre-4.8.2 baseline snapshot of all metrics emitted prior to this file, so the document doubles as a quick reference catalog. Per-version provenance for baseline entries is not tracked; the file points at git log on common/src/main/java/org/tron/common/prometheus/ for that.
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
1 participant
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 does this PR do?
Adds a top-level
METRICS_CHANGELOG.mdto track Prometheus metric additions, changes, and removals in java-tron. The first version section (4.8.2) records the two metrics introduced in #6624 (tron:block_transaction_count,tron:sr_set_change). APre-4.8.2 Baselinesection follows with a one-time snapshot of all metrics already emitted prior to this file, organized by module (Core / Net / API / DB / System / JVM), so the document is useful as a quick reference rather than appearing empty. AReferencessection at the bottom links to the official metrics documentation, the tron-docker operator overview, and the reference Grafana dashboard.Why are these changes required?
There is currently no centralized place for node operators and dashboard maintainers to discover metric changes — they have to scan individual PRs or release notes. During review of #6624, @halibobo1205 suggested introducing a
METRICS_CHANGELOG.mdso future metric PRs have a standard place to record changes; this PR is the follow-up that creates that file. The format aligns with the existing java-tron GitHub Releases convention (bold version headers, module subsections), and visually with sister tronprotocol changelogs (tronweb, tronbox).This PR has been tested by:
Follow up
Update tron-docker
metric_monitor/README.mdwith the two new metrics from #6624.Extra details
git logoncommon/src/main/java/org/tron/common/prometheus/for the origin of any individual baseline metric.jvm_*/process_*metrics are auto-emitted by the Prometheus client library (simpleclient_hotspot) and are not enumerated individually — only a pointer is kept, since they are owned upstream.