Remote Elasticsearch output
editRemote Elasticsearch output
editBeginning in version 8.12.0, you can send Elastic Agent data to a remote Elasticsearch cluster. This is especially useful for data that you want to keep separate and independent from the deployment where you use Fleet to manage the agents.
A remote Elasticsearch cluster supports the same output settings as your main Elasticsearch cluster.
To configure a remote Elasticsearch cluster for your Elastic Agent data:
- In Kibana, go to Management → Fleet → Settings.
- In the Outputs section, select Add output.
- In the Add new output flyout, provide a name for the output and select Remote Elasticsearch as the output type.
-
In the Hosts field, add the URL that agents should use to access the remote Elasticsearch cluster.
- To find the remote host address, in the remote cluster open Kibana and go to Management → Fleet → Settings.
- Copy the Hosts value for the default output.
- Back in your main cluster, paste the value you copied into the output Hosts field.
-
Create a service token to access the remote cluster.
- Below the Service Token field, copy the API request.
- In the remote cluster, open the Kibana menu and go to Management → Dev Tools.
- Run the API request.
- Copy the value for the generated token.
-
Back in your main cluster, paste the value you copied into the output Service Token field.
To prevent unauthorized access the Elasticsearch Service Token is stored as a secret value. While secret storage is recommended, you can choose to override this setting and store the password as plain text in the agent policy definition. Secret storage requires Fleet Server version 8.12 or higher. This setting can also be stored as a secret value or as plain text for preconfigured outputs. See Preconfiguration settings in the Kibana Guide to learn more.
- Choose whether or not the remote output should be the default for agent integrations or for agent monitoring data. When set, Elastic Agents use this output to send data if no other output is set in the agent policy.
-
Select which performance tuning settings you’d prefer in order to optimize Elastic Agent for throughput, scale, or latency, or leave the default
balanced
setting. - Add any advanced YAML configuration settings that you’d like for the output.
- Click Save and apply settings.
After the output is created, you can update an Elastic Agent policy to use the new remote Elasticsearch cluster:
- In Kibana, go to Management → Fleet → Agent policies.
- Click the agent policy to edit it, then click Settings.
- To send integrations data, set the Output for integrations option to use the output that you configured in the previous steps.
- To send Elastic Agent monitoring data, set the Output for agent monitoring option to use the output that you configured in the previous steps.
- Click Save changes.
The remote Elasticsearch cluster is now configured.
As a final step before using the remote Elasticsearch output, you need to make sure that for any integrations that have been added to your Elastic Agent policy, the integration assets have been installed on the remote Elasticsearch cluster. Refer to Install and uninstall Elastic Agent integration assets for the steps.