redis_alerting 1.1.1 → 1.3.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDAxYmIwZDg4OWI1NzkxMWU3NjYwYTNhYjBhMDgyZWE4OGU4OTQ1Yg==
-  data.tar.gz: !binary |-
-    ODRlY2JlMTIyMzZiOWU5YTgwM2NlMjE4YjNlZGU2NGI3MDlkNmM2ZQ==
+SHA1:
+  metadata.gz: 9002db58d2b36ba06bb23317c3bf5da1fe8a7699
+  data.tar.gz: 43fecfbb4fa2a032d0aa384b085504fa0c5c19a9
 SHA512:
-  metadata.gz: !binary |-
-    ODlkNjRiMTQ3MzE3MzUwYzU1ZTU2OWI5YzdkMjYyYzk0ZmI4OGQ3NWEyOGE1
-    NzRlNDM5YjA1NmU4MDkzNjQyN2E3ZWUzZDE4ZjIyYjI5Y2Q2OWIyMzQ0NTkx
-    NjE0ZmE3ZDZlYTVlMjZmMmI3MGI2YzIwYTE2NzE1ZTZiMTVhYTg=
-  data.tar.gz: !binary |-
-    MTg2YWNiODQyZTg4NzgwNTVkZGIzZTAzMDVjMDE2OGUyYTcwMWE3MjBiMjUy
-    MjlkM2M3Zjk5ZmEzOTkxOWRiYzY0ZmM3NDBkZmY1YTEyYWNkZjUwN2U5ZjZl
-    N2UyZjQ1ZTA2NTljMGZlNGI4MzQ0Y2Q5NGRhYmZkMWZmZDlhMTg=
+  metadata.gz: 0693caadb5119b3cb42855c85d82a95155645455d3568f0641d80ee33c16bbe50e13f17522adf6cf9d5a03acfc839417d68724c4b9138d17c1b8369aeffe59f0
+  data.tar.gz: 95509af5f6264bb945082dc2dae47495b487d2159cf07bf6aa1c65473e0c6ad300b170319d17b5c48498987e7aefb725a34551f2ae91e8e01efbae91d26b1d28

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Robert McLeod
+Copyright (c) 2014 Autogrow Systems Limited
 
 MIT License
 

data/README.md

@@ -20,12 +20,19 @@ Or install it yourself as:
 
 ## Usage
 
-To start the engine:
+To start and daemonize the engine:
 
 ```sh
 redis-alerting start -- -c path/to/config.yml
 ```
 
+To run it with logging output:
+
+```sh
+redis-alerting run -- -c path/to/config.yml -l info
+#redis-alerting run -- -c path/to/config.yml -l debug # this will be noisy!
+```
+
 Check the status:
 
 ```sh
@@ -46,17 +53,43 @@ Given the config file below we will describe how the gem would check some limits
 
 ```yaml
 ---
-alerting:
-  :interval: 1              # how often to check the readings
-  :namespace: alerts        # where the min/max settings, and active alerts are located
-  :channel: alerts          # publish alert messages to this channel
-  :sources:                 # keys to obtain values from that need to be checked
-    :ph: readings.ph
-    :ec: readings.ec
-    :flow: readings.flow
-#   :name: redis.key.with.live.value
+:interval: 1                           # how often to check the readings
+:namespace: alerts                     # the namespace to use for tracking active alerts/conditions
+:separator: .                          # redis namespace separator
+:channel: alerts                       # publish alert messages to this channel
+:extrema:                              # details for where to find extrema information
+  :min: min                            # what you call your minimum
+  :max: max                            # what you call your maximum
+  :pattern: settings.$source_$extrema  # the pattern to locate your extrema keys
+:sources:                              # keys to obtain values from that need to be checked
+  :ph: readings.ph
+  :ec: readings.ec
+  :flow_rate: readings.flow_rate
+# :name: redis.key.with.live.value
 ```
 
+### Extrema Patterns
+
+So to find the min/max keys you will need to specify the pattern your extrema keys use (you use a pattern right?)
+
+In the above case `settings.$source_$extrema` would be translated into:
+
+* `settings.ph_min`
+* `settings.ph_max`
+* `settings.flow_rate_min`
+* `settings.flow_rate_max`
+
+If you stored your extrema a bit differently, a pattern like this might suffice: `alerts:$source:$extrema`:
+
+* `alerts:ph:min`
+* `alerts:ph:max`
+* `alerts:ec:min`
+* `alerts:ec:max`
+
+Get it?
+
+### Sources
+
 With the example of `ph` above, the alerting system would check the redis key `readings.ph` and determine if it was outside the limits set in `alerts.ph.max` and `alerts.ph.min`.
 
 When it finds that the value in `readings.ph` is outside the range, it will add "ph" to the redis set `alerts.active`.  When it comes back into range "ph" will be removed from the `alerts.active` set.
@@ -64,9 +97,12 @@ When it finds that the value in `readings.ph` is outside the range, it will add
 So to quickly summarize:
 
 * `readings.ph` - the reading value used to check against the min and max settings
-* `alerts.ph.min` - the minimum value for the reading (below which an alert is raised)
-* `alerts.ph.max` - the maximum value for the reading (above which an alert is raised)
-* `alerts.active` - the Redis SET that contains the names of the active alerts (e.g. "ph", "ec" or "flow")
+* `settings.ph_min` - the minimum value for the reading (below which an alert is raised)
+* `settings.ph_max` - the maximum value for the reading (above which an alert is raised)
+
+### Active Set
+
+At anytime you can query the contents of the `alerts.active` SET to see which alert sources are currently active.  It will contain the name specified under the sources section.
 
 ### Published messages
 
@@ -103,8 +139,8 @@ With the engine started try this (still sticking with the keys in the config fil
 
 ```sh
 $ redis-cli
-127.0.0.1:6379> set alerts.ph.min 4000
-127.0.0.1:6379> set alerts.ph.max 9000
+127.0.0.1:6379> set settings.ph_min 4000
+127.0.0.1:6379> set settings.ph_max 9000
 127.0.0.1:6379> set readings.ph 6000
 127.0.0.1:6379> smembers alerts.active
 (empty list or set)

data/bin/redis-alerting

@@ -29,6 +29,7 @@ Daemons.run_proc("redis_alerting", daemon_opts ) do
   opts = Slop.parse slop_args do
     on :c, :config=, 'Configuration File'
     on :p, :pwd=, "Working directory"
+    on :l, :log=, "Log at the specified level to stdout"
   end
 
   begin

data/etc/config.yml

@@ -1,9 +1,13 @@
 ---
-alerting:
-  :interval: 1
-  :namespace: alerts
-  :channel: alerts
-  :sources:
-    :ph: readings.ph
-    :ec: readings.ec
-    :flow: readings.flow
+:interval: 1
+:namespace: alerts
+:separator: .
+:channel: alerts
+:extrema:
+  :min: min
+  :max: max
+  :pattern: settings.$source_$extrema
+:sources:
+  :ph: readings.ph
+  :ec: readings.ec
+  :flow_rate: readings.flow_rate

data/lib/redis_alerting/config.rb

@@ -22,11 +22,26 @@ module RedisAlerting
       raise ArgumentError, "Invalid config file: #{@config[:config]}" unless File.exists? @config[:config]
       
       yaml = YAML.load_file(@config[:config])
-      @config.merge!(yaml["alerting"])
+      @config.merge!(yaml)
+
+      @config[:log_level] = parse_log_level
 
       raise ArgumentError, "Incomplete configuration" unless valid_config?
     end
 
+    def parse_log_level
+      return Logger::UNKNOWN if @config[:log].nil? or @config[:log] == false
+      
+      case @config[:log]
+      when "error"
+        Logger::ERROR
+      when "debug"
+        Logger::DEBUG
+      else
+        Logger::INFO
+      end
+    end
+
     # TODO: check we have all the needed options
     def valid_config?
       true

data/lib/redis_alerting/engine.rb

@@ -1,21 +1,43 @@
 module RedisAlerting
   class Engine
-    def initialize(config, redis)
-      @config = config
-      @active_set = "#{@config[:namespace]}.active"
-      @redis = redis
+    def initialize(config, redis, log)
+      @config     = config
+      @active_set = "#{@config[:namespace]}#{@config[:separator]}active"
+      @redis      = redis
+      @log        = log
+      @extrema    = {}
+
       check_redis
+      build_extrema
+
+      @log.info "Redis Alerting Engine Initialized"
+      @log.info "Publishing alert information on channel: #{@config[:channel]}"
+      @log.info "Currently active alerts are in the key: #{@active_set}"
+
+      @log.info "Working with sources:"
+      @config[:sources].each do |name, source|
+        @log.info "  #{name}: #{source}"
+      end
+
+      @log.info "Working with extrema:"
+      @extrema.each do |name, ex|
+        @log.info "  #{name}:"
+        @log.info "    min: #{ex[:min]}"
+        @log.info "    max: #{ex[:max]}"
+      end
+
     end
 
     def run
-      ns = @config[:namespace]
       @config[:sources].each do |name, source|
 
         # get the readings and alert ranges
-        min = @redis.get("#{ns}.#{name}.min").to_i
-        max = @redis.get("#{ns}.#{name}.max").to_i
+        min = @redis.get(@extrema[name][:min]).to_i
+        max = @redis.get(@extrema[name][:max]).to_i
         value = @redis.get(source).to_i
 
+        @log.debug "Checking #{name} (min #{min}) (max #{max}): #{value}"
+
         # silently ignore
         next if max.nil? or min.nil? or value.nil?
 
@@ -40,8 +62,11 @@ module RedisAlerting
     end
 
     def add_alert_for(name, condition, value, min, max)
-      return if @redis.sismember(@active_set, name)
+      return if @redis.sismember(@active_set, name) and @redis.get(condition_key(name)) == condition.to_s
       @redis.sadd @active_set, name
+      @redis.set condition_key(name), condition
+
+      @log.info "Added #{name} to active set"
       
       publish({
         action: :add, 
@@ -56,7 +81,10 @@ module RedisAlerting
     def remove_if_alert_exists(name, value, min, max)
       return unless @redis.sismember(@active_set, name)
       @redis.srem @active_set, name
-      
+      @redis.set condition_key(name), "OK"
+
+      @log.info "Removed #{name} from active set"
+
       publish({
         action: :remove,
         name: name,
@@ -68,12 +96,25 @@ module RedisAlerting
 
     def publish(message)
       @redis.publish @config[:channel], message.to_json
-      puts "pushed message: #{message.inspect}"
+      @log.info "Pushed message: #{message.inspect}"
+    end
+
+    def condition_key(name)
+      "#{@config[:namespace]}#{@config[:separator]}#{name}#{@config[:separator]}condition"
     end
 
     def check_redis
       raise ArgumentError, "Invalid Redis instance given" unless @redis.is_a? Redis
       raise ArgumentError, "Could not connect to Redis" unless @redis.ping == "PONG"
     end
+
+    def build_extrema
+      @config[:sources].each do |source, redis_key|
+        @extrema[source] = {
+          min: @config[:extrema][:pattern].gsub("$source", source.to_s).gsub("$extrema", @config[:extrema][:min]),
+          max: @config[:extrema][:pattern].gsub("$source", source.to_s).gsub("$extrema", @config[:extrema][:max])
+        }
+      end
+    end
   end
 end

data/lib/redis_alerting/version.rb

@@ -1,3 +1,3 @@
 module RedisAlerting
-  VERSION = "1.1.1"
+  VERSION = "1.3.2"
 end

data/lib/redis_alerting.rb

@@ -2,14 +2,17 @@ require "redis_alerting/version"
 require "redis_alerting/engine"
 require "redis_alerting/config"
 require 'redis'
+require 'logger'
 require 'yaml'
 require 'json'
 
 module RedisAlerting
   class << self
     def run(opts)
-      config = RedisAlerting::Config.new(opts).to_hash
-      engine = RedisAlerting::Engine.new(config, ::Redis.new)
+      config    = RedisAlerting::Config.new(opts).to_hash
+      log       = Logger.new STDOUT
+      log.level = config[:log_level]
+      engine    = RedisAlerting::Engine.new(config, ::Redis.new, log)
 
       loop do
         engine.run

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: redis_alerting
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Robert McLeod
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: daemons
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Checks redis for alert conditions and adds keys to a set when a value
@@ -117,7 +117,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -141,12 +141,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []