Boundary output plugin
editBoundary output plugin
edit- Plugin version: v3.0.5
- Released on: 2018-04-06
- Changelog
For other versions, see the Versioned plugin docs.
Installation
editFor 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
editFor 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
editThis 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
Boundary Output Configuration Options
editThis plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
Yes |
||
No |
||
No |
||
No |
||
No |
||
No |
||
Yes |
||
No |
Also see Common Options for a list of options supported by all output plugins.
api_key
edit- This is a required setting.
- Value type is string
- There is no default value for this setting.
Your Boundary API key
auto
edit- 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']
btags
edit- 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
end_time
edit- 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.get("@timestamp").to_i
Common Options
editThe following configuration options are supported by all output plugins:
codec
edit- 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
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 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" } }