zabbix_sender_api 1.0.1 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88bf8af42d1244b44cfb42814f90b8d832fa06d9775bc80115712928a6dcc4f4
-  data.tar.gz: 4157dd8bf6092b2cdba08a718f45478be2bff8f06ea4410bc4a50b0aed98f90c
+  metadata.gz: 8047acf4e23279eaeccd8c815bc8066957291f396b67ffbc640b3ecc5cadfd7b
+  data.tar.gz: dbffe9d1733b4d17bdb30c8aafc931b2693f4a3d9d724d3a7cf38d84fbfdbff0
 SHA512:
-  metadata.gz: ae69d43633db1270bd7297e65504fb5d09019d29e861282994791e9ec3ce83cb0deac719fb593b664c0cb13c62d6d54fd782b420c8ef42fb53588bd7f3e99860
-  data.tar.gz: a1f6729596ab3fb11612ba9e4f70e16e8de1b2608f61f54705488776c5f2b6417fa8016eee815b074b534b41c23a6c64f69fe018d189d84a48edff46bcb5f919
+  metadata.gz: 5c4f066506376ef8ac762775b67ef5f37d5bf211583cea9121b3566512b0ddda64b8df94bdadb61d5a17ff095d64c169d13aed7a9c719499883a0bad2d56d437
+  data.tar.gz: 540dcdcadcc73689eccfe0a0b4256ef34cf6e91ff60eaad9a8132c51eb8c123f1034691344dc2b91f0a534ce8af0b4e5afdc2f1afb95cef289416cf8122da262

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,7 +2,9 @@
 
 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_ap)
+**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.
 
@@ -43,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)
@@ -69,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')
 
@@ -111,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,15 +195,22 @@ 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 as the structure an external discovery script should return.  You can use this
+  # if you're writing custom external discovery logic
+  #
+  def to_discodata
+    disco = { 'data'=>Array.new }
+    disco['data'] = @entities.to_a
+    return disco.to_json
   end
   ##
   # Render this discovery instance as a zabbix_sender line.
   #
   def to_senderline
-    disco = { 'data'=>Array.new }
-    disco['data'] = @entities
-    @value = disco.to_json
+    @value = self.to_discodata
     super
   end
 end

data/lib/zabbix_sender_api/version.rb

@@ -1,3 +1,3 @@
 module ZabbixSenderApi
-  VERSION = "1.0.1"
+  VERSION = "1.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zabbix_sender_api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.6
 platform: ruby
 authors:
 - Dave Parker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-02 00:00:00.000000000 Z
+date: 2020-12-16 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
@@ -58,7 +58,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby frontend to the zabbix_sender command line tool