Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.16] Move section about Logstash to bottom of Kafka output page (backport #1430) #1435

Merged
merged 1 commit into from
Nov 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,7 @@

Specify these settings to send data over a secure connection to Kafka. In the {fleet} <<output-settings,Output settings>>, make sure that the Kafka output type is selected.

== Kafka output and using {ls} to index data to {es}

If you are considering using {ls} to ship the data from `kafka` to {es}, please
be aware the structure of the documents sent from {agent} to `kafka` must not be modified by {ls}.
We suggest disabling `ecs_compatibility` on both the `kafka` input and the `json` codec in order
to make sure the input doesn't edit the fields and their contents.

The data streams setup by the integrations expect to receive events having the same structure and
field names as they were sent directly from an {agent}.

The structure of the documents sent from {agent} to `kafka` must not be modified by {ls}.
We suggest disabling `ecs_compatibility` on both the `kafka` input and the `json` codec.

Refer to the <<ls-output-settings,{ls} output for {agent}>> documentation for more details.

[source,yaml]
----
inputs {
kafka {
...
ecs_compatibility => "disabled"
codec => json { ecs_compatibility => "disabled" }
...
}
}
...
----
NOTE: If you plan to use {ls} to modify {agent} output data before it's sent to Kafka, please refer to our <<kafka-output-settings-ls-warning,guidance>> for doing so, further in on this page.

[discrete]
== General settings
Expand Down Expand Up @@ -570,4 +544,33 @@ include::../elastic-agent/configuration/outputs/output-shared-settings.asciidoc[

|===

[[kafka-output-settings-ls-warning]]
== Kafka output and using {ls} to index data to {es}

If you are considering using {ls} to ship the data from `kafka` to {es}, please
be aware the structure of the documents sent from {agent} to `kafka` must not be modified by {ls}.
We suggest disabling `ecs_compatibility` on both the `kafka` input and the `json` codec in order
to make sure the input doesn't edit the fields and their contents.

The data streams setup by the integrations expect to receive events having the same structure and
field names as they were sent directly from an {agent}.

The structure of the documents sent from {agent} to `kafka` must not be modified by {ls}.
We suggest disabling `ecs_compatibility` on both the `kafka` input and the `json` codec.

Refer to the <<ls-output-settings,{ls} output for {agent}>> documentation for more details.

[source,yaml]
----
inputs {
kafka {
...
ecs_compatibility => "disabled"
codec => json { ecs_compatibility => "disabled" }
...
}
}
...
----

:type!: