From 0c8004cdb5c32868a4643a390ef68ef37fd4cb61 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Tue, 21 Sep 2021 11:08:27 -0400 Subject: [PATCH] [DOCS] Add deprecation docs for ECS user agent (#77970) We deprecated the `user_agent` ingest processor's `ecs` option in 7.2 with PR #38828. However, we didn't add a related deprecation item to the 7.2 breaking changes docs. This adds the missing item. It also updates a related deprecation admonition. --- .../ingest/processors/user-agent.asciidoc | 2 +- docs/reference/migration/migrate_7_2.asciidoc | 15 ++++++++++++++- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/reference/ingest/processors/user-agent.asciidoc b/docs/reference/ingest/processors/user-agent.asciidoc index 073a02fef3835..09f12aeeaa690 100644 --- a/docs/reference/ingest/processors/user-agent.asciidoc +++ b/docs/reference/ingest/processors/user-agent.asciidoc @@ -22,7 +22,7 @@ The ingest-user-agent module ships by default with the regexes.yaml made availab | `regex_file` | no | - | The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the regexes.yaml from uap-core it ships with (see below). | `properties` | no | [`name`, `major`, `minor`, `patch`, `build`, `os`, `os_name`, `os_major`, `os_minor`, `device`] | Controls what properties are added to `target_field`. | `ignore_missing` | no | `false` | If `true` and `field` does not exist, the processor quietly exits without modifying the document -| `ecs` | no | `true` | Whether to return the output in Elastic Common Schema format. NOTE: This setting is deprecated and will be removed in a future version. +| `ecs` | no | `true` | deprecated:[7.2] Whether to return the output in Elastic Common Schema format. |====== Here is an example that adds the user agent details to the `user_agent` field based on the `agent` field: diff --git a/docs/reference/migration/migrate_7_2.asciidoc b/docs/reference/migration/migrate_7_2.asciidoc index 48d6c4ff208d4..875252018e921 100644 --- a/docs/reference/migration/migrate_7_2.asciidoc +++ b/docs/reference/migration/migrate_7_2.asciidoc @@ -31,6 +31,19 @@ unexpectedly ignored the rest. For instance if you set `discovery.seed_hosts: discovery. Seed host addresses containing port ranges are now rejected. [discrete] +[[breaking_72_ingest_changes]] +=== Ingest pipeline changes + +[discrete] +[[deprecate-ecs-parameter]] +==== The `user_agent` ingest processor's `ecs` parameter is deprecated. + +The `ecs` parameter for the `user_agent` ingest processor is deprecated and will +be removed in 8.0. In 8.x, the `user_agent` ingest processor will only return +{ecs-ref}[Elastic Common Schema (ECS)] fields. + +To avoid deprecation warnings, remove the parameter from your ingest pipelines. + [[breaking_72_ilm_deprecations]] === {ilm-cap} ({ilm-init}) deprecations @@ -43,4 +56,4 @@ deprecated. If the `indices.lifecycle.poll_interval` cluster setting is too low, it can cause excessive load on a cluster. To avoid deprecation warnings, use a setting value of `1s` or greater. -// end::notable-breaking-changes[] \ No newline at end of file +// end::notable-breaking-changes[]