IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elastic Docs ›Logstash Reference [5.2] ›Output plugins
« Output plugins circonus »

boundaryedit

  • Version: 3.0.0
  • Released on: 2016-09-09
  • Changelog

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-output-boundary.

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

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

boundary {
    api_key => ...
    org_id => ...
}

Available configuration options:

Setting Input type Required Default value

api_key

string

Yes

auto

boolean

No

false

bsubtype

string

No

btags

array

No

btype

string

No

codec

codec

No

"plain"

enable_metric

boolean

No

true

end_time

string

No

id

string

No

org_id

string

Yes

start_time

string

No

workers

<<,>>

No

1

Detailsedit

 

api_keyedit

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

Your Boundary API key

autoedit

  • Value type is 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']

bsubtypeedit

  • Value type is string
  • There is no default value for this setting.

Sub-Type

btagsedit

  • Value type is array
  • There is no default value for this setting.

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

btypeedit

  • Value type is string
  • There is no default value for this setting.

Type

codecedit

  • 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_metricedit

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

end_timeedit

  • Value type is 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["@timestamp"].to_i

idedit

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

output {
 stdout {
   id => "ABC"
 }
}

If you don’t explicitely set this variable Logstash will generate a unique name.

org_idedit

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

Your Boundary Org ID

start_timeedit

  • Value type is 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["@timestamp"].to_i

workersedit

  • Value type is string
  • Default value is 1
« Output plugins circonus »