Skip to content

docs(metrics): catalogue the DSX leak-alert counter#3765

Closed
chet wants to merge 1 commit into
NVIDIA:mainfrom
chet:gh-issue-3733-docs
Closed

docs(metrics): catalogue the DSX leak-alert counter#3765
chet wants to merge 1 commit into
NVIDIA:mainfrom
chet:gh-issue-3733-docs

Conversation

@chet

@chet chet commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

This is the documentation half of #3742.

Add carbide_dsx_exchange_consumer_alerts_detected_total to the core metrics catalogue with the counter kind and HELP text declared by LeakAlertDetected. The catalogue accepts future rows, so this can land before the Event migration without weakening check-metric-docs.

Related issues

Type of Change

  • Add - New feature or capability
  • Change - Changes in existing functionality
  • Fix - Bug fixes
  • Remove - Removed features or deprecated functionality
  • Internal - Internal changes (refactoring, tests, docs, etc.)

Breaking Changes

  • This PR contains breaking changes

Testing

  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing performed
  • No testing required (docs, internal refactor, etc.)

Verified with:

  • cargo xtask check-metric-docs
  • cargo make format-nightly
  • git diff --check

Additional Notes

This docs PR should merge before #3742. The code PR can then update from main and satisfy the metric-catalogue gate without including a docs/ change.

This is the documentation half of NVIDIA#3742.

Add `carbide_dsx_exchange_consumer_alerts_detected_total` to the core metrics catalogue with the counter kind and HELP text declared by `LeakAlertDetected`. The catalogue accepts future rows, so this can land before the Event migration without weakening `check-metric-docs`.

This supports NVIDIA#3733

Signed-off-by: Chet Nichols III <chetn@nvidia.com>
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 59b2170f-feea-4547-96db-64b48d9a0944

📥 Commits

Reviewing files that changed from the base of the PR and between 4ad44c6 and 14a940c.

📒 Files selected for processing (1)
  • docs/observability/core_metrics.md

Summary by CodeRabbit

  • Documentation
    • Added documentation for the leak alerts detected metric, including its counter type and meaning.

Walkthrough

The NICo core metrics documentation adds the carbide_dsx_exchange_consumer_alerts_detected_total counter and describes its leak-alert detection count.

Changes

Core metrics documentation

Layer / File(s) Summary
Document leak-alert counter
docs/observability/core_metrics.md
Adds the carbide_dsx_exchange_consumer_alerts_detected_total counter and documents that it counts detected leak alerts.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the new DSX leak-alert counter documentation entry.
Description check ✅ Passed The description is clearly aligned with the docs-only metric catalogue update and its purpose.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown

chet commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

@coderabbitai full_review, thanks!

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

@chet: Starting a fresh, comprehensive review of the PR. 🐇

✅ Action performed

Full review finished.

@chet chet closed this Jul 21, 2026
@chet
chet deleted the gh-issue-3733-docs branch July 21, 2026 15:54
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.

1 participant