Boundary output plugin

  • Plugin version: v3.0.5
  • Released on: 2018-04-06
  • Changelog

For other versions, see theVersioned plugin docs.

Installation

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-boundary. See Working with plugins for more details.

Getting Help

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

This output lets you send annotations toBoundary based on Logstash events

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

By default the start and stop time will bethe event timestamp

Boundary Output Configuration Options

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

Setting Input type Required

api_key

string

Yes

auto

boolean

No

bsubtype

string

No

btags

array

No

btype

string

No

end_time

string

No

org_id

string

Yes

start_time

string

No

Also see Common Options for a list of options supported by alloutput plugins.

 

api_key

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

Your Boundary API key

auto

  • Value type is boolean
  • Default value is false

AutoIf set to true, logstash will try to pull boundary fields outof the event. Any field explicitly set by config options willoverride these.['type', 'subtype', 'creation_time', 'end_time', 'links', 'tags', 'loc']

bsubtype

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

Sub-Type

btags

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

TagsSet any custom tags for this eventDefault are the Logstash tags if any

btype

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

Type

end_time

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

End timeOverride the stop timeNote that Boundary requires this to be seconds since epochIf overriding, it is your responsibility to type this correctlyBy default this is set to event.get("@timestamp").to_i

org_id

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

Your Boundary Org ID

start_time

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

Start timeOverride the start timeNote that Boundary requires this to be seconds since epochIf overriding, it is your responsibility to type this correctlyBy default this is set to event.get("@timestamp").to_i

Common Options

The following configuration options are supported by all output plugins:

Setting Input type Required

codec

codec

No

enable_metric

boolean

No

id

string

No

codec

  • 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

  • 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 collectionfor a specific plugin.

id

  • 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 usefulwhen you have two or more plugins of the same type. For example, if you have 2 boundary outputs.Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {  boundary {    id => "my_plugin_id"  }}