Commit e313413
Document 120-day default retention period for ML jobs in log anomalies and log categories (#3499)
## Summary
This PR updates the documentation to reflect the new default retention
period of 120 days for ML results in the predefined ML configurations
for logs that power the log anomalies and log categories pages,
introduced in version 9.2.
## Context
Following the changes introduced in
elastic/kibana#231080, the predefined ML
configurations for logs now set a default retention period of 120 days
for ML results, where previously there was no default retention period
(results were retained indefinitely).
## Changes
Added concise notes in active voice to three documentation files, with
version-specific tags:
1. **`solutions/observability/logs/inspect-log-anomalies.md`**
- Added a note in the "Enable log rate analysis and anomaly detection"
section
- Informs users that log anomaly ML jobs retain results for 120 days by
default
- Includes `:applies_to: stack: ga 9.2` tag
2. **`solutions/observability/logs/categorize-log-entries.md`**
- Added a note in the "Create log categories" section
- Informs users that log categorization ML jobs retain results for 120
days by default
- Includes `:applies_to: stack: ga 9.2` tag
3.
**`explore-analyze/machine-learning/anomaly-detection/anomaly-detection-scale.md`**
- Updated the "Optimize the results retention" section
- Clarified that while anomaly detection results are retained
indefinitely by default, predefined ML configurations for logs are an
exception with 120-day retention (from version 9.2)
- Includes inline `{applies_to}`stack: ga 9.2`` tag
Each note:
- States the 120-day default retention period
- Explains how to customize the retention period via the
`results_retention_days` setting
- Clearly indicates this feature is available from version 9.2 onwards
## Impact
- **Target release**: 9.2
- **Documentation sets affected**: Elastic On-Prem and Cloud (all)
- **User benefit**: Users are now informed about the automatic cleanup
of older ML results, helping them understand storage management and plan
accordingly. Version-specific tags ensure users understand when this
feature became available.
## Related
- Kibana PR: elastic/kibana#231080
- Contact: @gbamparop
Fixes #2476
<!-- START COPILOT CODING AGENT SUFFIX -->
<details>
<summary>Original prompt</summary>
>
> ----
>
> *This section details on the original issue you should resolve*
>
> <issue_title>[Internal]: Setting a default retention period for the ML
results for the jobs enabling log anomalies and log
categories</issue_title>
> <issue_description>### Description
>
> The predefined ML modules for logs that power the log anomalies and
log categories pages didn't set a default retention period for the ML
results, this will be updated to a default retention of 120 days.
>
> ### Resources
>
> - elastic/kibana#231080
>
> ### Which documentation set does this change impact?
>
> Elastic On-Prem and Cloud (all)
>
> ### Feature differences
>
> There was no default retention period before and it will be set to 120
days.
>
> ### What release is this request related to?
> 9.2
>
> ### Serverless release
> Date TBD
>
> ### Collaboration model
>
> The documentation team
>
> ### Point of contact.
>
> **Main contact:**
> - @gbamparop
> </issue_description>
>
> <agent_instructions>A simple note should suffice where relevant.
Updates are probably focused in the following parts of the
documentation:
https://github.com/elastic/docs-content/tree/main/solutions/observability/logs
and/or
https://github.com/elastic/docs-content/tree/main/explore-analyze/machine-learning</agent_instructions>
>
> ## Comments on the Issue (you are @copilot in this section)
>
> <comments>
> </comments>
>
</details>
Fixes #2476
<!-- START COPILOT CODING AGENT TIPS -->
---
✨ Let Copilot coding agent [set things up for
you](https://github.com/elastic/docs-content/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot)
— coding agent works faster and does higher quality work when set up for
your repo.
---------
Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: florent-leborgne <[email protected]>
Co-authored-by: florent-leborgne <[email protected]>1 parent a82aa03 commit e313413
File tree
3 files changed
+13
-1
lines changed- explore-analyze/machine-learning/anomaly-detection
- solutions/observability/logs
3 files changed
+13
-1
lines changedLines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
100 | 100 | | |
101 | 101 | | |
102 | 102 | | |
103 | | - | |
| 103 | + | |
104 | 104 | | |
105 | 105 | | |
106 | 106 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
30 | 36 | | |
31 | 37 | | |
32 | 38 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
35 | 41 | | |
36 | 42 | | |
37 | 43 | | |
| |||
0 commit comments