logster 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10338f67f3b0de4bc895fab64a21addb21987b02
-  data.tar.gz: 3d4b900cba51c32ccbf7aad9b15843c3f2cb5a97
+  metadata.gz: 97266a5b02f788e8537daaf28e0adff771a3bf6b
+  data.tar.gz: f43b618a847f9e98f54ecb9e469a29e0354a6947
 SHA512:
-  metadata.gz: 6ff41f127c57daf3404518e1311d980887b25366f20b7330d73b8b0814e8d5ca9ceed7ad5df4d33cc270806d9eb7a1c3f81787ba805566102dfd06eda42a9186
-  data.tar.gz: 9f62de9005f735c84c121ac9a7dc09259afc42dc8c032a162b7d0770bb96b62f8045a0e679febbc9d8a74af8fb2488fa27e08cb077a3aea1bce185a252929075
+  metadata.gz: 22657415d4f4173ed2a1850e43a146d81db3c53e33d6009f99069fbe81671fb65d88809fc79a963b06744a17e288364706d1ef63127bcacb3076cc9be789e28d
+  data.tar.gz: 7e57a8c7862c3375948e2a097b89c1c1d3f023e33a32c928196371e3c7ef4c02b90df6828790d12fafb49c21acccf5b7810abe32220f4030e012ed463a271081

data/README.md

@@ -97,6 +97,10 @@ Logster UI is built using [Ember.js](http://emberjs.com/)
 
 # CHANGELOG
 
+- 2015-03-18: Version 1.2.0
+  - Fix: Move Redis configuration into RedisStore.
+  - Feature: Allow `RedisStore#redis_prefix` to either be a String or a Proc.
+
 - 2015-02-11: Version 1.1.1
   - Feature: Error rate can now be tracked in one minute and one hour buckets.
 

data/lib/logster/configuration.rb

@@ -1,7 +1,7 @@
 module Logster
   class Configuration
     attr_accessor :current_context, :allow_grouping, :environments,
-      :application_version, :web_title, :redis_prefix, :redis_raw_connection
+      :application_version, :web_title
 
     attr_writer :subdirectory
 

data/lib/logster/redis_store.rb

@@ -4,20 +4,15 @@ require 'logster/base_store'
 module Logster
   class RedisRateLimiter
     BUCKETS = 6
+    PREFIX = "__LOGSTER__RATE_LIMIT".freeze
 
-    attr_reader :key, :callback_key
-
-    def initialize(redis, severities, limit, duration, callback = nil)
-      @redis = use_raw_connection? ? Logster.config.redis_raw_connection : redis
+    def initialize(redis, severities, limit, duration, redis_prefix = nil, callback = nil)
       @severities = severities
       @limit = limit
       @duration = duration
       @callback = callback
-
-      # "_LOGSTER_RATE_LIMIT:012:20:30"
-      # Triggers callback when log levels of :debug, :info and :warn occurs 20 times within 30 secs
-      @key = "#{key_prefix}#{@severities.join("")}:#{@limit}:#{@duration}"
-      @callback_key = "#{@key}:callback_triggered"
+      @redis_prefix = redis_prefix
+      @redis = redis
       @bucket_range = @duration / BUCKETS
     end
 
@@ -25,7 +20,7 @@ module Logster
       return unless @severities.include?(severity)
       time = Time.now.to_i
       num = bucket_number(time)
-      redis_key = "#{@key}:#{num}"
+      redis_key = "#{key}:#{num}"
 
       current_rate = @redis.eval <<-LUA
         local bucket_number = #{num}
@@ -48,20 +43,32 @@ module Logster
         return (retrieve_rate() + bucket_count)
       LUA
 
-      if !@redis.get(@callback_key) && (current_rate >= @limit)
+      if !@redis.get(callback_key) && (current_rate >= @limit)
         @callback.call(current_rate) if @callback
-        @redis.set(@callback_key, 1)
+        @redis.set(callback_key, 1)
       end
 
       current_rate
     end
 
+    def key
+      # "_LOGSTER_RATE_LIMIT:012:20:30"
+      # Triggers callback when log levels of :debug, :info and :warn occurs 20 times within 30 secs
+      "#{key_prefix}:#{@severities.join("")}:#{@limit}:#{@duration}"
+    end
+
+    def callback_key
+      "#{@key}:callback_triggered"
+    end
+
     private
 
     def key_prefix
-      prefix = "__LOGSTER__RATE_LIMIT:".freeze
-      prefix = "#{Logster.config.redis_prefix}:#{prefix}" if use_raw_connection?
-      prefix
+      if @redis_prefix
+        "#{@redis_prefix.call}:#{PREFIX}"
+      else
+        PREFIX
+      end
     end
 
     def mget_keys(bucket_num)
@@ -78,15 +85,12 @@ module Logster
     def bucket_expiry(time)
       @duration - ((time % @duration) % @bucket_range)
     end
-
-    def use_raw_connection?
-      Logster.config.redis_prefix && Logster.config.redis_raw_connection
-    end
   end
 
   class RedisStore < BaseStore
 
-    attr_accessor :redis, :max_backlog
+    attr_accessor :redis, :max_backlog, :redis_raw_connection
+    attr_writer :redis_prefix
 
     def initialize(redis = nil)
       super()
@@ -269,10 +273,16 @@ module Logster
       register_rate_limit(severities, limit, 3600, block)
     end
 
+    def redis_prefix
+      return 'default'.freeze if !@redis_prefix
+      @prefix_is_proc ||= @redis_prefix.respond_to?(:call)
+      @prefix_is_proc ? @redis_prefix.call : @redis_prefix
+    end
+
     protected
 
     def rate_limits
-      @rate_limits ||= []
+      @rate_limits ||= {}
     end
 
     def clear_solved(count = nil)
@@ -395,7 +405,9 @@ module Logster
     end
 
     def check_rate_limits(severity)
-      rate_limits.each { |rate_limit| rate_limit.check(severity) }
+      rate_limits_to_check = rate_limits[self.redis_prefix]
+      return if !rate_limits_to_check
+      rate_limits_to_check.each { |rate_limit| rate_limit.check(severity) }
     end
 
     def solved_key
@@ -422,8 +434,14 @@ module Logster
 
     def register_rate_limit(severities, limit, duration, callback)
       severities = [severities] unless severities.is_a?(Array)
-      rate_limiter = RedisRateLimiter.new(@redis, severities, limit, duration, callback)
-      rate_limits << rate_limiter
+      redis = (@redis_raw_connection && @redis_prefix) ? @redis_raw_connection : @redis
+
+      rate_limiter = RedisRateLimiter.new(
+        redis, severities, limit, duration, Proc.new { redis_prefix }, callback
+      )
+
+      rate_limits[self.redis_prefix] ||= []
+      rate_limits[self.redis_prefix] << rate_limiter
       rate_limiter
     end
   end

data/lib/logster/version.rb

@@ -1,3 +1,3 @@
 module Logster
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/test/logster/test_redis_rate_limiter.rb

@@ -17,7 +17,7 @@ class TestRedisRateLimiter < Minitest::Test
     called = 0
 
     @rate_limiter = Logster::RedisRateLimiter.new(
-      @redis, [Logger::WARN], 8, 60, Proc.new { called += 1 }
+      @redis, [Logger::WARN], 8, 60, nil, Proc.new { called += 1 }
     )
 
     assert_equal(1, @rate_limiter.check(Logger::WARN))
@@ -82,7 +82,7 @@ class TestRedisRateLimiter < Minitest::Test
     called = 0
 
     @rate_limiter = Logster::RedisRateLimiter.new(
-      @redis, [Logger::WARN, Logger::ERROR], 4, 60, Proc.new { called += 1 }
+      @redis, [Logger::WARN, Logger::ERROR], 4, 60, nil, Proc.new { called += 1 }
     )
 
     assert_equal(1, @rate_limiter.check(Logger::WARN))
@@ -138,14 +138,19 @@ class TestRedisRateLimiter < Minitest::Test
   def test_raw_connection
     time = Time.new(2015, 1, 1, 1, 1)
     Timecop.freeze(time)
-    Logster.config.redis_prefix = "lobster"
-    Logster.config.redis_raw_connection = @redis
-
-    @rate_limiter = Logster::RedisRateLimiter.new(nil, [Logger::WARN], 1, 60)
+    @rate_limiter = Logster::RedisRateLimiter.new(@redis, [Logger::WARN], 1, 60, Proc.new { "lobster" })
 
     assert_equal(1, @rate_limiter.check(Logger::WARN))
-    assert_includes(key, "lobster")
     assert_redis_key(60, 0)
+
+    array = ['lobster1', 'lobster2']
+
+    @rate_limiter = Logster::RedisRateLimiter.new(
+      @redis, [Logger::WARN], 1, 60, Proc.new { array.delete_at(0) }
+    )
+
+    assert_includes(key, "lobster1")
+    assert_includes(key, "lobster2")
   end
 
   private
@@ -172,7 +177,7 @@ class TestRedisRateLimiter < Minitest::Test
 
   def assert_redis_key(expected_ttl, expected_bucket_number)
     redis_key = "#{key}:#{expected_bucket_number}"
-    assert(@redis.get(redis_key))
+    assert(@redis.get(redis_key), "the right bucket should be created")
     assert_equal(expected_ttl, @redis.ttl(redis_key))
   end
 end

data/test/logster/test_redis_store.rb

@@ -326,19 +326,61 @@ class TestRedisStore < Minitest::Test
     assert_equal(orig, env)
   end
 
-  %w{minute hour}.each do |duration|
-    define_method "test_register_rate_limit_per_#{duration}" do
-      called = false
+  def test_rate_limits
+    %w{minute hour}.each do |duration|
+      begin
+        called = false
+
+        assert_instance_of(
+          Logster::RedisRateLimiter,
+          @store.public_send("register_rate_limit_per_#{duration}", Logger::WARN, 0) do
+            called = true
+          end
+        )
+
+        @store.report(Logger::WARN, "test", "test")
+        assert called
+      ensure
+        reset_redis
+      end
+    end
+  end
+
+  def test_rate_limits_with_prefix
+    begin
+      time = Time.now
+      Timecop.freeze(time)
+      current_namespace = 'first'
+      @store.redis_prefix = Proc.new { current_namespace }
+
+      called_first = 0
+      called_second = 0
 
-      assert_instance_of(
-        Logster::RedisRateLimiter,
-        @store.public_send("register_rate_limit_per_#{duration}", Logger::WARN, 0) do
-          called = true
-        end
-      )
+      @store.register_rate_limit_per_minute(Logger::WARN, 0) { called_first += 1 }
+      @store.report(Logger::WARN, "test", "test")
+      assert_equal(1, called_first)
 
+      current_namespace = 'second'
+      @store.register_rate_limit_per_minute(Logger::WARN, 0) { called_second += 1 }
       @store.report(Logger::WARN, "test", "test")
-      assert called
+      assert_equal(1, called_first)
+      assert_equal(1, called_second)
+
+      Timecop.freeze(time + 10) do
+        current_namespace = 'first'
+        @store.report(Logger::WARN, "test", "test")
+
+        assert_equal(2, called_first)
+        assert_equal(1, called_second)
+      end
+    ensure
+      reset_redis
     end
   end
+
+  private
+
+  def reset_redis
+    @store.redis.flushall
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logster
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - UI for viewing logs in Rack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-22 00:00:00.000000000 Z
+date: 2016-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler