zabbix_sender_api 1.0.2 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 735a9614074e16380ab7d139fc9a06cf6e4095ad765757458a392226976f0e54
-  data.tar.gz: 419cd69eb0abfd3523dc10466fccdf8361341aa1e2a23f4e701114830be747d5
+  metadata.gz: 89e13bebbddda9a40ec5990b685c876cccc4dc535d4f0aa71ee5e9e4c9ff0643
+  data.tar.gz: 5570e008ccdeae7d5f9866fa4edc6faf71bbc7968f1ee5a5a5f2a6d1c815131a
 SHA512:
-  metadata.gz: f549209f14df37a878454f539c7cee19c505010e919c31ba10e7a163b062e3b4f167ee775fc627a845672fbe99dfd0285bcdb26057cbe54a99c8b495d55ff922
-  data.tar.gz: 0b362402db258d1e2f297b243521e9a3e02c2a1573fec8c095470eb9abe5ea2c4d36095e0d8bcc216baae30b45fdd670470c7f951a55f6cb65bbbdbefda7b244
+  metadata.gz: 614555a8b2dd25f742140504eae44f84d28a977888ba7d3583ad8db818ecc646a3302a33893c5a46b92215e744f1e0ce7bed0126b4cfc1ac15d03c8657dd7880
+  data.tar.gz: 8ca65d78ae038b7ac78a093c9b85df976d3f969d3e115e50c0301f72d4a4664834adc3a2e0cbc79ab38180c4b0e4ea9412ff998aaea51a16ad3c687163808d40

data/.gitignore

@@ -1,3 +1,4 @@
+Gemfile.lock
 /.bundle/
 /.yardoc
 /_yardoc/

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')
 

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
@@ -260,6 +269,12 @@ class Batch
     @data.unshift(aDiscovery)
   end
 
+  ##
+  #  Append another batch's data into this one.
+  def appendBatch(aBatch)
+    @data.append(*aBatch.data)
+  end
+
   ##
   # Render this batch of data as a sequence of lines of text appropriate
   # for sending into zabbix_sender

data/lib/zabbix_sender_api/version.rb

@@ -1,3 +1,3 @@
 module ZabbixSenderApi
-  VERSION = "1.0.2"
+  VERSION = "1.0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zabbix_sender_api
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.7
 platform: ruby
 authors:
 - Dave Parker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-02 00:00:00.000000000 Z
+date: 2021-06-09 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
@@ -21,7 +21,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -58,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Ruby frontend to the zabbix_sender command line tool

data/Gemfile.lock

@@ -1,30 +0,0 @@
-PATH
-  remote: .
-  specs:
-    zabbix_sender_api (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (11.1.3)
-    coderay (1.1.3)
-    method_source (1.0.0)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-byebug (3.9.0)
-      byebug (~> 11.0)
-      pry (~> 0.13.0)
-    rake (12.3.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  pry
-  pry-byebug
-  rake
-  zabbix_sender_api!
-
-BUNDLED WITH
-   2.1.4