zenoss

edit

This is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running bin/plugin install logstash-input-zenoss.

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

zenoss {
}

Available configuration options:

Setting Input type Required Default value

ack

boolean

No

true

add_field

hash

No

{}

arguments

array

No

{}

auto_delete

boolean

No

false

codec

codec

No

"plain"

durable

boolean

No

false

exchange

string

No

"zenoss.zenevents"

exclusive

boolean

No

false

host

string

No

"localhost"

key

string

No

"zenoss.zenevent.#"

passive

boolean

No

false

password

password

No

"zenoss"

port

number

No

5672

prefetch_count

number

No

256

queue

string

No

""

ssl

boolean

No

false

tags

array

No

threads

number

No

1

type

string

No

user

string

No

"zenoss"

verify_ssl

boolean

No

false

vhost

string

No

"/zenoss"

Details

edit

 

ack

edit
  • Value type is boolean
  • Default value is true

add_field

edit
  • Value type is hash
  • Default value is {}

Add a field to an event

arguments

edit
  • Value type is array
  • Default value is {}

auto_delete

edit
  • Value type is boolean
  • Default value is false

charset (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions. <li> Value type is string
  • There is no default value for this setting.

The character encoding used in this input. Examples include UTF-8 and cp1252

This setting is useful if your log files are in Latin-1 (aka cp1252) or in another character set other than UTF-8.

This only affects plain format logs since json is UTF-8 already.

codec

edit
  • Value type is codec
  • Default value is "plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

debug (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is boolean
  • Default value is false

durable

edit
  • Value type is boolean
  • Default value is false

exchange

edit
  • Value type is string
  • Default value is "zenoss.zenevents"

The name of the exchange to bind the queue. This is analogous to the rabbitmq output [config name](../outputs/rabbitmq)

exclusive

edit
  • Value type is boolean
  • Default value is false

format (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value can be any of: plain, json, json_event, msgpack_event
  • There is no default value for this setting.

The format of input data (plain, json, json_event)

host

edit
  • Value type is string
  • Default value is "localhost"

Your rabbitmq server address

key

edit
  • Value type is string
  • Default value is "zenoss.zenevent.#"

The routing key to use. This is only valid for direct or fanout exchanges

  • Routing keys are ignored on topic exchanges.
  • Wildcards are not valid on direct exchanges.

message_format (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is string
  • There is no default value for this setting.

If format is json, an event sprintf string to build what the display @message should be given (defaults to the raw JSON). sprintf format strings look like %{fieldname}

If format is json_event, ALL fields except for @type are expected to be present. Not receiving all fields will cause unexpected results.

passive

edit
  • Value type is boolean
  • Default value is false

password

edit
  • Value type is password
  • Default value is "zenoss"

Your rabbitmq password

port

edit
  • Value type is number
  • Default value is 5672

prefetch_count

edit
  • Value type is number
  • Default value is 256

queue

edit
  • Value type is string
  • Default value is ""

ssl

edit
  • Value type is boolean
  • Default value is false

tags

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

Add any number of arbitrary tags to your event.

This can help with processing later.

threads

edit
  • Value type is number
  • Default value is 1

type

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

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.

user

edit
  • Value type is string
  • Default value is "zenoss"

Your rabbitmq username

verify_ssl

edit
  • Value type is boolean
  • Default value is false

vhost

edit
  • Value type is string
  • Default value is "/zenoss"

The vhost to use. If you don’t know what this is, leave the default.