elasticsearch/docs/reference
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
..
aggregations [DOCS] Move transform resource definitions into APIs (#50108) 2019-12-17 09:01:31 -08:00
analysis [DOCS] Reformat token count limit filter docs (#49835) 2019-12-13 08:43:35 -05:00
cat
ccr Update remote cluster stats to support simple mode (#49961) 2019-12-13 09:16:53 -07:00
cluster [DOCS] Document `thread_pool` node stats (#50330) 2019-12-18 16:57:38 -05:00
commands
docs
graph
high-availability
how-to [DOCS] Add identifier mapping tip to numeric and keyword datatype docs (#49933) 2019-12-17 09:31:07 -05:00
ilm
images
index-modules
indices Add ILM histore store index (#50287) 2019-12-18 16:09:59 -07:00
ingest Geo: Switch generated WKT to upper case (#50285) 2019-12-18 07:28:56 -10:00
licensing
mapping Add per-field metadata. (#49419) 2019-12-18 17:27:38 +01:00
migration
ml [DOCS] Fixes security links 2019-12-18 11:51:03 -08:00
modules
monitoring
query-dsl [Docs] Remove `intervals` filter rule from allowed top-level rules (#50320) 2019-12-18 17:35:35 +01:00
release-notes
rest-api [DOCS] Move machine learning results definitions into APIs (#50257) 2019-12-18 09:50:31 -08:00
rollup
scripting
search Add per-field metadata. (#49419) 2019-12-18 17:27:38 +01:00
settings Add ILM histore store index (#50287) 2019-12-18 16:09:59 -07:00
setup [DOCS] Add warning about Docker port exposure (#50169) 2019-12-18 09:03:44 -05:00
sql
testing
transform [DOCS] Move transform resource definitions into APIs (#50108) 2019-12-17 09:01:31 -08:00
upgrade
vectors
aggregations.asciidoc
analysis.asciidoc
api-conventions.asciidoc
cat.asciidoc
cluster.asciidoc
data-rollup-transform.asciidoc
docs.asciidoc
frozen-indices.asciidoc
getting-started.asciidoc
glossary.asciidoc
gs-index.asciidoc
high-availability.asciidoc
how-to.asciidoc
index-docinfo.xml
index-extra-title-page.html [DOCS] Add `index-extra-title-page.html` for direct HTML migration (#50189) 2019-12-13 12:44:12 -05:00
index-modules.asciidoc
index.asciidoc
index.x-docinfo.xml
index.x.asciidoc
indices.asciidoc
ingest.asciidoc
intro.asciidoc
mapping.asciidoc
modules.asciidoc
query-dsl.asciidoc
redirects.asciidoc [DOCS] Move machine learning results definitions into APIs (#50257) 2019-12-18 09:50:31 -08:00
release-notes.asciidoc
scripting.asciidoc
search.asciidoc
setup.asciidoc
testing.asciidoc
upgrade.asciidoc