boundary

Milestone: 1

This is a community-contributed plugin! It does not ship with logstash by default, but it is easy to install! To use this, you must have installed the contrib plugins package.

Synopsis

This is what it might look like in your config file:

output {
  boundary {
    api_key => ... # string (required)
    auto => ... # boolean (optional), default: false
    bsubtype => ... # string (optional)
    btags => ... # array (optional)
    btype => ... # string (optional)
    codec => ... # codec (optional), default: "plain"
    end_time => ... # string (optional)
    org_id => ... # string (required)
    start_time => ... # string (optional)
    workers => ... # number (optional), default: 1
  }
}

Details

api_key (required setting)

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

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

Your Boundary API key

auto

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

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.

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

btype

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

Type

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.

end_time

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

exclude_tags DEPRECATED

DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
Value type is array
Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

org_id (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 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

tags DEPRECATED

DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
Value type is array
Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

type DEPRECATED

DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
Value type is string
Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

workers

Value type is number
Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.

This is documentation from lib/logstash/outputs/boundary.rb