logstash-filter-zeromq 3.0.0 → 3.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +10 -1
- data/docs/index.asciidoc +148 -0
- data/logstash-filter-zeromq.gemspec +2 -2
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 19d2928eb0786bb730621f06018a08996eadc32f
|
4
|
+
data.tar.gz: 3804a64906fd0b521e7ee9c8e5477b33947fe04e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8adaa3ff81db875997068035629b62b322aab07c8c7feae84c3bc60504f4ed39ebd840df11dcd408ea3ed6bff94a126a009b1a9cebc97d83e23cae07d2525920
|
7
|
+
data.tar.gz: 8d54862c183966262fcbdc16ef79c7898de02069f5cce1c142e89ef0447edf7d4619d05b65a926facbb88b21a499294dc945a39e6143ca52cc6e3b0a6418797e
|
data/Gemfile
CHANGED
@@ -1,2 +1,11 @@
|
|
1
1
|
source 'https://rubygems.org'
|
2
|
-
|
2
|
+
|
3
|
+
gemspec
|
4
|
+
|
5
|
+
logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
|
6
|
+
use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
|
7
|
+
|
8
|
+
if Dir.exist?(logstash_path) && use_logstash_source
|
9
|
+
gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
|
10
|
+
gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
|
11
|
+
end
|
data/docs/index.asciidoc
ADDED
@@ -0,0 +1,148 @@
|
|
1
|
+
:plugin: zeromq
|
2
|
+
:type: filter
|
3
|
+
|
4
|
+
///////////////////////////////////////////
|
5
|
+
START - GENERATED VARIABLES, DO NOT EDIT!
|
6
|
+
///////////////////////////////////////////
|
7
|
+
:version: %VERSION%
|
8
|
+
:release_date: %RELEASE_DATE%
|
9
|
+
:changelog_url: %CHANGELOG_URL%
|
10
|
+
:include_path: ../../../../logstash/docs/include
|
11
|
+
///////////////////////////////////////////
|
12
|
+
END - GENERATED VARIABLES, DO NOT EDIT!
|
13
|
+
///////////////////////////////////////////
|
14
|
+
|
15
|
+
[id="plugins-{type}-{plugin}"]
|
16
|
+
|
17
|
+
=== Zeromq filter plugin
|
18
|
+
|
19
|
+
include::{include_path}/plugin_header.asciidoc[]
|
20
|
+
|
21
|
+
==== Description
|
22
|
+
|
23
|
+
ZeroMQ filter. This is the best way to send an event externally for filtering
|
24
|
+
It works much like an exec filter would by sending the event "offsite"
|
25
|
+
for processing and waiting for a response
|
26
|
+
|
27
|
+
The protocol here is:
|
28
|
+
* REQ sent with JSON-serialized logstash event
|
29
|
+
* REP read expected to be the full JSON 'filtered' event
|
30
|
+
* - if reply read is an empty string, it will cancel the event.
|
31
|
+
|
32
|
+
Note that this is a limited subset of the zeromq functionality in
|
33
|
+
inputs and outputs. The only topology that makes sense here is:
|
34
|
+
REQ/REP. bunde
|
35
|
+
|
36
|
+
[id="plugins-{type}s-{plugin}-options"]
|
37
|
+
==== Zeromq Filter Configuration Options
|
38
|
+
|
39
|
+
This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
|
40
|
+
|
41
|
+
[cols="<,<,<",options="header",]
|
42
|
+
|=======================================================================
|
43
|
+
|Setting |Input type|Required
|
44
|
+
| <<plugins-{type}s-{plugin}-add_tag_on_timeout>> |<<string,string>>|No
|
45
|
+
| <<plugins-{type}s-{plugin}-address>> |<<string,string>>|No
|
46
|
+
| <<plugins-{type}s-{plugin}-field>> |<<string,string>>|No
|
47
|
+
| <<plugins-{type}s-{plugin}-mode>> |<<string,string>>, one of `["server", "client"]`|No
|
48
|
+
| <<plugins-{type}s-{plugin}-retries>> |<<number,number>>|No
|
49
|
+
| <<plugins-{type}s-{plugin}-sentinel>> |<<string,string>>|No
|
50
|
+
| <<plugins-{type}s-{plugin}-sockopt>> |<<hash,hash>>|No
|
51
|
+
| <<plugins-{type}s-{plugin}-timeout>> |<<number,number>>|No
|
52
|
+
|=======================================================================
|
53
|
+
|
54
|
+
Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
|
55
|
+
filter plugins.
|
56
|
+
|
57
|
+
|
58
|
+
|
59
|
+
[id="plugins-{type}s-{plugin}-add_tag_on_timeout"]
|
60
|
+
===== `add_tag_on_timeout`
|
61
|
+
|
62
|
+
* Value type is <<string,string>>
|
63
|
+
* Default value is `"zeromqtimeout"`
|
64
|
+
|
65
|
+
tag to add if zeromq timeout expires before getting back an answer.
|
66
|
+
If set to "" then no tag will be added.
|
67
|
+
|
68
|
+
[id="plugins-{type}s-{plugin}-address"]
|
69
|
+
===== `address`
|
70
|
+
|
71
|
+
* Value type is <<string,string>>
|
72
|
+
* Default value is `"tcp://127.0.0.1:2121"`
|
73
|
+
|
74
|
+
0mq socket address to connect or bind
|
75
|
+
Please note that inproc:// will not work with logstash
|
76
|
+
as we use a context per thread
|
77
|
+
By default, filters connect
|
78
|
+
|
79
|
+
[id="plugins-{type}s-{plugin}-field"]
|
80
|
+
===== `field`
|
81
|
+
|
82
|
+
* Value type is <<string,string>>
|
83
|
+
* There is no default value for this setting.
|
84
|
+
|
85
|
+
The field to send off-site for processing
|
86
|
+
If this is unset, the whole event will be sent
|
87
|
+
|
88
|
+
[id="plugins-{type}s-{plugin}-mode"]
|
89
|
+
===== `mode`
|
90
|
+
|
91
|
+
* Value can be any of: `server`, `client`
|
92
|
+
* Default value is `"client"`
|
93
|
+
|
94
|
+
0mq mode
|
95
|
+
server mode binds/listens
|
96
|
+
client mode connects
|
97
|
+
|
98
|
+
[id="plugins-{type}s-{plugin}-retries"]
|
99
|
+
===== `retries`
|
100
|
+
|
101
|
+
* Value type is <<number,number>>
|
102
|
+
* Default value is `3`
|
103
|
+
|
104
|
+
number of retries, used for both sending and receiving messages.
|
105
|
+
for sending, retries should return instantly.
|
106
|
+
for receiving, the total blocking time is up to retries X timeout,
|
107
|
+
which by default is 3 X 500 = 1500ms
|
108
|
+
|
109
|
+
[id="plugins-{type}s-{plugin}-sentinel"]
|
110
|
+
===== `sentinel`
|
111
|
+
|
112
|
+
* Value type is <<string,string>>
|
113
|
+
* Default value is `""`
|
114
|
+
|
115
|
+
A sentinel value to signal the filter to cancel the event
|
116
|
+
If the peer returns the sentinel value, the event will be cancelled
|
117
|
+
|
118
|
+
[id="plugins-{type}s-{plugin}-sockopt"]
|
119
|
+
===== `sockopt`
|
120
|
+
|
121
|
+
* Value type is <<hash,hash>>
|
122
|
+
* There is no default value for this setting.
|
123
|
+
|
124
|
+
0mq socket options
|
125
|
+
This exposes zmq_setsockopt
|
126
|
+
for advanced tuning
|
127
|
+
see http://api.zeromq.org/2-1:zmq-setsockopt for details
|
128
|
+
|
129
|
+
This is where you would set values like:
|
130
|
+
ZMQ::HWM - high water mark
|
131
|
+
ZMQ::IDENTITY - named queues
|
132
|
+
ZMQ::SWAP_SIZE - space for disk overflow
|
133
|
+
ZMQ::SUBSCRIBE - topic filters for pubsub
|
134
|
+
|
135
|
+
example: sockopt => ["ZMQ::HWM", 50, "ZMQ::IDENTITY", "my_named_queue"]
|
136
|
+
|
137
|
+
[id="plugins-{type}s-{plugin}-timeout"]
|
138
|
+
===== `timeout`
|
139
|
+
|
140
|
+
* Value type is <<number,number>>
|
141
|
+
* Default value is `500`
|
142
|
+
|
143
|
+
timeout in milliseconds on which to wait for a reply.
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
[id="plugins-{type}s-{plugin}-common-options"]
|
148
|
+
include::{include_path}/{type}.asciidoc[]
|
@@ -2,7 +2,7 @@ Gem::Specification.new do |s|
|
|
2
2
|
|
3
3
|
s.name = 'logstash-filter-zeromq'
|
4
4
|
|
5
|
-
s.version = '3.0.
|
5
|
+
s.version = '3.0.1'
|
6
6
|
s.licenses = ['Apache License (2.0)']
|
7
7
|
s.summary = "ZeroMQ filter. This is a way to send an event externally for filtering"
|
8
8
|
s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
|
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
|
|
12
12
|
s.require_paths = ["lib"]
|
13
13
|
|
14
14
|
# Files
|
15
|
-
s.files = Dir[
|
15
|
+
s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
|
16
16
|
|
17
17
|
# Tests
|
18
18
|
s.test_files = s.files.grep(%r{^(test|spec|features)/})
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: logstash-filter-zeromq
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.0.
|
4
|
+
version: 3.0.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Elastic
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2017-06-23 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
@@ -70,6 +70,7 @@ files:
|
|
70
70
|
- LICENSE
|
71
71
|
- NOTICE.TXT
|
72
72
|
- README.md
|
73
|
+
- docs/index.asciidoc
|
73
74
|
- lib/logstash/filters/zeromq.rb
|
74
75
|
- logstash-filter-zeromq.gemspec
|
75
76
|
- spec/filters/zeromq_spec.rb
|