norikra-listener-zabbix 0.1.0-java → 0.2.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f47be0dc85dec9168497adf51387c08b1df0d3df
-  data.tar.gz: 2cfc3a771ccd21884c17097ef68df031a14e1c86
+  metadata.gz: ce069602d743378669cdad2f175e8a97e5549330
+  data.tar.gz: 45693b0371c948ff8a1f72f1a09a6ea3863f01e9
 SHA512:
-  metadata.gz: 5b147d6e44ef9409f43a15449e383738cde2c8b56788d38b4d80722245b05f91104f76e827140445870f6509a6776a1576dfb961cc2621a22a4a09d9b45e558d
-  data.tar.gz: f66cb17dca4fde3e9fb5c60dd2f79b2ddcb26a146d806daf0015db7d20256574c19973a7cc5fec58d2ad1657077016c0108ffd46462e6dfd8515ea30454b6393
+  metadata.gz: 7b01185ce11b57ecd936a4754da4253303adf33f19384e8344dd4070788e5526715ad3f61980a50c54bc51ed51b831b8f8902564f51277587ca8f1751d06f776
+  data.tar.gz: cca8426ff06e52f18a6ac90f21e9e1bc5fdb49cb458019bfcd2e12e0b27080dfcb7551bccf70beda60b1b590194192a17980236a252211dd67dae6381da30985

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
 /Gemfile.lock
 /vendor
+/pkg
 /norikra.log

data/README.md

@@ -1,7 +1,72 @@
-# norikra-listener-zabbix
+# Norikra::Listener::Zabbix
 
 [![Build Status](https://travis-ci.org/tkuchiki/norikra-listener-zabbix.svg?branch=master)](https://travis-ci.org/tkuchiki/norikra-listener-zabbix)
 [![Coverage Status](https://coveralls.io/repos/github/tkuchiki/norikra-listener-zabbix/badge.svg?branch=master)](https://coveralls.io/github/tkuchiki/norikra-listener-zabbix?branch=master)
 
+## Description
+
 Norikra listener plugin to send performance data for Zabbix.
 
+## Installation
+
+```shell
+gem install norikra-listener-zabbix
+```
+
+## Usage
+
+Add your query with group `ZABBIX(zabbix_server[:port=10051],zabbix_host[,preifx_item_key])`.
+
+## Examples
+
+```sql
+SELECT sum(foo) AS sum, avg(foo) AS avg FROM test_table.win:time_batch(1 min)
+-- group ZABBIX(localhost, zabbix host, foo.bar)
+```
+
+Send data `sum` and `avg` to item key `foo.bar.sum`, `foo.bar.avg`.
+
+```sql
+SELECT sum(foo) AS `bar@foo@sum`, avg(foo) AS `bar@foo@avg` FROM test_table.win:time_batch(1 min)
+-- group ZABBIX(localhost, zabbix host)
+```
+
+Send data `sum` and `avg` to item key `bar.foo.sum`, `bar.foo.avg`.  
+Replace `@` with `.`.  
+
+>Identifiers cannot contain the "." (dot) character, i.e. "vol.price" is not a valid identifier for the rename syntax.
+
+See: [5.3.4. Renaming event properties](http://www.espertech.com/esper/release-5.2.0/esper-reference/html/epl_clauses.html#epl-select-renaming)
+
+```sql
+SELECT sum(foo) AS sum, avg(foo) AS avg FROM test_table.win:time_batch(1 min)
+-- group ZABBIX([::1], zabbix host)
+```
+
+IPv6 syntax `[IPADDR]:PORT`.
+
+### Zabbix Items
+
+- Key: `foo.bar.avg`
+- Type: `Zabbix trapper`
+- Type of information: `Numeric (float)`
+
+## Test
+
+```shell
+rake [LOGLEVEL=ERROR]
+```
+
+```shell
+rake LOGLEVEL=DEBUG
+```
+
+Set loglevel as `DEBUG`.
+
+## Misc
+
+Many codes was copied from [fujiwara/fluent-plugin-zabbix](https://github.com/fujiwara/fluent-plugin-zabbix/blob/master/lib/fluent/plugin/out_zabbix.rb).
+
+## License
+
+GPLv2

data/lib/norikra/listener/zabbix.rb

@@ -7,7 +7,7 @@ include Norikra::Log
 module Norikra
   module Listener
     class Zabbix < Norikra::Listener::Base
-      attr_reader :zabbix_server, :host, :prefix_item_key, :port
+      attr_reader :zabbix_server, :zabbix_host, :prefix_item_key, :port
       
       def self.label
         "ZABBIX"
@@ -17,18 +17,42 @@ module Norikra
         args.split(",").map(&:strip)
       end
 
+      def self.split_host_port(address)
+        colon = address.count(":")
+        
+        case
+        when colon == 0 # IPv4 or FQDN
+          host = address
+          port = 10051
+        when colon == 1 # IPv4 or FQDN
+          hosts = address.split(":")
+          len   = hosts.size - 1
+          host  = hosts[0, len].join(":")
+          port  = hosts[len].to_i
+        when colon >= 2 # IPv6
+          begin
+            hosts = address.match(/\[(.+)\]:?(.+)?/)
+            host  = hosts[1]
+            port  = (hosts[2] || 10051).to_i
+          rescue
+            host = nil
+            port = nil
+          end
+        end
+
+        [host, port]
+      end
+
       def initialize(argument, query_name, query_group)
         super
         args = Zabbix::parse_argument(argument)
-        @zabbix_server = args[0]
-        @host = args[1]
+        @zabbix_server, @port = Zabbix::split_host_port(args[0])
+        @zabbix_host = args[1]
         @prefix_item_key = args[2]
-        @port = args[3].nil? ? 10051 : args[3].to_i
         
         raise Norikra::ArgumentError, "zabbix_server is not specified" unless @zabbix_server
-        raise Norikra::ArgumentError, "host is not specified" unless @host
-        raise Norikra::ArgumentError, "prefix_item_key is not specified" unless @prefix_item_key
         raise Norikra::ArgumentError, "invalid port: #{@port}" if @port == 0
+        raise Norikra::ArgumentError, "zabbix_host is not specified" unless @zabbix_host
       end
 
       def process_async(events)
@@ -37,10 +61,10 @@ module Norikra
         events.each do |time, record|
           t = time if t.nil?
           record.each do |key, value|
-            data.push({ host: @host, time: time.to_i, key: "#{@prefix_item_key}.#{key}", value: format_value(value) })
+            data.push({ host: @zabbix_host, time: time.to_i, key: format_key(key), value: format_value(value) })
           end
         end
-        debug "send data #{@zabbix_sever}:#{@port} #{@host} #{data}"
+        debug "send data #{@zabbix_sever}:#{@port} #{@zabbix_host} #{data}"
         begin
           send(t, data)
         rescue => e
@@ -48,6 +72,14 @@ module Norikra
         end
       end
 
+      def format_key(key)
+        if @prefix_item_key.nil? || @prefix_item_key.empty?
+          key.gsub(/\$/, ".")
+        else
+          "#{@prefix_item_key}.#{key}"
+        end
+      end
+
       # https://github.com/fujiwara/fluent-plugin-zabbix/blob/master/lib/fluent/plugin/out_zabbix.rb
       
       def format_value(value)

data/norikra-listener-zabbix.gemspec

@@ -5,12 +5,12 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "norikra-listener-zabbix"
-  spec.version       = "0.1.0"
+  spec.version       = "0.2.0"
   spec.authors       = ["KUCHIKI Taku"]
   spec.email         = ["kuchiki.taku@gmail.com"]
   spec.summary       = %q{Norikra listener plugin to send performance data for Zabbix.}
   spec.description   = %q{Norikra listener plugin to send performance data for Zabbix.}
-  spec.homepage      = "https://github.com/tkuchiki/norikra-lilstener-zabbix"
+  spec.homepage      = "https://github.com/tkuchiki/norikra-listener-zabbix"
   spec.license       = "GPLv2"
   spec.platform      = "java"
 

data/test/norikra/listener/zabbix_test.rb

@@ -35,21 +35,48 @@ class Norikra::Listener::ZabbixTest < Minitest::Test
     assert_equal Norikra::Listener::Zabbix.parse_argument(" localhost, zabbix-host , prefix "), args
   end
 
+  def test_split_host_port
+    assert_equal Norikra::Listener::Zabbix.split_host_port("localhost"), ["localhost", 10051]
+    assert_equal Norikra::Listener::Zabbix.split_host_port("localhost:60051"), ["localhost", 60051]
+    assert_equal Norikra::Listener::Zabbix.split_host_port("127.0.0.1"), ["127.0.0.1", 10051]
+    assert_equal Norikra::Listener::Zabbix.split_host_port("127.0.0.1:60051"), ["127.0.0.1", 60051]
+    assert_equal Norikra::Listener::Zabbix.split_host_port("[::1]"), ["::1", 10051]
+    assert_equal Norikra::Listener::Zabbix.split_host_port("[::1]:60051"), ["::1", 60051]
+    assert_equal Norikra::Listener::Zabbix.split_host_port("[2001:DB8:0:0:8:800:200C:417A]"), ["2001:DB8:0:0:8:800:200C:417A", 10051]
+    assert_equal Norikra::Listener::Zabbix.split_host_port("[2001:DB8:0:0:8:800:200C:417A]:60051"), ["2001:DB8:0:0:8:800:200C:417A", 60051]
+    assert_equal Norikra::Listener::Zabbix.split_host_port("::1"), [nil, nil]
+    assert_equal Norikra::Listener::Zabbix.split_host_port("::1:60051"), [nil, nil]
+  end
+
   def test_initialize
     args = ["localhost", "zabbix-host", "prefix"]
     listener = Norikra::Listener::Zabbix.new("localhost,zabbix-host,prefix", "query_name", "ZABBIX(localhost,zabbix-host,prefix)")
     assert_equal listener.zabbix_server, args[0]
-    assert_equal listener.host, args[1]
+    assert_equal listener.zabbix_host, args[1]
     assert_equal listener.prefix_item_key, args[2]
     assert_equal listener.port, 10051
 
-    listener = Norikra::Listener::Zabbix.new("localhost,zabbix-host,prefix,60051", "query_name", "ZABBIX(localhost,zabbix-host,prefix,60051)")
+    listener = Norikra::Listener::Zabbix.new("localhost:60051,zabbix-host,prefix", "query_name", "ZABBIX(localhost:60051,zabbix-host,prefix)")
     assert_equal listener.zabbix_server, args[0]
-    assert_equal listener.host, args[1]
+    assert_equal listener.zabbix_host, args[1]
     assert_equal listener.prefix_item_key, args[2]
     assert_equal listener.port, 60051
   end
 
+  def test_format_key
+    listener = Norikra::Listener::Zabbix.new("localhost,zabbix-host,prefix", "query_name", "ZABBIX(localhost,zabbix-host,prefix)")
+    assert_equal "prefix.foo", listener.format_key("foo")
+
+    listener = Norikra::Listener::Zabbix.new("localhost,zabbix-host,prefix.foo", "query_name", "ZABBIX(localhost,zabbix-host,prefix)")
+    assert_equal "prefix.foo.bar", listener.format_key("bar")
+
+    listener = Norikra::Listener::Zabbix.new("localhost,zabbix-host", "query_name", "ZABBIX(localhost,zabbix-host,prefix)")
+    assert_equal "foobar", listener.format_key("foobar")
+
+    listener = Norikra::Listener::Zabbix.new("localhost,zabbix-host", "query_name", "ZABBIX(localhost,zabbix-host,prefix)")
+    assert_equal "foo.bar.baz", listener.format_key("foo$bar$baz")
+  end
+
   def test_format_value
     listener = Norikra::Listener::Zabbix.new("localhost,zabbix-host,prefix", "query_name", "ZABBIX(localhost,zabbix-host,prefix)")
     assert_equal "1.2345", listener.format_value(1.23454) # round off
@@ -70,7 +97,7 @@ class Norikra::Listener::ZabbixTest < Minitest::Test
     end
     t = do_tcpserver(response)
     
-    listener = Norikra::Listener::Zabbix.new("localhost,zabbix-host,prefix,#{@port}", "query_name", "ZABBIX(localhost,zabbix-host,prefix,#{@port})")
+    listener = Norikra::Listener::Zabbix.new("localhost:#{@port},zabbix-host,prefix", "query_name", "ZABBIX(localhost:#{@port},zabbix-host,prefix)")
     epoch = Time.now.to_i
     data = [{ host: "zabbix-host", time: epoch, key: "prefix.val1", value: 1.2345 }]
     refute listener.send(epoch, data)
@@ -90,7 +117,11 @@ class Norikra::Listener::ZabbixTest < Minitest::Test
     end
     t = do_tcpserver(response)
     
-    listener = Norikra::Listener::Zabbix.new("localhost,zabbix-host,prefix,#{@port}", "query_name", "ZABBIX(localhost,zabbix-host,prefix,#{@port})")
+    listener = Norikra::Listener::Zabbix.new("localhost:#{@port},zabbix-host,prefix", "query_name", "ZABBIX(localhost:#{@port},zabbix-host,prefix)")
+    assert listener.process_async([[1454556814, {"val1"=>0, "val2"=>1.2345,}]])
+
+    # IPv6
+    listener = Norikra::Listener::Zabbix.new("[::1]:#{@port},zabbix-host,prefix", "query_name", "ZABBIX([::1]:#{@port},zabbix-host,prefix)")
     assert listener.process_async([[1454556814, {"val1"=>0, "val2"=>1.2345,}]])
     
     t.exit 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: norikra-listener-zabbix
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: java
 authors:
 - KUCHIKI Taku
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-04 00:00:00.000000000 Z
+date: 2016-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,7 +112,7 @@ files:
 - norikra-listener-zabbix.gemspec
 - test/norikra/listener/zabbix_test.rb
 - test/test_helper.rb
-homepage: https://github.com/tkuchiki/norikra-lilstener-zabbix
+homepage: https://github.com/tkuchiki/norikra-listener-zabbix
 licenses:
 - GPLv2
 metadata: {}