Update statistics-graph.markdown #38859
Merged
Conversation
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
Clarify which sensors support long-term statistics
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for statistics gathering and retention was updated to clarify that statistics are collected every 5 minutes and hourly only for sensors with a Changes
Sequence Diagram(s)No sequence diagram is generated as the change is limited to documentation clarification. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_dashboards/statistics-graph.markdown (1)
25-25: Improve clarity and punctuation in statistics description
- Add an Oxford comma: change
measurement, total or total_increasing→measurement, total, or total_increasing.- Simplify phrasing: replace “every 5 minutes and also hourly” with “every 5 minutes and hourly”.
- Break the last sentence into two for better readability:
- For sensors: record the
<abbr title="Minimum">min</abbr>,<abbr title="Maximum">max</abbr>, and<abbr title="Average">mean</abbr>values each hour.- For metered entities: record the
<abbr title="Total">sum</abbr>.Proposed diff:
-Statistics are gathered every 5 minutes and also hourly for sensors with a state_class of measurement, total or total_increasing. The 5-minute statistics will be retained for the duration set in the [recorder configuration](/integrations/recorder/#purge_keep_days), and hourly statistics will be retained indefinitely. It will either keep the <abbr title="Minimum">`min`</abbr>, <abbr title="Maximum">`max`</abbr>, and <abbr title="Average">`mean`</abbr> of a sensor's value for a specific hour or the <abbr title="Total">`sum`</abbr> for a metered entity. +Statistics are gathered every 5 minutes and hourly for sensors with a `state_class` of `measurement`, `total`, or `total_increasing`. The 5-minute statistics are retained for the duration set in the [recorder configuration](/integrations/recorder/#purge_keep_days), and hourly statistics are retained indefinitely. + +For sensors, the <abbr title="Minimum">`min`</abbr>, <abbr title="Maximum">`max`</abbr>, and <abbr title="Average">`mean`</abbr> values are recorded each hour. For metered entities, the <abbr title="Total">`sum`</abbr> is recorded.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_dashboards/statistics-graph.markdown(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_dashboards/statistics-graph.markdown (1)
25-25: Verify recorder configuration link anchorPlease confirm that the fragment
#purge_keep_dayscorrectly matches the recorder integration’s documentation anchor. It might be#purge-keep-daysinstead.
c0ffeeca7
approved these changes
May 5, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Clarify which sensors support long-term statistics
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
measurement,total, ortotal_increasing). Retention details and types of statistics remain unchanged.