elasticsearch/docs/reference/settings
Lee Hinman 5adbf67c08
Add ILM histore store index (#50287)
* Add ILM histore store index

This commit adds an ILM history store that tracks the lifecycle
execution state as an index progresses through its ILM policy. ILM
history documents store output similar to what the ILM explain API
returns.

An example document with ALL fields (not all documents will have all
fields) would look like:

```json
{
  "@timestamp": 1203012389,
  "policy": "my-ilm-policy",
  "index": "index-2019.1.1-000023",
  "index_age":123120,
  "success": true,
  "state": {
    "phase": "warm",
    "action": "allocate",
    "step": "ERROR",
    "failed_step": "update-settings",
    "is_auto-retryable_error": true,
    "creation_date": 12389012039,
    "phase_time": 12908389120,
    "action_time": 1283901209,
    "step_time": 123904107140,
    "phase_definition": "{\"policy\":\"ilm-history-ilm-policy\",\"phase_definition\":{\"min_age\":\"0ms\",\"actions\":{\"rollover\":{\"max_size\":\"50gb\",\"max_age\":\"30d\"}}},\"version\":1,\"modified_date_in_millis\":1576517253463}",
    "step_info": "{... etc step info here as json ...}"
  },
  "error_details": "java.lang.RuntimeException: etc\n\tcaused by:etc etc etc full stacktrace"
}
```

These documents go into the `ilm-history-1-00000N` index to provide an
audit trail of the operations ILM has performed.

This history storage is enabled by default but can be disabled by setting
`index.lifecycle.history_index_enabled` to `false.`

Resolves #49180
2019-12-18 16:09:59 -07:00
..
images [DOCS] Moves X-Pack settings to docs folder (#31120) 2018-06-06 10:05:32 -07:00
audit-settings.asciidoc [DOCS] Rename auditing topic. Closes #49012 (#49013) 2019-11-13 18:30:11 -08:00
ccr-settings.asciidoc [DOCS] Cleans up links to security content (#47610) 2019-10-04 16:10:26 -07:00
data-frames-settings.asciidoc [Transform]rename classes in transform plugin (#46784) 2019-09-19 12:25:46 +02:00
ilm-settings.asciidoc Add ILM histore store index (#50287) 2019-12-18 16:09:59 -07:00
license-settings.asciidoc [DOCS] Removes X-Pack settings section (#39870) 2019-03-14 14:22:06 -07:00
ml-settings.asciidoc [DOCS] Move anomaly detection job resource definitions into APIs (#49700) 2019-12-06 15:32:07 -08:00
monitoring-settings.asciidoc [DOCS] Cleans up links to security content (#47610) 2019-10-04 16:10:26 -07:00
notification-settings.asciidoc [DOCS] Moves Watcher content into Elasticsearch book (#47147) 2019-09-27 16:05:44 -07:00
security-hash-settings.asciidoc [DOCS] Add configurable password hashing docs (#32849) 2018-08-21 12:05:42 +03:00
security-settings.asciidoc [DOCS] Removes realm type security setting (#50001) 2019-12-10 08:03:43 -08:00
sql-settings.asciidoc [DOCS] Removes X-Pack settings section (#39870) 2019-03-14 14:22:06 -07:00
ssl-settings.asciidoc [DOCS] Remove unneeded ifdef::asciidoctor[] conditionals (#42758) 2019-05-31 11:04:30 -04:00