lockistics 0.1.0 → 0.1.1

data/README.md

@@ -4,7 +4,7 @@ Lockistics is basically a distributed mutex on Redis with statistics collecting
 
 The likely use case for locking would be something like a Raketask that you don't want running multiple instances at once.
 
-The likely use case for the statistics part would be that you want to how often something is being called or if a certain Raketask has been run today or not. You can also use it to find memory leaks or slow methods, kind of private NewRelic with zero features.
+The likely use case for the statistics part would be that you want to know how often something is being called or if a certain Raketask has been run today or not. You can also use it to find memory leaks or slow methods, kind of private NewRelic with zero features.
 
 ## Installation
 
@@ -51,10 +51,11 @@ These are the default settings :
   Lockistics.configure do |config|
     config.redis                = Redis.new
     config.namespace            = "lockistics"
-    config.expire               = 300  # seconds
-    config.sleep                = 0.5  # seconds to sleep between retries
-    config.retries              = 10   # retry times
-    config.raise                = true # raise Lockistics::TimeoutException when lock fails
+    config.expire               = 300   # seconds
+    config.sleep                = 0.5   # seconds to sleep between retries
+    config.retries              = 10    # retry times
+    config.raise                = true  # raise Lockistics::TimeoutException when lock fails
+    config.pass_through         = false # don't do anything, let everything pass through
   end
 ```
 
@@ -161,6 +162,16 @@ You can query statistics for locking/metering keys.
         :last_run:time => #<Time..>}
 ```
 
+## Storage
+
+- All keys are prefixed with the `configuration.namespace`
+- namespace.KEY_NAME.lock for lock
+- namespace.KEY_NAME.dailies is a sorted set with timestamps
+- namespace.KEY_NAME.daily.TIMESTAMP is a hash with keys like "invocations", "max.time"
+- same goes for hourlies (but with hourly + hourlies in the key)
+- namespace.KEY_NAME.total has all time stats for the key
+- namespace.known_keys is a sorted set of known keys
+
 ## Contributing
 
 1. Fork it

data/lib/lockistics/configuration.rb

@@ -10,13 +10,15 @@ module Lockistics
     attr_accessor :sleep
     attr_accessor :retries
     attr_accessor :raise
+    attr_accessor :pass_through
 
     def initialize
-      @redis     = Redis.new
-      @namespace = 'lockistics'
-      @expire    = 10
-      @sleep     = 0.5
-      @retries   = 10
+      @redis        = Redis.new
+      @namespace    = 'lockistics'
+      @expire       = 10
+      @sleep        = 0.5
+      @retries      = 10
+      @pass_through = false
     end
 
     def lock_defaults

data/lib/lockistics/lock.rb

@@ -17,6 +17,7 @@ module Lockistics
     end
 
     def acquire_lock
+      return true if options[:pass_through]
       Lockistics.known_keys(key)
       if got_lock?
         true
@@ -46,6 +47,7 @@ module Lockistics
     end
 
     def release_lock
+      return true if options[:pass_through]
       @exceeded_before_release = redis.del(namespaced_key) == 0
     end
 

data/lib/lockistics/meter.rb

@@ -1,6 +1,12 @@
 require 'os'
 
 module Lockistics
+  class DummyMeter
+    def method_missing(*args, &block)
+      # do nothing
+    end
+  end
+
   class Meter
 
     attr_accessor :key, :options
@@ -27,7 +33,7 @@ module Lockistics
 
     def initialize(key, options={})
       @key     = key
-      @options = options
+      @options = {:pass_through => Lockistics.configuration.pass_through}.merge(options)
       @lock_timeouts = 0
     end
 
@@ -42,13 +48,17 @@ module Lockistics
 
     def perform(&block)
       raise ArgumentError, "perform called without block" unless block_given?
-      before_perform
-      lock.nil? ? yield(self) : with_lock(&block)
+      if options[:pass_through]
+        yield DummyMeter.new
+      else
+        before_perform
+        lock.nil? ? yield(self) : with_lock(&block)
+      end
     rescue Lockistics::LockTimeout
       @lock_timeouts = 1
       raise
     ensure
-      after_perform
+      after_perform unless options[:pass_through]
     end
 
     # You can add custom metrics during runtime

data/lib/lockistics/version.rb

@@ -1,3 +1,3 @@
 module Lockistics
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/lockistics.rb

@@ -27,10 +27,11 @@ module Lockistics
   #   Lockistics.configure do |config|
   #     config.redis                = Redis.new
   #     config.namespace            = "production.locks"
-  #     config.expire               = 300  # seconds
-  #     config.sleep                = 0.5  # seconds to sleep between retries
-  #     config.retries              = 10   # retry times
-  #     config.raise                = true # raise Lockistics::TimeoutException when lock fails
+  #     config.expire               = 300   # seconds
+  #     config.sleep                = 0.5   # seconds to sleep between retries
+  #     config.retries              = 10    # retry times
+  #     config.raise                = true  # raise Lockistics::TimeoutException when lock fails
+  #     config.pass_through         = false # don't do anything, just pass everything through
   #   end
   def self.configure(&block)
     yield configuration

data/lockistics.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Lockistics::VERSION
   spec.authors       = ["Kimmo Lehto"]
   spec.email         = ["kimmo.lehto@gmail.com"]
-  spec.description   = %q{Statsistics collecting locking}
+  spec.description   = %q{Statsistics collecting shared mutex on Redis}
   spec.summary       = %q{With lockistics you can use Redis to create distributed locks and collect statistics how often and how long your locks are held}
   spec.homepage      = "https://github.com/kke/lockistics"
   spec.license       = "MIT"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lockistics
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Kimmo Lehto
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-05-19 00:00:00 Z
+date: 2014-05-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -102,7 +102,7 @@ dependencies:
   prerelease: false
   type: :development
   requirement: *id006
-description: Statsistics collecting locking
+description: Statsistics collecting shared mutex on Redis
 email: 
 - kimmo.lehto@gmail.com
 executables: []