For other versions, see theVersioned plugin docs.
For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github.For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
This output lets you send events to the Elastic App Search solution.On receiving a batch of events from the Logstash pipeline, the pluginconverts the events into documents and uses the App Search bulk APIto index multiple events in one request.
App Search doesn’t allow fields to begin with @timestamp
.By default the @timestamp
and @version
fields will be removed fromeach event before the event is sent to App Search. If you want to keepthe @timestamp
field, you can use thetimestamp_destination optionto store the timestamp in a different field.
This gem does not support codec customization.
This plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
Yes |
||
No |
||
Yes |
||
Yes |
||
No |
Also see Common Options for a list of options supported by alloutput plugins.
The private API Key with write permissions. Visit the Credentials in the App Search dashboard to find the key associated with your account.
The id for app search documents. This can be an interpolated valuelike myapp-%{sequence_id}
. Reusing ids will cause documents to be rewritten.
The Engine name. Engine is your search engine created in App Search, an information repository that includes the indexed document records.
The hostname of the App Search API that is associated with your App Search account.
Where to move the value from the @timestamp
field.
All Logstash events contain a @timestamp
field.App Search doesn’t support fields starting with @timestamp
, andby default, the @timestamp
field will be deleted.
To keep the timestamp field, set this value to the name of the field where you want @timestamp
copied.
The following configuration options are supported by all output plugins:
"plain"
The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output without needing a separate filter in your Logstash pipeline.
true
Disable or enable metric logging for this specific plugin instance.By default we record all the metrics we can, but you can disable metrics collectionfor a specific plugin.
Add a unique ID
to the plugin configuration. If no ID is specified, Logstash will generate one.It is strongly recommended to set this ID in your configuration. This is particularly usefulwhen you have two or more plugins of the same type. For example, if you have 2 elastic_app_search outputs.Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { elastic_app_search { id => "my_plugin_id" }}