:plugin: boundary
:type: output

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}s-{plugin}"]

=== Boundary output plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

This output lets you send annotations to
Boundary based on Logstash events

Note that since Logstash maintains no state
these will be one-shot events

By default the start and stop time will be
the event timestamp


[id="plugins-{type}s-{plugin}-options"]
==== Boundary Output Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-api_key>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-auto>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-bsubtype>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-btags>> |<<array,array>>|No
| <<plugins-{type}s-{plugin}-btype>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-end_time>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-org_id>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-start_time>> |<<string,string>>|No
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
output plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-api_key"]
===== `api_key` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

Your Boundary API key

[id="plugins-{type}s-{plugin}-auto"]
===== `auto` 

  * Value type is <<boolean,boolean>>
  * Default value is `false`

Auto
If set to true, logstash will try to pull boundary fields out
of the event. Any field explicitly set by config options will
override these.
`['type', 'subtype', 'creation_time', 'end_time', 'links', 'tags', 'loc']`

[id="plugins-{type}s-{plugin}-bsubtype"]
===== `bsubtype` 

  * Value type is <<string,string>>
  * There is no default value for this setting.

Sub-Type

[id="plugins-{type}s-{plugin}-btags"]
===== `btags` 

  * Value type is <<array,array>>
  * There is no default value for this setting.

Tags
Set any custom tags for this event
Default are the Logstash tags if any

[id="plugins-{type}s-{plugin}-btype"]
===== `btype` 

  * Value type is <<string,string>>
  * There is no default value for this setting.

Type

[id="plugins-{type}s-{plugin}-end_time"]
===== `end_time` 

  * Value type is <<string,string>>
  * There is no default value for this setting.

End time
Override the stop time
Note that Boundary requires this to be seconds since epoch
If overriding, it is your responsibility to type this correctly
By default this is set to `event.get("@timestamp").to_i`

[id="plugins-{type}s-{plugin}-org_id"]
===== `org_id` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

Your Boundary Org ID

[id="plugins-{type}s-{plugin}-start_time"]
===== `start_time` 

  * Value type is <<string,string>>
  * There is no default value for this setting.

Start time
Override the start time
Note that Boundary requires this to be seconds since epoch
If overriding, it is your responsibility to type this correctly
By default this is set to `event.get("@timestamp").to_i`



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]