Reference » Output plugins » boundary
«  Output plugins     csv  »

boundary

boundary
csv
circonus
cloudwatch
datadog
datadog_metrics
elasticsearch
email
exec
file
graphtastic
ganglia
graphite
google_bigquery
google_cloud_storage
gelf
http
hipchat
irc
influxdb
jira
juggernaut
kafka
loggly
librato
lumberjack
mongodb
metriccatcher
nagios
nagios_nsca
null
opentsdb
pagerduty
pipe
rackspace
riak
riemann
redis
redmine
rabbitmq
solr_http
sns
syslog
stomp
statsd
stdout
sqs
s3
tcp
udp
websocket
xmpp
zabbix
zeromq

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

 

Synopsis

This plugin supports the following configuration options:

Required configuration options:

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

Available configuration options:

Setting Input typeRequiredDefault value

api_key

string

Yes

auto

boolean

No

false

bsubtype

string

No

btags

array

No

btype

string

No

codec

codec

No

"plain"

end_time

string

No

org_id

string

Yes

start_time

string

No

workers

number

No

1

Details

 

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

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 configuration item is deprecated and may not be available in future versions.
  • 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

  • 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 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 configuration item is deprecated and may not be available in future versions.
  • 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 configuration item is deprecated and may not be available in future versions.
  • 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.

«  Output plugins     csv  »