elasticsearch/docs/reference
Mary Gouseti c1a2d390ef
Update data stream lifecycle telemetry to track global retention (#112451)
Currently, the data stream lifecycle telemetry has the following
structure:

```
{
....
  "data_lifecycle" : {
    "available": true,
    "enabled": true,
    "count": 0,
    "default_rollover_used": true,
    "retention": {
        "minimum_millis": 0,
        "maximum_millis": 0,
        "average_millis": 0.0
    }
  }....
```

In the snippet above you can see that we track:

- The amount of data streams managed by the data stream lifecycle by `count`
- If the default rollover has been overwritten by `default_rollover_used`
- The min, max and average of the `data_retention` configured on a data stream level.

In this PR we propose the following extention:

```
....
  "data_lifecycle" : {
    "available": true,
    "enabled": true,
    "count": 0,
    "default_rollover_used": true,
    "effective_retention": { #https://github.com/elastic/dev/issues/2537
        "retained_data_streams": 5,
        "minimum_millis": 0, # Only if retained data streams > 1
        "maximum_millis": 0,
        "average_millis": 0.0
    },
    "data_retention": {
        "configured_data_streams": 5,
        "minimum_millis": 0, # Only if retained data streams > 1
        "maximum_millis": 0,
        "average_millis": 0.0
    },
    "global_retention": {
      "default": {
         "defined": true/false,
	  "affected_data_streams": 0,
         "millis": 0 
      },
      "max": {
         "defined": true/false,
	  "affected_data_streams": 0,
         "millis": 0 
      }
    }
```

With this extension we are tracking:

- The amount of data streams managed by the data stream lifecycle by `count`
- If the default rollover has been overwritten by `default_rollover_used`
- The min, max and average of the `data_retention` configured on a data stream level and the number of data streams that have it configured. We add the min, max and avg only if there are data streams with data retention configuration to avoid messing with the stats in a dashboard.
- The min, max and average of the `effective_retention` and the number of data streams that are retained. We add the min, max and avg only if there are retained data streams to avoid messing with the stats in a dashboard.
- Global retention stats, if they are defined, if the number of the affected data streams and the actual value.

The above metrics allow us to answer questions like:

- How many data streams are affected by global retention.
- How big is the difference between the longest data retention compared to max global retention.
- How much does the effective retention diverging from the data retention, this will show the impact of the global retention.
2024-09-11 18:31:04 +10:00
..
aggregations Use CLDR locale provider on JDK 23+ (#110222) 2024-09-04 13:42:40 +01:00
analysis Gracefully handle invalid synonym rules in updateable synonyms (#110901) 2024-08-06 10:44:23 -04:00
autoscaling (Doc+) Link API doc to parent object - part1 (#111951) 2024-08-20 14:58:18 -06:00
behavioral-analytics/apis (Doc+) Link API doc to parent object - part1 (#111951) 2024-08-20 14:58:18 -06:00
cat (API) Cluster Health report unassigned_primary_shards (#111727) (#112024) 2024-09-02 20:00:06 +10:00
ccr (Doc+) Link API doc to parent object - part1 (#111951) 2024-08-20 14:58:18 -06:00
cluster Implement CCS telemetry export as part of _cluster/stats (#112310) 2024-09-10 09:31:06 -06:00
commands Add remove index setting command (#109276) 2024-06-03 18:23:13 -07:00
connector/apis [Connector APIs] Add docs for sync job claim endpoint (#110412) 2024-07-15 13:01:12 +02:00
data-management [DOC] auto migrate only for default template (#82043) 2022-05-10 11:35:19 -04:00
data-streams Expose global retention settings via data stream lifecycle API (#112210) 2024-09-02 18:40:08 +10:00
docs (+Doc) Link setting reference for action.auto_create_index (#110558) 2024-07-11 07:57:18 -06:00
eql (Doc+) Link API doc to parent object - part1 (#111951) 2024-08-20 14:58:18 -06:00
esql [ES|QL] explicit cast a string literal to date_period and time_duration in arithmetic operations (#109193) 2024-09-09 14:56:43 -04:00
features/apis Simplify reset-features API (#110866) 2024-07-15 13:23:21 +01:00
fleet [Fleet] Fix Fleet API docs (#97981) 2023-07-27 17:22:44 +02:00
graph Fix a couple of docs typos (#99028) 2023-08-30 09:01:34 -04:00
health [DOCS] Fixes the description of 'affected_resources' in health API documentation (#111833) 2024-08-13 18:51:49 +02:00
high-availability Round up shard allocation / recovery / relocation concepts (#109943) 2024-07-25 14:44:57 -04:00
how-to (Doc+) "min_primary_shard_size" for 10-50GB shards (#111574) 2024-08-21 11:57:09 +02:00
ilm (Doc+) Link API doc to parent object - part1 (#111951) 2024-08-20 14:58:18 -06:00
images [DOCS] Update Using ESQL in Kibana doc (#108715) 2024-05-17 12:36:04 +02:00
index-modules #101472 Updates default index.translog.flush_threshold_size value (#112052) 2024-09-10 11:08:53 +02:00
indices Use CLDR locale provider on JDK 23+ (#110222) 2024-09-04 13:42:40 +01:00
inference [DOCS] Adds path params and available task types to the PUT inference page (#112696) 2024-09-10 12:43:08 +02:00
ingest Add support for templates when validating mappings in the simulate ingest API (#111161) 2024-09-05 09:25:53 -05:00
licensing [DOCS] Remove testenv annotations from doc snippet tests (#80023) 2021-11-05 18:38:50 -04:00
mapping (Doc+) Sparse Vectors NA to mapping analyzers (#112523) 2024-09-05 09:19:19 -06:00
migration Forward port release notes for v8.15.0 (#111714) 2024-08-08 18:10:39 +01:00
ml [DOCS] Fixes indentation issue on PUT trained models docs page. (#112538) 2024-09-05 10:46:41 +02:00
modules Add links to network disconnect troubleshooting (#112330) 2024-09-10 00:59:39 +10:00
monitoring [Docs] Update Monitoring docs with integration assets info (#112164) 2024-09-04 16:07:45 -04:00
query-dsl Update the intervals query docs (#111808) 2024-08-13 13:39:55 +09:00
query-rules/apis [Query rules] Add exclude query rule type (#111420) 2024-08-02 08:03:54 -04:00
quickstart Adds details on Kibana access credentials (#112695) 2024-09-11 06:20:08 +02:00
release-notes Add known issue for role mappings file bug to 8.15.0 (#112504) 2024-09-04 12:19:29 +01:00
repositories-metering-api [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
rest-api Update data stream lifecycle telemetry to track global retention (#112451) 2024-09-11 18:31:04 +10:00
rollup Disallow new rollup jobs in clusters with no rollup usage. (#108624) 2024-05-21 09:38:10 +02:00
scripting Aggs: Scripted metric allow list docs (#109635) 2024-07-11 14:27:51 +02:00
search Use CLDR locale provider on JDK 23+ (#110222) 2024-09-04 13:42:40 +01:00
search-application/apis Allow typed_keys for search application Search API (#108007) 2024-04-30 11:31:45 +02:00
searchable-snapshots Updates-warning-about-mounting-snapshots (#112057) 2024-08-22 12:22:32 +02:00
security Missing link added to fips-140-compliance.asciidoc (#112477) (#112516) 2024-09-04 23:34:01 +10:00
settings Introduce global retention in data stream lifecycle (cluster settings) (#111972) 2024-08-20 09:54:55 +03:00
setup [DOCS] Add missing ELASTIC_PASSWORD in docker-compose (#112372) 2024-09-03 09:58:18 +02:00
shutdown/apis [DOCS] Align docs to implementation for timeout parameters (#108593) 2024-05-16 13:05:39 +10:00
slm/apis Add interval based SLM scheduling (#110847) 2024-08-22 21:15:29 -05:00
snapshot-restore Clean up dangling S3 multipart uploads (#111955) 2024-08-20 02:49:48 +10:00
sql Removing server from the version compatibility table (#109168) 2024-05-29 11:57:46 -06:00
synonyms/apis Clarify synonyms docs (#110822) 2024-07-18 10:20:26 +02:00
tab-widgets [DOCS] Adds Google Vertex AI tutorial (#112339) 2024-08-30 13:17:59 +02:00
text-structure/apis [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
transform [DOCS] updates transforms at scale doc with date rounding. (#109073) 2024-05-27 16:34:01 +02:00
troubleshooting Deduplicate unstable-cluster troubleshooting docs (#112333) 2024-08-29 13:16:37 +01:00
upgrade (Doc+) Link Gateway Settings to Full Restart (#110902) 2024-07-25 09:10:19 -06:00
vectors Adds new bit element_type for dense_vectors (#110059) 2024-06-27 04:48:41 +10:00
watcher Fix default search timeout in watcher docs (#106404) 2024-03-19 19:45:04 +01:00
aggregations.asciidoc
alias.asciidoc Mention alias filters don't apply for get-by-id in docs (#108433) 2024-05-08 15:28:25 -06:00
analysis.asciidoc Update Lucene analysis base url (#84094) 2022-02-17 12:44:12 +01:00
api-conventions.asciidoc Add known issue docs for #111854 (#111978) 2024-08-20 07:25:55 +01:00
cat.asciidoc Add 'dataset' size to cat indices and cat shards (#98622) 2023-08-22 15:36:32 -06:00
cluster.asciidoc Fix voting_only:true in node spec docs (#99099) 2023-08-31 17:41:50 +01:00
data-management.asciidoc [DOCS] Update tech preview copy (#101606) 2023-10-31 10:31:07 -04:00
data-rollup-transform.asciidoc [DOCS] Deprecate rollups (#101265) 2023-10-25 16:52:25 -04:00
datatiers.asciidoc (Doc+) Flush out Data Tiers (#107981) 2024-07-18 14:35:41 -06:00
dependencies-versions.asciidoc [DOCS] Replace dependencies list with a link. Closes #84863 (#90694) 2022-11-09 14:37:55 -08:00
docs.asciidoc
geospatial-analysis.asciidoc Simple addition of ES|QL to geo overview page (#111158) 2024-07-23 12:00:05 +02:00
gs-index.asciidoc
high-availability.asciidoc [DOCS] Overhaul snapshot and restore docs (#79081) 2021-11-15 12:45:07 -05:00
how-to.asciidoc Add guide for tuning kNN search (#89782) 2022-10-12 14:53:53 -07:00
index-modules.asciidoc [DOCS] The logs index.mode has been renamed logsdb (#111871) 2024-08-14 08:30:31 -07:00
index.asciidoc [DOCS] Add local dev setup instructions (#107913) 2024-05-07 18:10:48 +02:00
index.x.asciidoc
indices.asciidoc Resolve Cluster API (#102726) 2024-02-08 10:50:05 -05:00
ingest.asciidoc [DOCS] [Enterprise Search] Migrate ingest pipelines/ML docs (#101156) 2023-10-25 17:17:24 +02:00
intro.asciidoc [DOCS][101] Refine mappings + documents/indices overviews (#112545) 2024-09-10 12:17:10 +02:00
landing-page.asciidoc [DOCS] Promote webinar on Elasticsearch docs landing (#105594) 2024-02-19 08:53:18 +01:00
links.asciidoc
mapping.asciidoc [DOCS][101] Refine mappings + documents/indices overviews (#112545) 2024-09-10 12:17:10 +02:00
query-dsl.asciidoc Group vector queries into new section (#110722) 2024-07-11 14:45:35 +02:00
redirects.asciidoc [DOCS] Add ES quickstart (#102226) 2023-11-24 15:27:41 +01:00
release-notes.asciidoc Forward port release notes for v8.14.3 (#110787) 2024-07-12 08:09:12 +01:00
scripting.asciidoc [DOCS] Add documentation for Painless field API (#83388) 2022-02-03 15:15:38 -05:00
search.asciidoc Add retrievers using the parser-only approach (#105470) 2024-03-12 10:11:55 -07:00
setup.asciidoc Round up shard allocation / recovery / relocation concepts (#109943) 2024-07-25 14:44:57 -04:00
troubleshooting.asciidoc (Doc+) Capture Elasticsearch diagnostic (#108259) 2024-05-09 10:27:19 -06:00
upgrade.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00