Update history-graph.markdown #38858
Conversation
Adds long-term statistics
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughA new section titled "Long term statistics" was added to the documentation for the history graph. This section explains how Home Assistant stores and manages statistics for sensors with specific state classes. It details the intervals and retention policies for short-term and long-term statistics, and describes how the history graph card selects which statistics to display based on the configured time range. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HistoryGraphCard
participant StatisticsStorage
User->>HistoryGraphCard: Request to display sensor history (with hours_to_show)
HistoryGraphCard->>StatisticsStorage: Query statistics data
alt hours_to_show > purge_keep period
StatisticsStorage-->>HistoryGraphCard: Return long-term statistics (hourly)
HistoryGraphCard-->>User: Display long-term statistics
else hours_to_show <= purge_keep period
StatisticsStorage-->>HistoryGraphCard: Return short-term statistics (5 min intervals, bold)
HistoryGraphCard-->>User: Display short-term statistics (bold)
end
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
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/history-graph.markdown (1)
96-101: Fix compound adjectives, punctuation, and option formatting
Line 96 (section header) and line 100 (compound adjective) should use hyphens, and line 98 needs a comma after “For short-term statistics.” Also, wrap config option names in backticks for clarity.Apply this diff:
-### Long term statistics +### Long-term statistics -Home Assistant saves long-term statistics for a sensor if the entity has a state_class of measurement, total or total_increasing. For short-term statistics a snapshot is taken every 5 minutes. For long-term statistics, an hourly aggregate is stored of the short-term statistics. Short-term statistics are automatically purged after a predefined period (default is 10 days). Long-term statistics are never purged. +Home Assistant saves long-term statistics for a sensor if the entity has a `state_class` of `measurement`, `total`, or `total_increasing`. For short-term statistics, a snapshot is taken every 5 minutes. For long-term statistics, an hourly aggregate of the short-term data is stored. Short-term statistics are automatically purged after a predefined period (default: 10 days), while long-term statistics are never purged. -In the history graph card, if the hours to show variable is set to a figure higher than the purge_keep period, long-term statistics will be used, with short term statistics shown in bold. +In the history graph card, if the `hours_to_show` option is set to a value greater than the `purge_keep` period, long-term statistics are used, and the short-term statistics are shown in bold.🧰 Tools
🪛 LanguageTool
[uncategorized] ~96-~96: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ype: string {% endconfiguration %} ### Long term statistics Home Assistant saves long-t...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~98-~98: A comma might be missing here.
Context: ...tal or total_increasing. For short-term statistics a snapshot is taken every 5 minutes. Fo...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~100-~100: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...long-term statistics will be used, with short term statistics shown in bold. ### Examples...(EN_COMPOUND_ADJECTIVE_INTERNAL)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_dashboards/history-graph.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_dashboards/history-graph.markdown
[uncategorized] ~96-~96: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ype: string {% endconfiguration %} ### Long term statistics Home Assistant saves long-t...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~98-~98: A comma might be missing here.
Context: ...tal or total_increasing. For short-term statistics a snapshot is taken every 5 minutes. Fo...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~100-~100: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...long-term statistics will be used, with short term statistics shown in bold. ### Examples...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
Adds long-term statistics
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit