App Search output plugin v1.0.0.beta1
editApp Search output plugin v1.0.0.beta1
edit- Plugin version: v1.0.0.beta1
- Released on: 2018-10-23
- Changelog
For other versions, see the overview list.
To learn more about Logstash, see the Logstash Reference.
Getting help
editFor 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.
Description
editThis output lets you send events to Elastic’s App Search solution. On receiving a batch of events from the Logstash pipeline, the plugin will convert the events into documents and use App Search’s bulk API to index multiple events in one request.
Because App Search doesn’t allow fields to being with @timestamp
,
by default the fields @timestamp
and @version
will be removed from
each event prior to being sent to App Search. If you want to keep
the @timestamp
field you can use the
timestamp_destination option
to store this timestamp in a different field.
This gem does not support codec customization.
AppSearch Output Configuration Options
editThis 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 all output plugins.
api_key
edit- Value type is password
- There is no default value
The private API Key with write permissions. Visit the Credentials in the App Search dashboard to find the key associated with your account.
document_id
edit- Value type is string
- There is no default value
What to use as id for app search documents. This can be an interpolated value
like myapp-%{sequence_id}
. Reusing ids will cause documents to be rewritten.
engine
edit- Value type is string
- There is no default value
The Engine name. Engine is your search engine created in App Search, an information repository that includes the indexed document records.
host
edit- Value type is string
- There is no default value
The hostname of the App Search API that is associated with your App Search account.
timestamp_destination
edit- Value type is string
- There is no default value
Where to move the timestamp value that all Logstash events contain in the @timestamp
field. Since App Search doesn’t support fields starting with @timestamp
, by default this field will be deleted. If you wish to keep it, set this value to the name of the field where @timestamp
will be copied to.
Common options
editThese configuration options are supported by all output plugins:
codec
edit- Value type is codec
-
Default value is
"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.
enable_metric
edit- Value type is boolean
-
Default value is
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 collection for a specific plugin.
id
edit- Value type is string
- There is no default value for this setting.
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 useful
when you have two or more plugins of the same type. For example, if you have 2 appsearch outputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { appsearch { id => "my_plugin_id" } }