logstash-output-zabbix 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05a155214e6857700b0e96da739935354ec20e71
-  data.tar.gz: 0b7b595474078e49a7546cb5bb5c16b830caa27c
+  metadata.gz: 798303567d6d3ed015cc6eeec555f9e0efaf2b2f
+  data.tar.gz: a3099cc0d8fa48a31976bdac8fa9e32acdfb7f0c
 SHA512:
-  metadata.gz: 9429ad10acdad078350593bbd92ca6ba23c38988354ef7474ca4c1459bbeca8e144ac6fc00eccbd2bc54de8f7bbb05ef0e0879979828af115c33d79146b37872
-  data.tar.gz: 201444105058adcf77b8dea71a9d849c4c1ca560b924526505bef9dacbce60da13fcf2665eabb4fe3bcb8b79987f91948c0bcddd68376571d10d0a2b387c419d
+  metadata.gz: 9188dc2c31a862a5f0f22b76e20f8cb22643a80b2f16a43c14c1dace1ed13066dd8635ffa8985dd4be7066f47f9bccabc860a4193991385ee5509b77afd0a951
+  data.tar.gz: 9fa32fc9d74f096e182c9ee6edb616201fa4a0eea56b3c7eac03edb79a0becd675598951e03c252cd4a547cc9766f9ba84ee79812f522d1c6f8868ca3a7518f4

data/Gemfile

@@ -1,2 +1,11 @@
 source 'https://rubygems.org'
+
 gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/docs/index.asciidoc

@@ -0,0 +1,160 @@
+:plugin: zabbix
+:type: output
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Zabbix output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+The Zabbix output is used to send item data (key/value pairs) to a Zabbix
+server.  The event `@timestamp` will automatically be associated with the
+Zabbix item data.
+
+The Zabbix Sender protocol is described at
+https://www.zabbix.org/wiki/Docs/protocols/zabbix_sender/2.0
+Zabbix uses a kind of nested key/value store.
+
+[source,txt]
+    host
+      ├── item1
+      │     └── value1
+      ├── item2
+      │     └── value2
+      ├── ...
+      │     └── ...
+      ├── item_n
+      │     └── value_n
+
+Each "host" is an identifier, and each item is associated with that host.
+Items are typed on the Zabbix side.  You can send numbers as strings and
+Zabbix will Do The Right Thing.
+
+In the Zabbix UI, ensure that your hostname matches the value referenced by
+`zabbix_host`. Create the item with the key as it appears in the field
+referenced by `zabbix_key`.  In the item configuration window, ensure that the
+type dropdown is set to Zabbix Trapper. Also be sure to set the type of
+information that Zabbix should expect for this item.
+
+This plugin does not currently send in batches.  While it is possible to do
+so, this is not supported.  Be careful not to flood your Zabbix server with
+too many events per second.
+
+NOTE: This plugin will log a warning if a necessary field is missing. It will
+not attempt to resend if Zabbix is down, but will log an error message.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Zabbix Output Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-multi_value>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-timeout>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-zabbix_host>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-zabbix_key>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-zabbix_server_host>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-zabbix_server_port>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-zabbix_value>> |<<string,string>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+output plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-multi_value"]
+===== `multi_value` 
+
+  * Value type is <<array,array>>
+  * There is no default value for this setting.
+
+Use the `multi_value` directive to send multiple key/value pairs.
+This can be thought of as an array, like:
+
+`[ zabbix_key1, zabbix_value1, zabbix_key2, zabbix_value2, ... zabbix_keyN, zabbix_valueN ]`
+
+...where `zabbix_key1` is an instance of `zabbix_key`, and `zabbix_value1`
+is an instance of `zabbix_value`.  If the field referenced by any
+`zabbix_key` or `zabbix_value` does not exist, that entry will be ignored.
+
+This directive cannot be used in conjunction with the single-value directives
+`zabbix_key` and `zabbix_value`.
+
+[id="plugins-{type}s-{plugin}-timeout"]
+===== `timeout` 
+
+  * Value type is <<number,number>>
+  * Default value is `1`
+
+The number of seconds to wait before giving up on a connection to the Zabbix
+server. This number should be very small, otherwise delays in delivery of
+other outputs could result.
+
+[id="plugins-{type}s-{plugin}-zabbix_host"]
+===== `zabbix_host` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The field name which holds the Zabbix host name. This can be a sub-field of
+the @metadata field.
+
+[id="plugins-{type}s-{plugin}-zabbix_key"]
+===== `zabbix_key` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+A single field name which holds the value you intend to use as the Zabbix
+item key. This can be a sub-field of the @metadata field.
+This directive will be ignored if using `multi_value`
+
+IMPORTANT: `zabbix_key` is required if not using `multi_value`.
+
+
+[id="plugins-{type}s-{plugin}-zabbix_server_host"]
+===== `zabbix_server_host` 
+
+  * Value type is <<string,string>>
+  * Default value is `"localhost"`
+
+The IP or resolvable hostname where the Zabbix server is running
+
+[id="plugins-{type}s-{plugin}-zabbix_server_port"]
+===== `zabbix_server_port` 
+
+  * Value type is <<number,number>>
+  * Default value is `10051`
+
+The port on which the Zabbix server is running
+
+[id="plugins-{type}s-{plugin}-zabbix_value"]
+===== `zabbix_value` 
+
+  * Value type is <<string,string>>
+  * Default value is `"message"`
+
+The field name which holds the value you want to send.
+This directive will be ignored if using `multi_value`
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-output-zabbix.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-output-zabbix'
-  s.version         = '3.0.1'
+  s.version         = '3.0.2'
   s.licenses      = ["Apache License (2.0)"]
   s.summary       = "This output sends key/value pairs to a Zabbix server."
   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"
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
    # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-zabbix
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -113,6 +113,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/outputs/zabbix.rb
 - logstash-output-zabbix.gemspec
 - spec/helpers/zabbix_helper.rb
@@ -139,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.3
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: This output sends key/value pairs to a Zabbix server.