zeromq
editzeromq
editThis is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-filter-zeromq
.
ZeroMQ filter. This is the best way to send an event externally for filtering It works much like an exec filter would by sending the event "offsite" for processing and waiting for a response
The protocol here is: * REQ sent with JSON-serialized logstash event * REP read expected to be the full JSON filtered event * - if reply read is an empty string, it will cancel the event.
Note that this is a limited subset of the zeromq functionality in inputs and outputs. The only topology that makes sense here is: REQ/REP. bunde
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
zeromq { }
Available configuration options:
Setting | Input type | Required | Default value |
---|---|---|---|
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|||
string, one of |
No |
|
|
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|||
No |
|
Details
edit
add_field
edit- Value type is hash
-
Default value is
{}
If this filter is successful, add any arbitrary fields to this event.
Field names can be dynamic and include parts of the event using the %{field}
.
Example:
filter { zeromq { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" } } } [source,ruby] # You can also add multiple fields at once: filter { zeromq { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" "new_field" => "new_static_value" } } }
If the event has field "somefield" == "hello"
this filter, on success,
would add field foo_hello
if it is present, with the
value above and the %{host}
piece replaced with that value from the
event. The second example would also add a hardcoded field.
add_tag
edit- Value type is array
-
Default value is
[]
If this filter is successful, add arbitrary tags to the event.
Tags can be dynamic and include parts of the event using the %{field}
syntax.
Example:
filter { zeromq { add_tag => [ "foo_%{somefield}" ] } } [source,ruby] # You can also add multiple tags at once: filter { zeromq { add_tag => [ "foo_%{somefield}", "taggedy_tag"] } }
If the event has field "somefield" == "hello"
this filter, on success,
would add a tag foo_hello
(and the second example would of course add a taggedy_tag
tag).
add_tag_on_timeout
edit- Value type is string
-
Default value is
"zeromqtimeout"
tag to add if zeromq timeout expires before getting back an answer. If set to "" then no tag will be added.
address
edit- Value type is string
-
Default value is
"tcp://127.0.0.1:2121"
0mq socket address to connect or bind Please note that inproc:// will not work with logstash as we use a context per thread By default, filters connect
field
edit- Value type is string
- There is no default value for this setting.
The field to send off-site for processing If this is unset, the whole event will be sent
mode
edit-
Value can be any of:
server
,client
-
Default value is
"client"
0mq mode server mode binds/listens client mode connects
periodic_flush
edit- Value type is boolean
-
Default value is
false
Call the filter flush method at regular interval. Optional.
remove_field
edit- Value type is array
-
Default value is
[]
If this filter is successful, remove arbitrary fields from this event. Fields names can be dynamic and include parts of the event using the %{field} Example:
filter { zeromq { remove_field => [ "foo_%{somefield}" ] } } [source,ruby] # You can also remove multiple fields at once: filter { zeromq { remove_field => [ "foo_%{somefield}", "my_extraneous_field" ] } }
If the event has field "somefield" == "hello"
this filter, on success,
would remove the field with name foo_hello
if it is present. The second
example would remove an additional, non-dynamic field.
remove_tag
edit- Value type is array
-
Default value is
[]
If this filter is successful, remove arbitrary tags from the event.
Tags can be dynamic and include parts of the event using the %{field}
syntax.
Example:
filter { zeromq { remove_tag => [ "foo_%{somefield}" ] } } [source,ruby] # You can also remove multiple tags at once: filter { zeromq { remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"] } }
If the event has field "somefield" == "hello"
this filter, on success,
would remove the tag foo_hello
if it is present. The second example
would remove a sad, unwanted tag as well.
retries
edit- Value type is number
-
Default value is
3
number of retries, used for both sending and receiving messages. for sending, retries should return instantly. for receiving, the total blocking time is up to retries X timeout, which by default is 3 X 500 = 1500ms
sockopt
edit- Value type is hash
- There is no default value for this setting.
0mq socket options This exposes zmq_setsockopt for advanced tuning see http://api.zeromq.org/2-1:zmq-setsockopt for details
This is where you would set values like: ZMQ::HWM - high water mark ZMQ::IDENTITY - named queues ZMQ::SWAP_SIZE - space for disk overflow ZMQ::SUBSCRIBE - topic filters for pubsub
example: sockopt ⇒ ["ZMQ::HWM", 50, "ZMQ::IDENTITY", "my_named_queue"]