Skip to content

docs: improve metrics docs structure and clarity#583

Merged
silent-cipher merged 17 commits into
mainfrom
biglep/docs-metrics-cleanup
Jun 3, 2026
Merged

docs: improve metrics docs structure and clarity#583
silent-cipher merged 17 commits into
mainfrom
biglep/docs-metrics-cleanup

Conversation

@silent-cipher
Copy link
Copy Markdown
Collaborator

@silent-cipher silent-cipher commented May 29, 2026

Major changes

  • docs/checks/data-storage.md

    • Removed the Implemented? column from the assertions table — all assertions are implemented, so the column added noise without value.
    • Replaced the bare source links to types.ts at the bottom of the status section with a richer prose explanation clarifying that Prometheus outcome strings come from heck-metrics.service.ts / classifyFailureStatus, and that DealStatus/IpniStatus are coarser
      implementation-level states, not the dashboard value labels.
  • docs/checks/events-and-metrics.md

    • Renamed "Status Count Related Metrics" → "Count Related Metrics" (more accurate since it includes non-status counts).
    • Fixed a typo: "additonal" → "additional".
    • Added an explanatory note clarifying that the value label is confusingly named (should have been called status) and how this manifests in ClickHouse queries (label('value') and value_avg).
    • Added a Counter Value and Additional Info column to the count metrics table, making the semantics of each counter explicit (most emit 1, with dataSetChallengeStatus being the notable exception: it emits period_delta × 5).
    • Split pdp_provider_estimated_overdue_periods out 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

silent-cipher and others added 6 commits May 28, 2026 12:09
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>
silent-cipher and others added 4 commits May 29, 2026 17:38
…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
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 confusing value label, add Additional Info and Counter Value columns, and split pdp_provider_estimated_overdue_periods into a new "Other Gauges" section.
  • data-storage.md: drop the always-"Yes" Implemented? column from the assertions table, and replace the bare types.ts source links with a prose explanation distinguishing Prometheus outcome strings (from check-metrics.service.ts / classifyFailureStatus) from coarser DealStatus/IpniStatus entity 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.

Comment thread docs/checks/events-and-metrics.md Outdated
@github-project-automation github-project-automation Bot moved this from 📌 Triage to ✔️ Approved by reviewer in FOC May 29, 2026
@rjan90
Copy link
Copy Markdown
Contributor

rjan90 commented Jun 1, 2026

@silent-cipher anything blocking merging this?

@silent-cipher
Copy link
Copy Markdown
Collaborator Author

This is built on top of #580 . So, thought It would be better to merge it once #580 is approved.

Base automatically changed from feat/check-cid-contact to main June 2, 2026 13:32
@silent-cipher silent-cipher merged commit 45f6a60 into main Jun 3, 2026
9 checks passed
@silent-cipher silent-cipher deleted the biglep/docs-metrics-cleanup branch June 3, 2026 05:33
@github-project-automation github-project-automation Bot moved this from ✔️ Approved by reviewer to 🎉 Done in FOC Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 🎉 Done

Development

Successfully merging this pull request may close these issues.

5 participants