Skip to content

Commit 42cdfba

Browse files
authored
Doc: Improve ECS documentation
Improve the ECS related documentation. Moves the table with the ECS mapped fields to a different location, better visible to users.
1 parent 3b62690 commit 42cdfba

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

docs/index.asciidoc

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,19 @@ This configuration results in daily index names like
9292
When decoding `beats` events, this plugin adds two fields related to the event: the deprecated `host`
9393
which contains the `hostname` provided by beats and the `ip_address` containing the remote address
9494
of the client's connection. When <<plugins-{type}s-{plugin}-ecs_compatibility,ECS compatibility mode>> is
95-
enabled these are now moved in ECS compatible namespace.
95+
enabled these are now moved in ECS compatible namespace. Here's how <<plugins-{type}s-{plugin}-ecs_compatibility,ECS compatibility mode>> affects output.
96+
97+
[cols="<l,<l,e,<e"]
98+
|=======================================================================
99+
|ECS disabled |ECS v1 |Availability |Description
100+
101+
|[host] |[@metadata][input][beats][host][name] |Always |Name or address of the beat host
102+
|[@metadata][ip_address] |[@metadata][input][beats][host][ip] |Always |IP address of the Beats client
103+
|[@metadata][tls_peer][status] | [@metadata][tls_peer][status] | When SSL related fields are populated | Contains "verified"/"unverified" labels in `disabled`, `true`/`false` in `v1`
104+
|[@metadata][tls_peer][protocol] | [@metadata][input][beats][tls][version_protocol] | When SSL status is "verified" | Contains the TLS version used (e.g. `TLSv1.2`)
105+
|[@metadata][tls_peer][subject] | [@metadata][input][beats][tls][client][subject] | When SSL status is "verified" | Contains the identity name of the remote end (e.g. `CN=artifacts-no-kpi.elastic.co`)
106+
|[@metadata][tls_peer][cipher_suite] | [@metadata][input][beats][tls][cipher] | When SSL status is "verified" | Contains the name of cipher suite used (e.g. `TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256`)
107+
|=======================================================================
96108

97109
[id="plugins-{type}s-{plugin}-options"]
98110
==== Beats Input Configuration Options
@@ -164,21 +176,7 @@ Close Idle clients after X seconds of inactivity.
164176
** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
165177
** Otherwise, the default value is `disabled`.
166178

167-
Controls this plugin's compatibility with the {ecs-ref}[Elastic Common Schema (ECS)].
168-
The value of this setting affects the keys for the Beats connection's metadata on the event:
169-
170-
.Metadata Location by `ecs_compatibility` value
171-
[cols="<l,<l,e,<e"]
172-
|=======================================================================
173-
|`disabled` |`v1` |Availability |Description
174-
175-
|[host] |[@metadata][input][beats][host][name] |Always |Name or address of the beat host
176-
|[@metadata][ip_address] |[@metadata][input][beats][host][ip] |Always |IP address of the Beats client
177-
|[@metadata][tls_peer][status] | [@metadata][tls_peer][status] | When SSL related fields are populated | Contains "verified"/"unverified" labels in `disabled`, `true`/`false` in `v1`
178-
|[@metadata][tls_peer][protocol] | [@metadata][input][beats][tls][version_protocol] | When SSL status is "verified" | Contains the TLS version used (e.g. `TLSv1.2`)
179-
|[@metadata][tls_peer][subject] | [@metadata][input][beats][tls][client][subject] | When SSL status is "verified" | Contains the identity name of the remote end (e.g. `CN=artifacts-no-kpi.elastic.co`)
180-
|[@metadata][tls_peer][cipher_suite] | [@metadata][input][beats][tls][cipher] | When SSL status is "verified" | Contains the name of cipher suite used (e.g. `TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256`)
181-
|=======================================================================
179+
Refer to <<plugins-{type}s-{plugin}-ecs_metadata,ECS mapping>> for detailed information.
182180

183181
[id="plugins-{type}s-{plugin}-host"]
184182
===== `host`

0 commit comments

Comments
 (0)