Skip to content

Commit bff978e

Browse files
authored
[DOCS] Add deprecation docs for ECS user agent (#77970) (#78114)
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.
1 parent 0a2bfaf commit bff978e

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

docs/reference/ingest/processors/user-agent.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The ingest-user-agent module ships by default with the regexes.yaml made availab
2222
| `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).
2323
| `properties` | no | [`name`, `major`, `minor`, `patch`, `build`, `os`, `os_name`, `os_major`, `os_minor`, `device`] | Controls what properties are added to `target_field`.
2424
| `ignore_missing` | no | `false` | If `true` and `field` does not exist, the processor quietly exits without modifying the document
25-
| `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.
25+
| `ecs` | no | `true` | deprecated:[7.2] Whether to return the output in Elastic Common Schema format.
2626
|======
2727

2828
Here is an example that adds the user agent details to the `user_agent` field based on the `agent` field:

docs/reference/migration/migrate_7_2.asciidoc

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,19 @@ unexpectedly ignored the rest. For instance if you set `discovery.seed_hosts:
3131
discovery. Seed host addresses containing port ranges are now rejected.
3232

3333
[discrete]
34+
[[breaking_72_ingest_changes]]
35+
=== Ingest pipeline changes
36+
37+
[discrete]
38+
[[deprecate-ecs-parameter]]
39+
==== The `user_agent` ingest processor's `ecs` parameter is deprecated.
40+
41+
The `ecs` parameter for the `user_agent` ingest processor is deprecated and will
42+
be removed in 8.0. In 8.x, the `user_agent` ingest processor will only return
43+
{ecs-ref}[Elastic Common Schema (ECS)] fields.
44+
45+
To avoid deprecation warnings, remove the parameter from your ingest pipelines.
46+
3447
[[breaking_72_ilm_deprecations]]
3548
=== {ilm-cap} ({ilm-init}) deprecations
3649

@@ -43,4 +56,4 @@ deprecated. If the `indices.lifecycle.poll_interval` cluster setting is too low,
4356
it can cause excessive load on a cluster.
4457

4558
To avoid deprecation warnings, use a setting value of `1s` or greater.
46-
// end::notable-breaking-changes[]
59+
// end::notable-breaking-changes[]

0 commit comments

Comments
 (0)