riemann-babbler 0.4.0 → 0.4.1

data/README.md

@@ -1,9 +1,9 @@
-### Установка
+### Install
 ```
 gem install riemann-babbler
 ````
 
-### Использование
+### Use
 ```
 $ riemann-babbler --help
 Riemann-babbler is plugin manager for riemann-tools.
@@ -16,55 +16,85 @@ where [options] are:
   --help, -h:   Show this message
 ```
 
-### Описание конфига
-Bubbler имеет собственные конфиг, значения полученные через --config будут смерджены 
+### Config
+Bubbler load main config and merge custom plugins
 ```yaml
 riemann:
-  host: riemann.host # хост riemann куда слать сообщения
-  port: 5555 # порт
-  tags: # таги которые будут сообшатся
+  host: riemann.host 
+  port: 5555 
+  tags: 
     - prod
     - web
-  suffix: ".testing" # окончание `hostname` в графите как начало
+  suffix: ".testing"
+  preffix: "previx"
 
 plugins:
   dirs:
-    - /etc/riemann/plugins # загружает все плагины из указаной дирректории
+    - /etc/riemann/plugins # load all rb files in dirs
   files:
-    - /var/lib/riemann-plugins/test.rb # подгружает плагин по указаному пути
+    - /var/lib/riemann-plugins/test.rb # and custom load somefile
 ```
-##### Настройки конкретного плагина
+##### Config yml for custom plugin
 ```yaml
 plugins:
   awesome_plugin:
-  	service: some critical service # описание сервиса для поста на riemann
-  	interval: 1 # как часто дергать плагин (в сек)
+  	service: some critical service
+  	interval: 1 # (in sec)
   	states:
-  		warning: 80 # какой стейт давать плагину когда метрика перевалит за указанное значение
-  		critical: 90 # соответственно стейт critical
-  	some_parametr: "pgsql://username:password@database" # например необходимая настройка для плагина
+  		warning: 80
+  		critical: 90
+  	url: "http://127.0.0.1:11311/status"
 ```
 
-### Написание собственного плагина
+### Custom Plugin
+#### Example 1
 ```ruby
-class Riemann::Babbler::Awesomeplugin
-  include Riemann::Babbler
+class Riemann::Babbler::Awesomeplugin < Riemann::Babbler
 
-  # объявление неймспейса плагина
-  def plugin
-    options.plugins.awesome_plugin
+  def init
+    plugin.set_default(:service, 'awesome plugin' )
+    plugin.set_default(:interval, 1 )
+    plugin.set_default(:url, 'http://127.0.0.1:11311/status')
   end
 
-  # то что будет вызыватся таймером по указаному interval
-  def tick
-    status = {
+  def collect
+    state = rest_get plugin.url == "OK" ? 'ok' : 'critical' # rest_get - helper
+    {
       :service => plugin.service,
-      :state => 'ok'
+      :state => state
     }
-    report status
+  end
+end
+```
+#### Example 2
+```ruby
+class Riemann::Babbler::Awesomeplugin < Riemann::Babbler
+
+  def init
+    plugin.set_default(:service, 'awesome plugin' )
+    plugin.set_default(:interval, 1 )
+    plugin.states.set_default(:warning, 5)
+    plugin.states.set_default(:critical, 20)
+    plugin.set_default(:cmd1, 'cat /file/status | grep somevalue')
+    plugin.set_default(:cmd2, 'cat /file/status | grep somevalue2')
+  end
+
+  def run_plugin # run plugin if
+    File.exists? '/file/status'
   end
 
+  def collect # may return Array
+    status = []
+    status << {
+        :service => plugin.service + " cmd1",
+        :metric => shell plugin.cmd2 # shell - helper
+        }
+    status <<  {
+        :service => plugin.service + " cmd2",
+        :metric => shell plugin.cmd2, # shell - helper
+        :as_diff => true # report as diffencial: current - last
+      }
+    status
+  end
 end
-# обязательный вызов
-Riemann::Babbler::Awesomeplugin.run
 ```

data/bin/riemann-babbler

@@ -30,7 +30,7 @@ logger = Logger.new(STDOUT)
 config_file =  if File.exist?( opts[:config] )
   YAML.load_file( opts[:config] ).to_hash
 else
-  log.error "Can't load config file #{opts[:config]}"
+  logger.error "Can't load config file #{opts[:config]}"
   Hash.new
 end
 
@@ -70,7 +70,7 @@ plugin_threads = Riemann::Babbler.registered_plugins.map do |plugin|
   }
 end
 
-Signal.trap "USR1" do
+Signal.trap "USR2" do # перехватываем сообщение (на будущее)
   plugin_threads.each( &:kill )
 end
 

data/lib/riemann/version.rb

@@ -1,5 +1,5 @@
 module Riemann
   class Babbler
-    VERSION = '0.4.0'
+    VERSION = '0.4.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riemann-babbler
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -147,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4461026817208093483
+      hash: -886395468252800895
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: