Skip to content

Commit

Permalink
Doc: Add shared attribute for messaging ecs default info (elastic#13083)
Browse files Browse the repository at this point in the history
Co-authored-by: Ry Biesemeyer <yaauie@users.noreply.github.com>
  • Loading branch information
karenzone and yaauie committed Oct 1, 2021
1 parent b63e414 commit 0f9651e
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/include/attributes-ls.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/////
These settings control attributes for Logstash core content
in the Logstash Reference (LSR) only.

Shared attributes for the plugin docs (in the LSR and VPR) should
go in /docs/include/attributes-lsplugins.asciidoc instead
with a corresponding change to the VPR settings in
logstash-docs/docs/versioned-plugins/include/attributes-ls-vpr.asciidoc
/////

12 changes: 12 additions & 0 deletions docs/include/attributes-lsplugins.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
/////
These settings control attributes in the LSR only.
They correspond to the VPR settings in logstash-docs/docs/versioned-plugins/include/attributes-ls-vpr.asciidoc
When we update one, we must update settings in the other location,

Attribute text formatted without hard wrap is deliberate.
Otherwise, text breaks at return and content isn't displayed in its entirety.
/////


: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.

2 changes: 2 additions & 0 deletions docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

include::{docs-root}/shared/versions/stack/{source_branch}.asciidoc[]
include::{docs-root}/shared/attributes.asciidoc[]
include::./include/attributes-ls.asciidoc[]
include::./include/attributes-lsplugins.asciidoc[]

:include-xpack: true
:lang: en
Expand Down

0 comments on commit 0f9651e

Please sign in to comment.