« Elastic Workplace Search output plugin v2.2.0 Elastic Workplace Search output plugin v2.1.1 »
Elastic Docs ›Logstash Versioned Plugin Reference ›Output plugins ›Versioned elastic_workplace_search output plugin docs

Elastic Workplace Search output plugin v2.1.2

edit

Elastic Workplace Search output plugin v2.1.2

edit

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

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 Workplace Search solution. On receiving a batch of events from the Logstash pipeline, the plugin converts the events into documents and uses the Workplace Search bulk API to index multiple events in one request.

Workplace 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 Workplace 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.

Workplace Search Output Configuration Options

edit

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

Setting Input type Required

access_token

password

Yes

document_id

string

No

source

string

Yes

timestamp_destination

string

No

url

string

Yes

Also see Common options for a list of options supported by all output plugins.

 

access_token

edit
  • Value type is password
  • There is no default value

The source access token. Visit the source overview page in the Workplace Search dashboard to find the token associated with your source.

document_id

edit
  • Value type is string
  • There is no default value

The id for workplace search documents. This can be an interpolated value like myapp-%{sequence_id}. Reusing ids will cause documents to be rewritten.

source

edit
  • Value type is string
  • There is no default value

The ID of the source you created in Workplace Search. The source field supports sprintf format to allow the source ID to be derived from a field value from each event, for example %{source_id}.

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

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

Example:

input {
  stdin {
    codec => json
  }
}

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

output {
  elastic_workplace_search {
    source => "%{[source_id]}"
  }
}

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. Workplace 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.

Common options

edit

These 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_workplace_search outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  elastic_workplace_search {
    id => "my_plugin_id"
  }
}
« Elastic Workplace Search output plugin v2.2.0 Elastic Workplace Search output plugin v2.1.1 »