A newer version is available. For the latest information, see the current release documentation.

« Dynatrace plugin Elastic Workplace Search output plugin »

› ›

Elastic App Search output plugin

edit

Elastic App Search output plugin

edit

A component of the elastic_enterprise_search integration plugin
Integration version: v2.1.2
Released on: 2021-06-07
Changelog

For other versions, see the Versioned plugin docs.

Getting Help

edit

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.

Description

edit

This output lets you send events to the Elastic App Search solution, both the self-managed or the managed service. On receiving a batch of events from the Logstash pipeline, the plugin converts the events into documents and uses the App Search bulk API to 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 from each event before the event is sent to App Search. If you want to keep the @timestamp field, you can use the timestamp_destination option to store the timestamp in a different field.

This gem does not support codec customization.

AppSearch Output configuration options

edit

This plugin supports the following configuration options plus the Common Options described later.

Setting	Input type	Required
`api_key`	password	Yes
`document_id`	string	No
`engine`	string	Yes
`host`	string	No
`path`	string	No
`timestamp_destination`	string	No
`url`	string	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

The 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 name of the search engine you created in App Search, an information repository that includes the indexed document records. The engine field supports sprintf format to allow the engine name to be derived from a field value from each event, for example engine-%{engine_name}.

Invalid engine names cause ingestion to stop until the field value can be resolved into a valid engine name. This situation can happen if the interpolated field value resolves to a value without a matching engine, or, if the field is missing from the event and cannot be resolved at all.

Consider adding a "default" engine type in the configuration to catch errors if the field is missing from the event.

Example:

input {
  stdin {
    codec => json
  }
}

filter {
  if ![engine_name] {
    mutate {
      add_field => {"engine_name" => "default"}
    }
  }
}

output {
  appsearch {
    engine => "engine_%{[engine_name]}"
  }
}

`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. Set this when using the Elastic App Search managed service.

`path`

edit

Value type is string
Default value is /api/as/v1/

The path that is appended to the url parameter when connecting to a self-managed Elastic App Search.

`timestamp_destination`

edit

Value type is string
There is no default value

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, and by 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.

`url`

edit

Value type is string
There is no default value

The value of the API endpoint in the form of a URL. Note: The value of the of the path setting will be will be appended to this URL. Set this when using the self-managed Elastic App Search.

Common Options

edit

The following configuration options are supported by all output plugins:

Setting	Input type	Required
`enable_metric`	boolean	No
`id`	string	No

`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 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"
  }
}

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.

« Dynatrace plugin Elastic Workplace Search output plugin »