docs: improve metrics docs structure and clarity#583
Merged
Conversation
Document cidContactVerification metric, separate cid.contact sub-status, and ipniVerifyMs timer semantics for the two-stage indexer checks. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Clarify ipniVerifyMs labels, cidContactVerification skipped emission, timer anchors on ipniVerificationStart, and source citations. Co-authored-by: Cursor <cursoragent@cursor.com>
3 tasks
…581) * docs(checks): resolve cid.contact verification design from PR review Document cidContactVerification metric, separate cid.contact sub-status, and ipniVerifyMs timer semantics for the two-stage indexer checks. Co-authored-by: Cursor <cursoragent@cursor.com> * docs(checks): link pullCheckStatus values to pull-check spec Co-authored-by: Cursor <cursoragent@cursor.com> * docs(checks): address PR review on cid.contact metrics docs Clarify ipniVerifyMs labels, cidContactVerification skipped emission, timer anchors on ipniVerificationStart, and source citations. Co-authored-by: Cursor <cursoragent@cursor.com> * docs: split #581 * moved to another pr * docs: remove pending cidContactVerification state --------- Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: silent-cipher <puspendramahariya@gmail.com>
Base automatically changed from
biglep/check-cid-contact-docs
to
feat/check-cid-contact
May 29, 2026 12:31
Contributor
There was a problem hiding this comment.
Pull request overview
Docs-only PR that restructures and clarifies the metrics documentation for the dealbot checks. It removes a redundant column, adds explicit columns/notes for counter semantics, fixes a typo, and replaces raw type-source links with a prose explanation of where Prometheus outcome strings come from versus internal entity states.
Changes:
events-and-metrics.md: rename "Status Count Related Metrics" → "Count Related Metrics", fix "additonal" typo, add a note about the confusingvaluelabel, addAdditional InfoandCounter Valuecolumns, and splitpdp_provider_estimated_overdue_periodsinto a new "Other Gauges" section.data-storage.md: drop the always-"Yes"Implemented?column from the assertions table, and replace the baretypes.tssource links with a prose explanation distinguishing Prometheus outcome strings (fromcheck-metrics.service.ts/classifyFailureStatus) from coarserDealStatus/IpniStatusentity states.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/checks/events-and-metrics.md | Restructures count metrics table, adds value-label note, and splits gauge out into its own section. |
| docs/checks/data-storage.md | Removes the Implemented? column and rewrites the status-sources prose. |
BigLep
approved these changes
May 29, 2026
Contributor
|
@silent-cipher anything blocking merging this? |
Collaborator
Author
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.
Major changes
docs/checks/data-storage.mdImplemented?column from the assertions table — all assertions are implemented, so the column added noise without value.types.tsat the bottom of the status section with a richer prose explanation clarifying that Prometheus outcome strings come fromheck-metrics.service.ts/classifyFailureStatus, and thatDealStatus/IpniStatusare coarserimplementation-level states, not the dashboard value labels.
docs/checks/events-and-metrics.mdperiod_delta × 5).pdp_provider_estimated_overdue_periodsout of the count metrics table into a new "Other Gauges" section, since it's a gauge (level measurement), not a counter — it doesn't use the value outcome label.Changes from #581