docs: clarify data retention metrics units and calculation details#476
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Data Retention documentation to clarify metric units and the exact calculations used when emitting Prometheus metrics, aligning the docs with the current DataRetentionService implementation.
Changes:
- Clarifies that
dataSetChallengeStatusis incremented in challenges (period delta × 5) while baselines are stored in proving periods. - Renames and documents the overdue gauge as
pdp_provider_estimated_overdue_periods, including unit details and overflow behavior. - Adds/expands explanations for provider selection, overdue-period estimation, and delta handling.
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 | Updates metric definitions for data retention, including units and the overdue gauge name. |
| docs/checks/data-retention.md | Expands the Data Retention check documentation to describe units, delta→challenge conversion, provider selection, and gauge semantics. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
BigLep
approved these changes
Apr 24, 2026
github-project-automation
Bot
moved this from 📌 Triage
to ✔️ Approved by reviewer
in FOC
SgtPooki
approved these changes
Apr 27, 2026
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.
#438 (comment)