• Plugin version: v3.0.6
• Released on: 2023-05-30
• Changelog

For other versions, see theVersioned plugin docs.

For plugins not bundled by default, it is easy to install by runningbin/logstash-plugin install logstash-output-boundary. SeeWorking with plugins for more details.

For questions about the plugin, open a topic in theDiscuss forums. For bugs or feature requests, open an issue inGithub. For the list of Elastic supported plugins, please consult theElastic Support Matrix.

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

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

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

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

Your Boundary API key

• Value type isboolean
• Default value isfalse

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']

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

Sub-Type

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

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

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

Type

• Value type isstring
• 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 toevent.get("@timestamp").to_i

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

Your Boundary Org ID

• Value type isstring
• 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 toevent.get("@timestamp").to_i

These configuration options are supported by all output plugins:

• Value type iscodec
• 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.

• Value type isboolean
• Default value istrue

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.

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

Add a uniqueID 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 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"  }}