logstash-input-zenoss 2.0.4 → 2.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: cf474bfd20462add5113dce898f9a919c61fc79d
4
- data.tar.gz: f2a5aeed8f8d543607ef8305f518dc043e300575
3
+ metadata.gz: b65c0933671c4815a411ac46bc9f4a239602e7f4
4
+ data.tar.gz: 0337f690679f518eb42583062b34e2d5d3510839
5
5
  SHA512:
6
- metadata.gz: 2db7412d04706086fd8b708bec51bebaeb057987cfc2bd72fe9ffa6ae5f8dfb40f6078c55ae60ca0c1bf0a92da93ff966306416a228b712882ddb64bc789aae3
7
- data.tar.gz: 83075d3fe525cb3bde869c63a60a762dfbc174c70517bedb4754b9e657fdff9be815b2c6b54b566d3873ad32c71a75304cb6f8bdb5bfb03605658d4950fce80c
6
+ metadata.gz: e3fc10509beedfc0bd7dfb8284e28b32eff3c230a83f9891bc46e9fc9f36eca1c0a2b4543805c283b0a1df0ae71237d1f860cddeaf1503a5b905aad57c67c585
7
+ data.tar.gz: 789ed28a378178197c66457688e040d58ee6d06c0f7b0398eb774d0ff06c6998eb7ea3783d0f32926aca1a4c5596d91f65a6022f833c37845328fd93d25be26d
data/Gemfile CHANGED
@@ -1,2 +1,11 @@
1
1
  source 'https://rubygems.org'
2
- gemspec
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/LICENSE CHANGED
@@ -1,4 +1,4 @@
1
- Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
1
+ Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
2
2
 
3
3
  Licensed under the Apache License, Version 2.0 (the "License");
4
4
  you may not use this file except in compliance with the License.
data/README.md CHANGED
@@ -1,7 +1,6 @@
1
1
  # Logstash Plugin
2
2
 
3
- [![Build
4
- Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Inputs/job/logstash-plugin-input-zenoss-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Inputs/job/logstash-plugin-input-zenoss-unit/)
3
+ [![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-input-zenoss.svg)](https://travis-ci.org/logstash-plugins/logstash-input-zenoss)
5
4
 
6
5
  This is a plugin for [Logstash](https://github.com/elastic/logstash).
7
6
 
@@ -56,7 +55,12 @@ gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
56
55
  ```
57
56
  - Install plugin
58
57
  ```sh
58
+ # Logstash 2.3 and higher
59
+ bin/logstash-plugin install --no-verify
60
+
61
+ # Prior to Logstash 2.3
59
62
  bin/plugin install --no-verify
63
+
60
64
  ```
61
65
  - Run Logstash with your plugin
62
66
  ```sh
@@ -74,7 +78,12 @@ gem build logstash-filter-awesome.gemspec
74
78
  ```
75
79
  - Install the plugin from the Logstash home
76
80
  ```sh
77
- bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
81
+ # Logstash 2.3 and higher
82
+ bin/logstash-plugin install --no-verify
83
+
84
+ # Prior to Logstash 2.3
85
+ bin/plugin install --no-verify
86
+
78
87
  ```
79
88
  - Start Logstash and proceed to test the plugin
80
89
 
@@ -0,0 +1,398 @@
1
+ :plugin: zenoss
2
+ :type: input
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
+ === Zenoss input plugin
18
+
19
+ include::{include_path}/plugin_header.asciidoc[]
20
+
21
+ ==== Description
22
+
23
+ Read Zenoss events from the zenoss.zenevents fanout exchange.
24
+
25
+
26
+ [id="plugins-{type}s-{plugin}-options"]
27
+ ==== Zenoss Input Configuration Options
28
+
29
+ This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
30
+
31
+ [cols="<,<,<",options="header",]
32
+ |=======================================================================
33
+ |Setting |Input type|Required
34
+ | <<plugins-{type}s-{plugin}-ack>> |<<boolean,boolean>>|No
35
+ | <<plugins-{type}s-{plugin}-arguments>> |<<array,array>>|No
36
+ | <<plugins-{type}s-{plugin}-auto_delete>> |<<boolean,boolean>>|No
37
+ | <<plugins-{type}s-{plugin}-automatic_recovery>> |<<boolean,boolean>>|No
38
+ | <<plugins-{type}s-{plugin}-connect_retry_interval>> |<<number,number>>|No
39
+ | <<plugins-{type}s-{plugin}-connection_timeout>> |<<number,number>>|No
40
+ | <<plugins-{type}s-{plugin}-durable>> |<<boolean,boolean>>|No
41
+ | <<plugins-{type}s-{plugin}-exchange>> |<<string,string>>|No
42
+ | <<plugins-{type}s-{plugin}-exchange_type>> |<<string,string>>|No
43
+ | <<plugins-{type}s-{plugin}-exclusive>> |<<boolean,boolean>>|No
44
+ | <<plugins-{type}s-{plugin}-heartbeat>> |<<number,number>>|No
45
+ | <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
46
+ | <<plugins-{type}s-{plugin}-key>> |<<string,string>>|No
47
+ | <<plugins-{type}s-{plugin}-metadata_enabled>> |<<boolean,boolean>>|No
48
+ | <<plugins-{type}s-{plugin}-passive>> |<<boolean,boolean>>|No
49
+ | <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
50
+ | <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
51
+ | <<plugins-{type}s-{plugin}-prefetch_count>> |<<number,number>>|No
52
+ | <<plugins-{type}s-{plugin}-queue>> |<<string,string>>|No
53
+ | <<plugins-{type}s-{plugin}-ssl>> |<<boolean,boolean>>|No
54
+ | <<plugins-{type}s-{plugin}-ssl_certificate_password>> |<<string,string>>|No
55
+ | <<plugins-{type}s-{plugin}-ssl_certificate_path>> |a valid filesystem path|No
56
+ | <<plugins-{type}s-{plugin}-ssl_version>> |<<string,string>>|No
57
+ | <<plugins-{type}s-{plugin}-subscription_retry_interval_seconds>> |<<number,number>>|Yes
58
+ | <<plugins-{type}s-{plugin}-threads>> |<<number,number>>|No
59
+ | <<plugins-{type}s-{plugin}-user>> |<<string,string>>|No
60
+ | <<plugins-{type}s-{plugin}-vhost>> |<<string,string>>|No
61
+ |=======================================================================
62
+
63
+ Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
64
+ input plugins.
65
+
66
+ &nbsp;
67
+
68
+ [id="plugins-{type}s-{plugin}-ack"]
69
+ ===== `ack`
70
+
71
+ * Value type is <<boolean,boolean>>
72
+ * Default value is `true`
73
+
74
+ Enable message acknowledgements. With acknowledgements
75
+ messages fetched by Logstash but not yet sent into the
76
+ Logstash pipeline will be requeued by the server if Logstash
77
+ shuts down. Acknowledgements will however hurt the message
78
+ throughput.
79
+
80
+ This will only send an ack back every `prefetch_count` messages.
81
+ Working in batches provides a performance boost here.
82
+
83
+ [id="plugins-{type}s-{plugin}-arguments"]
84
+ ===== `arguments`
85
+
86
+ * Value type is <<array,array>>
87
+ * Default value is `{}`
88
+
89
+ Extra queue arguments as an array.
90
+ To make a RabbitMQ queue mirrored, use: `{"x-ha-policy" => "all"}`
91
+
92
+ [id="plugins-{type}s-{plugin}-auto_delete"]
93
+ ===== `auto_delete`
94
+
95
+ * Value type is <<boolean,boolean>>
96
+ * Default value is `false`
97
+
98
+ Should the queue be deleted on the broker when the last consumer
99
+ disconnects? Set this option to `false` if you want the queue to remain
100
+ on the broker, queueing up messages until a consumer comes along to
101
+ consume them.
102
+
103
+ [id="plugins-{type}s-{plugin}-automatic_recovery"]
104
+ ===== `automatic_recovery`
105
+
106
+ * Value type is <<boolean,boolean>>
107
+ * Default value is `true`
108
+
109
+ Set this to automatically recover from a broken connection. You almost certainly don't want to override this!!!
110
+
111
+ [id="plugins-{type}s-{plugin}-connect_retry_interval"]
112
+ ===== `connect_retry_interval`
113
+
114
+ * Value type is <<number,number>>
115
+ * Default value is `1`
116
+
117
+ Time in seconds to wait before retrying a connection
118
+
119
+ [id="plugins-{type}s-{plugin}-connection_timeout"]
120
+ ===== `connection_timeout`
121
+
122
+ * Value type is <<number,number>>
123
+ * There is no default value for this setting.
124
+
125
+ The default connection timeout in milliseconds. If not specified the timeout is infinite.
126
+
127
+ [id="plugins-{type}s-{plugin}-durable"]
128
+ ===== `durable`
129
+
130
+ * Value type is <<boolean,boolean>>
131
+ * Default value is `false`
132
+
133
+ Is this queue durable? (aka; Should it survive a broker restart?)
134
+
135
+ [id="plugins-{type}s-{plugin}-exchange"]
136
+ ===== `exchange`
137
+
138
+ * Value type is <<string,string>>
139
+ * Default value is `"zenoss.zenevents"`
140
+
141
+ The name of the exchange to bind the queue. This is analogous to the 'rabbitmq
142
+ output' [config 'name'](../outputs/rabbitmq)
143
+
144
+ [id="plugins-{type}s-{plugin}-exchange_type"]
145
+ ===== `exchange_type`
146
+
147
+ * Value type is <<string,string>>
148
+ * There is no default value for this setting.
149
+
150
+ The type of the exchange to bind to. Specifying this will cause this plugin
151
+ to declare the exchange if it does not exist.
152
+
153
+ [id="plugins-{type}s-{plugin}-exclusive"]
154
+ ===== `exclusive`
155
+
156
+ * Value type is <<boolean,boolean>>
157
+ * Default value is `false`
158
+
159
+ Is the queue exclusive? Exclusive queues can only be used by the connection
160
+ that declared them and will be deleted when it is closed (e.g. due to a Logstash
161
+ restart).
162
+
163
+ [id="plugins-{type}s-{plugin}-heartbeat"]
164
+ ===== `heartbeat`
165
+
166
+ * Value type is <<number,number>>
167
+ * There is no default value for this setting.
168
+
169
+ Heartbeat delay in seconds. If unspecified no heartbeats will be sent
170
+
171
+ [id="plugins-{type}s-{plugin}-host"]
172
+ ===== `host`
173
+
174
+ * Value type is <<string,string>>
175
+ * Default value is `"localhost"`
176
+
177
+ Your rabbitmq server address
178
+
179
+ [id="plugins-{type}s-{plugin}-key"]
180
+ ===== `key`
181
+
182
+ * Value type is <<string,string>>
183
+ * Default value is `"zenoss.zenevent.#"`
184
+
185
+ The routing key to use. This is only valid for direct or fanout exchanges
186
+
187
+ * Routing keys are ignored on topic exchanges.
188
+ * Wildcards are not valid on direct exchanges.
189
+
190
+ [id="plugins-{type}s-{plugin}-metadata_enabled"]
191
+ ===== `metadata_enabled`
192
+
193
+ * Value type is <<boolean,boolean>>
194
+ * Default value is `false`
195
+
196
+ Enable the storage of message headers and properties in `@metadata`. This may impact performance
197
+
198
+ [id="plugins-{type}s-{plugin}-passive"]
199
+ ===== `passive`
200
+
201
+ * Value type is <<boolean,boolean>>
202
+ * Default value is `false`
203
+
204
+ Passive queue creation? Useful for checking queue existance without modifying server state
205
+
206
+ [id="plugins-{type}s-{plugin}-password"]
207
+ ===== `password`
208
+
209
+ * Value type is <<password,password>>
210
+ * Default value is `"zenoss"`
211
+
212
+ Your rabbitmq password
213
+
214
+ [id="plugins-{type}s-{plugin}-port"]
215
+ ===== `port`
216
+
217
+ * Value type is <<number,number>>
218
+ * Default value is `5672`
219
+
220
+ RabbitMQ port to connect on
221
+
222
+ [id="plugins-{type}s-{plugin}-prefetch_count"]
223
+ ===== `prefetch_count`
224
+
225
+ * Value type is <<number,number>>
226
+ * Default value is `256`
227
+
228
+ Prefetch count. If acknowledgements are enabled with the `ack`
229
+ option, specifies the number of outstanding unacknowledged
230
+ messages allowed.
231
+
232
+ [id="plugins-{type}s-{plugin}-queue"]
233
+ ===== `queue`
234
+
235
+ * Value type is <<string,string>>
236
+ * Default value is `""`
237
+
238
+ Pull events from a http://www.rabbitmq.com/[RabbitMQ] queue.
239
+
240
+ The default settings will create an entirely transient queue and listen for all messages by default.
241
+ If you need durability or any other advanced settings, please set the appropriate options
242
+
243
+ This plugin uses the http://rubymarchhare.info/[March Hare] library
244
+ for interacting with the RabbitMQ server. Most configuration options
245
+ map directly to standard RabbitMQ and AMQP concepts. The
246
+ https://www.rabbitmq.com/amqp-0-9-1-reference.html[AMQP 0-9-1 reference guide]
247
+ and other parts of the RabbitMQ documentation are useful for deeper
248
+ understanding.
249
+
250
+ The properties of messages received will be stored in the
251
+ `[@metadata][rabbitmq_properties]` field if the `@metadata_enabled` setting is checked.
252
+ Note that storing metadata may degrade performance.
253
+ The following properties may be available (in most cases dependent on whether
254
+ they were set by the sender):
255
+
256
+ * app-id
257
+ * cluster-id
258
+ * consumer-tag
259
+ * content-encoding
260
+ * content-type
261
+ * correlation-id
262
+ * delivery-mode
263
+ * exchange
264
+ * expiration
265
+ * message-id
266
+ * priority
267
+ * redeliver
268
+ * reply-to
269
+ * routing-key
270
+ * timestamp
271
+ * type
272
+ * user-id
273
+
274
+ For example, to get the RabbitMQ message's timestamp property
275
+ into the Logstash event's `@timestamp` field, use the date
276
+ filter to parse the `[@metadata][rabbitmq_properties][timestamp]`
277
+ field:
278
+ [source,ruby]
279
+ filter {
280
+ if [@metadata][rabbitmq_properties][timestamp] {
281
+ date {
282
+ match => ["[@metadata][rabbitmq_properties][timestamp]", "UNIX"]
283
+ }
284
+ }
285
+ }
286
+
287
+ Additionally, any message headers will be saved in the
288
+ `[@metadata][rabbitmq_headers]` field.
289
+ The properties to extract from each message and store in a
290
+ @metadata field.
291
+
292
+ Technically the exchange, redeliver, and routing-key
293
+ properties belong to the envelope and not the message but we
294
+ ignore that distinction here. However, we extract the
295
+ headers separately via get_headers even though the header
296
+ table technically is a message property.
297
+
298
+ Freezing all strings so that code modifying the event's
299
+ @metadata field can't touch them.
300
+
301
+ If updating this list, remember to update the documentation
302
+ above too.
303
+ The default codec for this plugin is JSON. You can override this to suit your particular needs however.
304
+ The name of the queue Logstash will consume events from. If
305
+ left empty, a transient queue with an randomly chosen name
306
+ will be created.
307
+
308
+ [id="plugins-{type}s-{plugin}-ssl"]
309
+ ===== `ssl`
310
+
311
+ * Value type is <<boolean,boolean>>
312
+ * There is no default value for this setting.
313
+
314
+ Enable or disable SSL.
315
+ Note that by default remote certificate verification is off.
316
+ Specify ssl_certificate_path and ssl_certificate_password if you need
317
+ certificate verification
318
+
319
+ [id="plugins-{type}s-{plugin}-ssl_certificate_password"]
320
+ ===== `ssl_certificate_password`
321
+
322
+ * Value type is <<string,string>>
323
+ * There is no default value for this setting.
324
+
325
+ Password for the encrypted PKCS12 (.p12) certificate file specified in ssl_certificate_path
326
+
327
+ [id="plugins-{type}s-{plugin}-ssl_certificate_path"]
328
+ ===== `ssl_certificate_path`
329
+
330
+ * Value type is <<path,path>>
331
+ * There is no default value for this setting.
332
+
333
+ Path to an SSL certificate in PKCS12 (.p12) format used for verifying the remote host
334
+
335
+ [id="plugins-{type}s-{plugin}-ssl_version"]
336
+ ===== `ssl_version`
337
+
338
+ * Value type is <<string,string>>
339
+ * Default value is `"TLSv1.2"`
340
+
341
+ Version of the SSL protocol to use.
342
+
343
+ [id="plugins-{type}s-{plugin}-subscription_retry_interval_seconds"]
344
+ ===== `subscription_retry_interval_seconds`
345
+
346
+ * This is a required setting.
347
+ * Value type is <<number,number>>
348
+ * Default value is `5`
349
+
350
+ Amount of time in seconds to wait after a failed subscription request
351
+ before retrying. Subscribes can fail if the server goes away and then comes back.
352
+
353
+ [id="plugins-{type}s-{plugin}-threads"]
354
+ ===== `threads`
355
+
356
+ * Value type is <<number,number>>
357
+ * Default value is `1`
358
+
359
+
360
+
361
+ [id="plugins-{type}s-{plugin}-tls_certificate_password"]
362
+ ===== `tls_certificate_password` (DEPRECATED)
363
+
364
+ * DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
365
+ * Value type is <<string,string>>
366
+ * There is no default value for this setting.
367
+
368
+ TLS certificate password
369
+
370
+ [id="plugins-{type}s-{plugin}-tls_certificate_path"]
371
+ ===== `tls_certificate_path` (DEPRECATED)
372
+
373
+ * DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
374
+ * Value type is <<path,path>>
375
+ * There is no default value for this setting.
376
+
377
+ TLS certifcate path
378
+
379
+ [id="plugins-{type}s-{plugin}-user"]
380
+ ===== `user`
381
+
382
+ * Value type is <<string,string>>
383
+ * Default value is `"zenoss"`
384
+
385
+ Your rabbitmq username
386
+
387
+ [id="plugins-{type}s-{plugin}-vhost"]
388
+ ===== `vhost`
389
+
390
+ * Value type is <<string,string>>
391
+ * Default value is `"/zenoss"`
392
+
393
+ The vhost to use. If you don't know what this is, leave the default.
394
+
395
+
396
+
397
+ [id="plugins-{type}s-{plugin}-common-options"]
398
+ include::{include_path}/{type}.asciidoc[]
@@ -1,17 +1,17 @@
1
1
  Gem::Specification.new do |s|
2
2
 
3
3
  s.name = 'logstash-input-zenoss'
4
- s.version = '2.0.4'
4
+ s.version = '2.0.5'
5
5
  s.licenses = ['Apache License (2.0)']
6
6
  s.summary = "Read Zenoss events from the zenoss.zenevents fanout exchange."
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"
7
+ 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"
8
8
  s.authors = ["Elastic"]
9
9
  s.email = 'info@elastic.co'
10
10
  s.homepage = "http://www.elastic.co/guide/en/logstash/current/index.html"
11
11
  s.require_paths = ["lib"]
12
12
 
13
13
  # Files
14
- s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
14
+ s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
15
15
 
16
16
  # Tests
17
17
  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-input-zenoss
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.4
4
+ version: 2.0.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Elastic
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2016-03-24 00:00:00.000000000 Z
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
@@ -94,7 +94,7 @@ dependencies:
94
94
  - - ">="
95
95
  - !ruby/object:Gem::Version
96
96
  version: '0'
97
- 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
97
+ 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
98
98
  email: info@elastic.co
99
99
  executables: []
100
100
  extensions: []
@@ -106,6 +106,7 @@ files:
106
106
  - LICENSE
107
107
  - NOTICE.TXT
108
108
  - README.md
109
+ - docs/index.asciidoc
109
110
  - lib/logstash/inputs/zenoss.rb
110
111
  - lib/logstash/util/zenoss.rb
111
112
  - logstash-input-zenoss.gemspec