Skip to content

Commit 2d8abc4

Browse files
karenzoneyaauie
andauthored
Doc: Add shared attribute for messaging ecs default info (elastic#13083)
Co-authored-by: Ry Biesemeyer <[email protected]>
1 parent 1913de1 commit 2d8abc4

File tree

3 files changed

+24
-0
lines changed

3 files changed

+24
-0
lines changed

docs/include/attributes-ls.asciidoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
/////
2+
These settings control attributes for Logstash core content
3+
in the Logstash Reference (LSR) only.
4+
5+
Shared attributes for the plugin docs (in the LSR and VPR) should
6+
go in /docs/include/attributes-lsplugins.asciidoc instead
7+
with a corresponding change to the VPR settings in
8+
logstash-docs/docs/versioned-plugins/include/attributes-ls-vpr.asciidoc
9+
/////
10+
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
/////
2+
These settings control attributes in the LSR only.
3+
They correspond to the VPR settings in logstash-docs/docs/versioned-plugins/include/attributes-ls-vpr.asciidoc
4+
When we update one, we must update settings in the other location,
5+
6+
Attribute text formatted without hard wrap is deliberate.
7+
Otherwise, text breaks at return and content isn't displayed in its entirety.
8+
/////
9+
10+
11+
:ecs-default: The `pipeline.ecs_compatibility` setting is available in {logstash-ref}/logstash-settings-file.html[`logstash.yml`] and `pipelines.yml`. Any value in `pipeline.ecs_compatibility` other than `disabled` is considered BETA and unsupported until Logstash 8.0 and the final 7.x version are released. Having this pipeline level flag set will cause even patch-level upgrades to automatically consume breaking changes in the upgraded plugins, changing the shape of data the plugin produces.
12+

docs/index.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44
include::{docs-root}/shared/versions/stack/{source_branch}.asciidoc[]
55
include::{docs-root}/shared/attributes.asciidoc[]
6+
include::./include/attributes-ls.asciidoc[]
7+
include::./include/attributes-lsplugins.asciidoc[]
68

79
:include-xpack: true
810
:lang: en

0 commit comments

Comments
 (0)