Skip to content

Commit c29e0d4

Browse files
matschafferjbaiera
andauthored
Upgrade documentation for xpack.monitoring.history.duration (#82295) (#82920)
* Upgrade documentation for xpack.monitoring.history.duration * A few updates now that #82498 has been opened with a concrete policy. * Grammar fix * Update docs/reference/migration/migrate_8_0/cluster-node-setting-changes.asciidoc Co-authored-by: James Baiera <james.baiera@gmail.com> Co-authored-by: James Baiera <james.baiera@gmail.com> Co-authored-by: James Baiera <james.baiera@gmail.com>
1 parent 0a92222 commit c29e0d4

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/reference/migration/migrate_8_0/cluster-node-setting-changes.asciidoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -907,3 +907,29 @@ will continue to use that configured value.
907907
Any node that did not have an explicitly configured password hashing algorithm in
908908
{es} 6.x or {es} 7.x would have failed to start.
909909
====
910+
911+
//tag::notable-breaking-changes[]
912+
.The `xpack.monitoring.history.duration` will not delete indices created by metricbeat or elastic agent
913+
[%collapsible]
914+
====
915+
*Details* +
916+
917+
Prior to 8.0, Elasticsearch would internally handle removal of all monitoring indices according to the
918+
`xpack.monitoring.history.duration` setting.
919+
920+
When using metricbeat or elastic agent >= 8.0 to collect monitoring data, indices are managed via an ILM policy. If the setting is present, the policy will be created using the `xpack.monitoring.history.duration` as an initial retention period.
921+
922+
If you need to customize retention settings for monitoring data collected with metricbeat, please update the `.monitoring-8-ilm-policy` ILM policy directly.
923+
924+
The `xpack.monitoring.history.duration` setting will only apply to monitoring indices written using (legacy) internal
925+
collection, not indices created by metricbeat or agent.
926+
927+
*Impact* +
928+
After upgrading, insure that the `.monitoring-8-ilm-policy` ILM policy aligns with your desired retention settings.
929+
930+
If you only use
931+
metricbeat or agent to collect monitoring data, you can also remove any custom `xpack.monitoring.history.duration`
932+
settings.
933+
934+
====
935+
// end::notable-breaking-changes[]

0 commit comments

Comments
 (0)