zabbix_sender_api 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60cdb023473d8f310e562c2130af36a7200ef5edddf30f6783df1111a15cb2f3
-  data.tar.gz: d20950ef1e873d771bf1ccd7fab94f428e764cd33d5d35e5e7bf1a872ca2456e
+  metadata.gz: 6f768b8820795e99e87ea3af8ed4cdae063daef728e7c121d5bf9b51a155780b
+  data.tar.gz: b15a5dd5f1ead39e38edff158b35a1b015864c51dc1f4ac9907e1e6ac7f9e1cb
 SHA512:
-  metadata.gz: ebd2c6648e9c4ab34dc1c982928b7c83f3bf998514c475d9f166c76b03a8f4cccd24471d16111c0abe72e6e86ff3d3baa0f7f71ec4843e11fb7a951aa566bd86
-  data.tar.gz: ff0383428a37b30a048b6e2c5fecab943368462a2922a6ea434635657c1f762ed976bb36e8cf5b894fdaa4931abc86bc5061295977c2100d4825b8f370ef974d
+  metadata.gz: cc34a4e8f82f4c4ca922c65ee35e0ce998eaea72ad5f46138c016bb5226fc1c9387712d2668727fb0305494cc009f79ed1df48586dab81b66a9ad0cbb47c4e99
+  data.tar.gz: 9a24440d4b7d0002ccd331fb43a3c3278af279f3834adb77d17c119583acc63fda4e1af1e23873cd0fe6912a350aa104c24a69928ebc6fb16e702ad6f6040bea

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zabbix_sender_api (0.1.0)
+    zabbix_sender_api (1.0.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,6 +2,10 @@
 
 This gem describes an api that takes some of the drudgery out of the task of putting together bulk data for the zabbix_sender utility.
 
+**Detailed documentation for this library is at [rubydoc.info](https://rubydoc.info/gems/zabbix_sender_api)**
+
+Look at [the source for the zfstozab gem](https://gitlab.com/svdasein/zfstozab/-/blob/master/exe/zabbix-zfs.rb) for a practical example how to use this api.
+
 zabbix_sender is a command line utility for sending monitoring data to Zabbix server or proxy. On the Zabbix server an item of type Zabbix trapper should be created with corresponding key.
 
  * [Zabbix sender manpage](https://www.zabbix.com/documentation/4.0/manpages/zabbix_sender)
@@ -41,11 +45,11 @@ It is analogous to:
 #!/usr/bin/env ruby
 require 'zabbix_sender_api'
 
-sender = Zabbix::Sender.new
+sender = Zabbix::Sender::Pipe.new
 
 rawdata = { :myFirstKey => 0, :mySecondKey => 100 }
 
-data = Zabbix::Batch.new
+data = Zabbix::Sender::Batch.new
 
 rawdata.each_pair {|key,value|
   data.addItemData(key: key,value: value)
@@ -67,7 +71,7 @@ puts data.to_senderinput
 To do low level discovery:
 
 ```ruby
-disco = Zabbix::Discovery.new(key: 'discoveryRuleKey')
+disco = Zabbix::Sender::Discovery.new(key: 'discoveryRuleKey')
 
 disco.add_entity(:SOMEUSEFULVALUE => 'aValue', :ANOTHERONE => 'somethingElse')
 
@@ -109,7 +113,7 @@ Low level discovery (LLD) is also possible with zabbix-sender; the format of the
 "theHostBeingMonitored" discoveryRuleKey 1551719797 {"data":[{"{#SOMEUSEFULVALUE}":"aValue","{#ANOTHERONE}":"somethingElse"}]}
 ```
 The above line sends an LLD discovery structure (formatted as json) to the [discovery rule](https://www.zabbix.com/documentation/4.0/manual/discovery/low_level_discovery#discovery_rule) whose key is discoveryRuleKey.  It describes one entity by passing the macro values
-#SOMEUSEFULVALUE and #ANOTHERONE to the discovery rule.  These '[lld macros](https://www.zabbix.com/documentation/4.0/manual/config/macros/lld_macros)' are available for use in item,trigger, and graph prototypes.
+{#SOMEUSEFULVALUE} and {#ANOTHERONE} to the discovery rule.  These '[lld macros](https://www.zabbix.com/documentation/4.0/manual/config/macros/lld_macros)' are available for use in item,trigger, and graph prototypes.
 
 
 If you wished to use the above lld to actually do some discovery, you'd set things up in zabbix roughly like this:

data/lib/zabbix_sender_api/api.rb

@@ -60,6 +60,7 @@ class AgentConfiguration
 end
 
 module Sender
+require 'set'
 
 ##
 # Pipe instances encapsulate communication to a running instance of zabbix_sender
@@ -172,12 +173,13 @@ end
 # then pass the discover instance into a Batch via addDiscovery(), which 
 # includes it in the batch of data just like an ordinary ItemData instance.
 class Discovery < ItemData
+  attr_reader :entities
   ##
   # The only required parameter is key:, which is the discovery rule key.
   #
   def initialize(key: nil,value: nil, timestamp:  nil, hostname: nil)
     super
-    @entities = Array.new
+    @entities = Set.new
   end
   ##
   # This is how you pass data to zabbix that you use to construct items from item templates.  Pass in
@@ -193,14 +195,14 @@ class Discovery < ItemData
     aHash.each_pair { |key,value|
       zabbified[%Q({##{key.to_s.upcase}})] = value
     }
-    @entities.push(zabbified)
+    @entities.add(zabbified)
   end
   ##
   # Render this discovery instance as a zabbix_sender line.
   #
   def to_senderline
     disco = { 'data'=>Array.new }
-    disco['data'] = @entities
+    disco['data'] = @entities.to_a
     @value = disco.to_json
     super
   end

data/lib/zabbix_sender_api/version.rb

@@ -1,3 +1,3 @@
 module ZabbixSenderApi
-  VERSION = "1.0.0"
+  VERSION = "1.0.5"
 end

data/zabbix_sender_api.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Ruby frontend to the zabbix_sender command line tool}
   spec.description   = %q{This gem describes an api to the zabbix sender facility. It saves tons of hassle when you're cranking out custom polling logic}
-  spec.homepage      = "https://gitlab.com/svdasein/zabbix_sender_api"
+  spec.homepage      = "https://rubydoc.info/gems/zabbix_sender_api"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zabbix_sender_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.5
 platform: ruby
 authors:
 - Dave Parker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-02 00:00:00.000000000 Z
+date: 2020-08-08 00:00:00.000000000 Z
 dependencies: []
 description: This gem describes an api to the zabbix sender facility. It saves tons
   of hassle when you're cranking out custom polling logic
@@ -36,12 +36,12 @@ files:
 - lib/zabbix_sender_api/version.rb
 - zabbix-sender-help.md
 - zabbix_sender_api.gemspec
-homepage: https://gitlab.com/svdasein/zabbix_sender_api
+homepage: https://rubydoc.info/gems/zabbix_sender_api
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://gitlab.com/svdasein/zabbix_sender_api
+  homepage_uri: https://rubydoc.info/gems/zabbix_sender_api
   source_code_uri: https://gitlab.com/svdasein/zabbix_sender_api
 post_install_message: 
 rdoc_options: []