OpenSearch/docs/reference
Lee Hinman c3c9ccf61f
[7.x] Add ILM histore store index (#50287) (#50345)
* 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

* Make ILMHistoryStore.putAsync truly async (#50403)

This moves the `putAsync` method in `ILMHistoryStore` never to block.
Previously due to the way that the `BulkProcessor` works, it was possible
for `BulkProcessor#add` to block executing a bulk request. This was bad
as we may be adding things to the history store in cluster state update
threads.

This also moves the index creation to be done prior to the bulk request
execution, rather than being checked every time an operation was added
to the queue. This lessens the chance of the index being created, then
deleted (by some external force), and then recreated via a bulk indexing
request.

Resolves #50353
2019-12-20 12:33:36 -07:00
..
aggregations [DOCS] Fix typo in bucket sum aggregation docs (#50431) 2019-12-20 08:48:25 -05:00
analysis [DOCS] Reformat token count limit filter docs (#49835) 2019-12-13 08:44:39 -05:00
cat [DOCS] Correct cat snapshots API request example (#50274) 2019-12-17 09:23:38 -05:00
ccr Backport remote proxy mode stats and naming (#50402) 2019-12-19 18:02:48 -07:00
cluster [DOCS] Document `thread_pool` node stats (#50330) 2019-12-18 17:02:00 -05:00
commands Allow truncation of clean translog (#47866) 2019-10-11 15:48:12 +01:00
docs Reindex source types disregarded in 7.x (#49580) 2019-12-15 17:30:28 +01:00
graph [DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) (#46502) 2019-09-09 13:38:14 -04:00
high-availability [DOCS] Merges duplicate pages for file realms (#49200) 2019-11-18 12:02:18 -08:00
how-to [DOCS] Add identifier mapping tip to numeric and keyword datatype docs (#49933) 2019-12-17 09:34:32 -05:00
ilm Deprecate sorting in reindex (#49458) (#49738) 2019-12-01 19:24:27 +01:00
images [DOCS] Replace cross-cluster search PNG images with SVGs (#49395) 2019-11-21 09:06:33 -05:00
index-modules Document all shard allocation filtering attributes (#46992) 2019-11-21 08:30:30 -05:00
indices [7.x] Add ILM histore store index (#50287) (#50345) 2019-12-20 12:33:36 -07:00
ingest [DOCS] Adds inference processor documentation (#50204) 2019-12-19 12:21:04 +01:00
licensing [DOCS] Reformat update license API docs (#48967) 2019-11-14 08:00:42 -05:00
mapping [DOCS] Add identifier mapping tip to numeric and keyword datatype docs (#49933) 2019-12-17 09:34:32 -05:00
migration [DOCS] Removes coming tags 2019-12-02 08:17:10 -08:00
ml [7.x][DOCS] Updates ML links (#50387) (#50409) 2019-12-20 10:01:19 -08:00
modules [7.x][DOCS] Updates ML links (#50387) (#50409) 2019-12-20 10:01:19 -08:00
monitoring Recommend Metricbeat for 7.x (#49758) 2019-12-02 21:31:47 +00:00
query-dsl [Docs] Remove `intervals` filter rule from allowed top-level rules (#50320) 2019-12-18 17:37:27 +01:00
release-notes [7.x][DOCS] Updates ML links (#50387) (#50409) 2019-12-20 10:01:19 -08:00
rest-api [DOCS] Move transform resource definitions into APIs (#50108) 2019-12-17 12:31:31 -08:00
rollup [DOCS] Merge rollup config details into API (#49412) 2019-11-22 08:39:49 -08:00
scripting Document use of context in put stored script (#50446) 2019-12-20 10:53:43 -08:00
search Upgrade to lucene 8.4.0-snapshot-662c455. (#50016) (#50039) 2019-12-10 18:04:58 +01:00
settings [7.x] Add ILM histore store index (#50287) (#50345) 2019-12-20 12:33:36 -07:00
setup [7.x][DOCS] Updates ML links (#50387) (#50409) 2019-12-20 10:01:19 -08:00
sql SQL: handle NULL arithmetic operations with INTERVALs (#49633) 2019-12-02 17:31:05 +02:00
testing Uppercasing some docs section title (#37781) 2019-01-24 22:54:55 +01:00
transform [DOCS] Move transform resource definitions into APIs (#50108) 2019-12-17 12:31:31 -08:00
upgrade [7.x][DOCS] Updates ML links (#50387) (#50409) 2019-12-20 10:01:19 -08:00
vectors Remove the 'experimental' marking from vector fields. (#49120) 2019-11-18 12:42:46 -08:00
aggregations.asciidoc [Docs] Update aggregations.asciidoc (#29265) 2018-03-28 15:01:45 +02:00
analysis.asciidoc [DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) (#46502) 2019-09-09 13:38:14 -04:00
api-conventions.asciidoc [DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) (#46502) 2019-09-09 13:38:14 -04:00
cat.asciidoc [DOCS] Document cat tasks API (#47321) (#47375) 2019-10-01 12:22:50 -04:00
cluster.asciidoc [DOCS] Adds machine learning node type and filters (#49121) 2019-11-15 08:31:59 -08:00
data-rollup-transform.asciidoc [DOCS] Adds transforms to Elasticsearch book (#46846) (#47055) 2019-09-25 08:11:37 -07:00
docs.asciidoc [DOCS] Remove heading offsets for REST APIs (#44568) 2019-07-19 14:36:06 -04:00
frozen-indices.asciidoc [DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) (#46502) 2019-09-09 13:38:14 -04:00
getting-started.asciidoc [Docs] Fix typo in getting-started.asciidoc (#49985) 2019-12-09 16:24:30 +01:00
glossary.asciidoc [DOCS] Cleans up links to security content (#47610) (#47703) 2019-10-07 15:23:19 -07:00
gs-index.asciidoc [DOCS] Adding index file for GS "mini book". 2017-07-18 13:44:08 -07:00
high-availability.asciidoc [DOCS] Remove leveloffset for CCR docs (#46818) 2019-09-18 09:44:43 -04:00
how-to.asciidoc Correct grammar in list in how-to docs 2017-01-17 20:57:22 -05:00
index-modules.asciidoc Replace required pipeline with final pipeline (#49470) 2019-11-22 14:37:36 -05:00
index.asciidoc [DOCS] Adds security content in the Elasticsearch Reference (#47596) 2019-10-04 13:11:05 -07:00
index.x.asciidoc [DOCS] Removes redundant index.asciidoc files (#30707) 2018-05-18 11:05:40 -07:00
indices.asciidoc [DOCS] Reorder index APIs alphabetically (#46981) (#47402) 2019-10-01 17:07:28 -04:00
ingest.asciidoc Replace required pipeline with final pipeline (#49470) 2019-11-22 14:37:36 -05:00
intro.asciidoc [7.x][DOCS] Updates ML links (#50387) (#50409) 2019-12-20 10:01:19 -08:00
mapping.asciidoc [DOCS] Note clause limit in `index.mapping.total_fields.limit` docs (#48153) 2019-10-18 10:20:49 -04:00
modules.asciidoc Retitle and relocate cross-cluster search docs (#45608) 2019-08-15 16:28:04 -04:00
query-dsl.asciidoc [SPATIAL] Backport new ShapeFieldMapper and ShapeQueryBuilder to 7x (#45363) 2019-08-14 16:35:10 -05:00
redirects.asciidoc [7.x][DOCS] Updates ML links (#50387) (#50409) 2019-12-20 10:01:19 -08:00
release-notes.asciidoc add release notes for 7.5.0 2019-11-12 09:59:14 +01:00
scripting.asciidoc [DOCS] Move 'Scripting' section to top-level navigation. (#42939) 2019-06-06 10:46:02 -04:00
search.asciidoc Use snake casing for document field (#45432) 2019-09-19 14:27:00 +02:00
setup.asciidoc [DOCS] Creates a cluster restart documentation page (#48583) 2019-11-12 14:50:53 +01:00
testing.asciidoc [Docs] Unify spelling of Elasticsearch (#27567) 2017-11-29 09:44:25 +01:00
upgrade.asciidoc [DOCS] Change prev version to 7.5 in upgrade docs (#48415) 2019-10-23 12:09:26 -05:00