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

Add considerations for changing outputs in a policy #1038

Merged
merged 2 commits into from
Apr 23, 2024
Merged
Show file tree
Hide file tree
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
@@ -0,0 +1,15 @@
:type: output-elasticsearch-fleet-settings

[[fleet-settings-changing-outputs]]
= Considerations when changing outputs

{fleet} provides the capability to update your <<output-settings,output settings>> to add new outputs, and then to assign those new outputs to an {agent} policy. However, changing outputs should be done with caution.

When you change the output configuration within a policy applied to one or more agents, there's a high likelihood of those agents re-ingesting previously processed logs:

* Changing the output will cause the agents to remove and recreate all existing integrations associated with the new output, which as a result of the change receives a new UUID.
* As a consequence of the newly generated output UUID, the agents will retransmit all events and logs they have been configured to collect, since the data registry will be re-created.

In cases when an update to an output is required, it's generally preferable to update your existing output rather than create a new one.

An example of an update being needed would be when switching from a static IP address to a global load balancer (where both endpoints point to the same underlying cluster). In this type of situation, changing to a new output would result in data being re-collected, while updating the existing output would not.
2 changes: 2 additions & 0 deletions docs/en/ingest-management/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ include::fleet/fleet-settings-output-kafka.asciidoc[leveloffset=+3]

include::fleet/fleet-settings-remote-elasticsearch.asciidoc[leveloffset=+3]

include::fleet/fleet-settings-changing-outputs.asciidoc[leveloffset=+3]

include::fleet/fleet-manage-agents.asciidoc[leveloffset=+2]

include::fleet/unenroll-elastic-agent.asciidoc[leveloffset=+3]
Expand Down