logstash-input-nsq 1.0.7 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +24 -93
  3. data/logstash-input-nsq.gemspec +2 -2
  4. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 4bcdd26b956b28a856e1ed8e211f7cc423adda09
4
- data.tar.gz: 9e5ae986b664e3e905f188d1b4a93b451cd52387
3
+ metadata.gz: 727d56d78c72fdd4f46d64a493bb454263b2943f
4
+ data.tar.gz: db7cd29f6603154eeaa23503739aab84b43d9f40
5
5
  SHA512:
6
- metadata.gz: 2ec2f8811ce479d180a3be6a79509f9de06dd2dc76f974fda0669abba2029216d88324b828330a7217807b35322bc9dfbab3ab34b1e9dc0968941c221b502ad4
7
- data.tar.gz: e24f7f6d45a160636b9fd9cbc95c0d857d1797b718b90fc365d8eb595219cd2d8cd2d2ae955f91a4f69f4a7ed4323ae3dc0e4a273e9d838ce53dee511256df2f
6
+ metadata.gz: 7f259123ef753a16807a66cf6ab9a730eb12547f43d418048d433c5a4bd5d08b30131d1000c2c2ac95c8dcf31b76964e668ece068560b01133a8a6c60e5eb5c6
7
+ data.tar.gz: 70b031fd484b3ea3b3a7078f1935d1730626888007eb495f94716d2bdbfe5e7af859667ba19b9b2f8564fa4a5d858c5ac8357bfed1b31ba3f16d48554fa52250
data/README.md CHANGED
@@ -1,29 +1,38 @@
1
1
  # Logstash Plugin
2
2
 
3
- This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
3
+ This is a plugin for [Logstash](https://www.elastic.co/products/logstash).
4
4
 
5
5
  It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
6
6
 
7
+ At my work for [retarus GmbH](https://www.retarus.com) I really missed the NSQ support in logstash thats why i created this project in the after hours.
8
+ There is also a [logstash output nsq plugin](https://github.com/mschneider82/logstash-output-nsq) available.
9
+
7
10
  logstash-input-nsq
8
11
  ====================
9
12
 
10
- NSQ input for Logstash. This input will consume messages from a nsq topic using nsq-ruby.
13
+ NSQ input for Logstash. This input will consume messages from a nsq topic using [nsq-ruby](https://github.com/wistia/nsq-ruby/).
11
14
 
12
15
  For more information about NSQ, refer to this [documentation](http://nsq.io)
13
16
 
14
- Install
17
+ Installation
18
+ ====================
19
+
20
+ /opt/logstash/bin/logstash-plugin install logstash-input-nsq
21
+
22
+ Recommendation
15
23
  ====================
16
24
 
17
- /opt/logstash/bin/plugin install logstash-input-nsq
25
+ This consumer plugin uses `#pop` which is blocking. In case of a graceful shutdown it may can get unresponsive if there are no messages on the queue.
26
+ To mitigate this add `KILL_ON_STOP_TIMEOUT=1` to your `/etc/default/logstash` file.
18
27
 
19
28
  Logstash Configuration
20
29
  ====================
21
30
 
22
31
  input {
23
32
  nsq {
24
- nsqlookupd => ["127.0.0.1:4161","1.2.3.4:4161"]
25
- topic => "testtopic"
26
- channel => "testchannel"
33
+ nsqlookupd => ["127.0.0.1:4161","192.0.2.1:4161"]
34
+ topic => "topicname"
35
+ channel => "channelname"
27
36
  max_in_flight => 200
28
37
  }
29
38
  }
@@ -34,9 +43,9 @@ Logstash Configuration with TLS
34
43
 
35
44
  input {
36
45
  nsq {
37
- nsqlookupd => ["127.0.0.1:4161","1.2.3.4:4161"]
38
- topic => "testtopic"
39
- channel => "testchannel"
46
+ nsqlookupd => ["127.0.0.1:4161","192.0.2.1:4161"]
47
+ topic => "topicname"
48
+ channel => "channelname"
40
49
  max_in_flight => 200
41
50
  tls_v1 => true
42
51
  }
@@ -48,9 +57,9 @@ Logstash Configuration with TLS Auth
48
57
 
49
58
  input {
50
59
  nsq {
51
- nsqlookupd => ["127.0.0.1:4161","1.2.3.4:4161"]
52
- topic => "testtopic"
53
- channel => "testchannel"
60
+ nsqlookupd => ["127.0.0.1:4161","192.0.2.1:4161"]
61
+ topic => "topicname"
62
+ channel => "channelname"
54
63
  max_in_flight => 200
55
64
  tls_v1 => true
56
65
  tls_key => "/path/to/private.key"
@@ -61,85 +70,7 @@ Logstash Configuration with TLS Auth
61
70
  Dependencies
62
71
  ====================
63
72
 
64
- * nsq-ruby
65
-
66
- ## Documentation
67
-
68
- Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
69
-
70
- - For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
71
- - For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
72
-
73
- ## Need Help?
74
-
75
- Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
76
-
77
- ## Developing
78
-
79
- ### 1. Plugin Developement and Testing
80
-
81
- #### Code
82
- - To get started, you'll need JRuby with the Bundler gem installed.
83
-
84
- - Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
85
-
86
- - Install dependencies
87
- ```sh
88
- bundle install
89
- ```
90
-
91
- #### Test
92
-
93
- - Update your dependencies
94
-
95
- ```sh
96
- bundle install
97
- ```
98
-
99
- - Run tests
100
-
101
- ```sh
102
- bundle exec rspec
103
- ```
104
-
105
- ### 2. Running your unpublished Plugin in Logstash
106
-
107
- #### 2.1 Run in a local Logstash clone
108
-
109
- - Edit Logstash `Gemfile` and add the local plugin path, for example:
110
- ```ruby
111
- gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
112
- ```
113
- - Install plugin
114
- ```sh
115
- bin/plugin install --no-verify
116
- ```
117
- - Run Logstash with your plugin
118
- ```sh
119
- bin/logstash -e 'filter {awesome {}}'
120
- ```
121
- At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
122
-
123
- #### 2.2 Run in an installed Logstash
124
-
125
- You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
126
-
127
- - Build your plugin gem
128
- ```sh
129
- gem build logstash-filter-awesome.gemspec
130
- ```
131
- - Install the plugin from the Logstash home
132
- ```sh
133
- bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
134
- ```
135
- - Start Logstash and proceed to test the plugin
136
-
137
- ## Contributing
138
-
139
- All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
140
-
141
- Programming is not a required skill. Whatever you've seen about open source and maintainers or community members saying "send patches or die" - you will not see that here.
73
+ Dependencies are auto installed by logstash-plugin
142
74
 
143
- It is more important to the community that you are able to contribute.
75
+ * [nsq-ruby](https://github.com/wistia/nsq-ruby/)
144
76
 
145
- For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
@@ -1,7 +1,7 @@
1
1
  Gem::Specification.new do |s|
2
2
 
3
3
  s.name = 'logstash-input-nsq'
4
- s.version = '1.0.7'
4
+ s.version = '2.0.0'
5
5
  s.licenses = ['Apache License (2.0)']
6
6
  s.summary = 'This input will read events from a nsq topic.'
7
7
  s.description = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
19
19
  s.metadata = { 'logstash_plugin' => 'true', 'group' => 'input'}
20
20
 
21
21
  # Gem dependencies
22
- s.add_runtime_dependency "logstash-core", ">= 1.4.0", "< 3.0.0"
22
+ s.add_runtime_dependency "logstash-core", ">= 2.0.0", "< 3.0.0"
23
23
  s.add_runtime_dependency 'logstash-codec-json'
24
24
  s.add_runtime_dependency 'logstash-codec-plain'
25
25
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: logstash-input-nsq
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.7
4
+ version: 2.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Matthias Schneider
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 1.4.0
19
+ version: 2.0.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 3.0.0
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 1.4.0
29
+ version: 2.0.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 3.0.0