whi-cassie 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9d4c5447b529444d74ac1b8a6e6338d9c660145
-  data.tar.gz: eb3200d97d7e47df2924fce8e5656be10d124225
+  metadata.gz: 8392ef6b34920bdde8a689495610115ba637c300
+  data.tar.gz: ccf179a324199af0f1af5c81589634efc44f89a5
 SHA512:
-  metadata.gz: 21dc7bb268c060c599a09cb494ec9babd339f52f745218f537f4133b1cf3d3b9330fb2e4cb121e3ce980386d13f23796abb1f60acb894aef685564b56c0230d7
-  data.tar.gz: 9317ae5bfe173d748eb75e914ac2fb6b66bbcbd9cf2161ff186975c27920b40f42e4ed6017541288bf40bb014039e14c468bd67fc94edc9a1c57b23d8af43655
+  metadata.gz: 715926f6cead3063ea00a364c0b7f30f67c0cf81be18288a78dd16431d95d2496fa845d928afdfd3b206dea78efb6e9d45a41c943d332a138f47225066c4d5da
+  data.tar.gz: 2da40bc6fbc2c2c02594c76cc8c719c495db90a5b5983cf791e0b243bf47ce21e85d693c53398b051b4576479bb46c9467e25b60e5caac4d203266617c07ab18

data/HISTORY.txt

@@ -1,3 +1,9 @@
+1.0.5
+
+Add subscribers for instumenting code.
+
+Remove hardcoded log warnings for long running statements since this can now be better handled with instrumentation.
+
 1.0.4
 
 Set less cryptic error message for invalid records exceptions.

data/README.md

@@ -204,6 +204,14 @@ end
 
 You'll need something similar on other web servers. In any case, you'll want to make sure that you call Cassie.instance.connect in an initializer. It can take several seconds to establish the connection so you really want the connection to created before your server starts accepting traffic.
 
+### Instrumentation
+
+You can add instrumentation via subscribers to the `Cassie.instance`. Subscribers must respond to the `call` method and take a single argument which will be a Cassie::Message object which has the `statement`, `options`, and `elapsed_time`.
+
+```
+Cassie.instance.subscribers << lambda{|message| logger.warn("CQL: #{message.statement.cql} with #{message.options} took #{message.elapsed_time}s") if message.elapsed_time > 0.5 && message.statement.cql}
+```
+
 ### Limitations
 
 Ruby 2.0 (or compatible) required.

data/VERSION

@@ -1 +1 @@
-1.0.4
+1.0.5

data/lib/cassie.rb

@@ -21,7 +21,20 @@ class Cassie
     end
   end
   
-  attr_reader :config
+  # Message passed to subscribers with the statement, options, and time for each statement
+  # to execute. Note that if statements are batched they will be packed into one message
+  # with a Cassandra::Statements::Batch statement and empty options.
+  class Message
+    attr_reader :statement, :options, :elapsed_time
+    
+    def initialize(statement, options, elapsed_time)
+      @statement = statement
+      @options = options
+      @elapsed_time = elapsed_time
+    end
+  end
+  
+  attr_reader :config, :subscribers
   
   class << self
     # A singleton instance that can be shared to communicate with a Cassandra cluster.
@@ -75,6 +88,7 @@ class Cassie
     @session = nil
     @prepared_statements = {}
     @last_prepare_warning = Time.now
+    @subscribers = []
   end
   
   # Open a connection to the Cassandra cluster.
@@ -272,15 +286,15 @@ class Cassie
       if default_consistency
         options = (options ? options.reverse_merge(:consistency => default_consistency) : {:consistency => default_consistency})
       end
-    
+      
       session.execute(statement, options || {})
     rescue Cassandra::Errors::IOError => e
       disconnect
       raise e
     ensure
-      elapsed = Time.now - start_time
-      if elapsed >= 0.5 && logger
-        logger.warn("Slow CQL Query (#{(elapsed * 1000).round}ms): #{cql}#{' with ' + values.inspect unless values.blank?}")
+      unless subscribers.empty?
+        payload = Message.new(statement, options, Time.now - start_time)
+        subscribers.each{|subscriber| subscriber.call(payload)}
       end
     end
   end
@@ -321,4 +335,17 @@ class Cassie
     end
     [cql.join(' AND '), values]
   end
+  
+  # Extract the CQL from a statement
+  def statement_cql(statement, previous = nil)
+    cql = nil
+    if statement.respond_to?(:cql)
+      cql = statement.cql
+    elsif statement.respond_to?(:statements) && (previous.nil? || !previous.include?(statement))
+      previous ||= []
+      previous << statement
+      cql = statement.statements.collect{|s| statement_cql(s, previous)}.join('; ')
+    end
+    cql
+  end
 end

data/spec/cassie_spec.rb

@@ -120,6 +120,33 @@ describe Cassie do
     it "should prepare and execute a CQL statement when values are provided" do
       instance.execute("SELECT owner, id, val FROM #{table} WHERE owner = ?", [1]).size.should == 1
     end
+    
+    it "should call subscribers with details about the call" do
+      instance.subscribers.clear
+      begin
+        messages = []
+        instance.subscribers << lambda{|details| messages << details}
+
+        instance.execute("SELECT owner, id, val FROM #{table} WHERE owner = ?", [1])
+        messages.size.should == 1
+        message = messages.shift
+        message.statement.should be_a(Cassandra::Statement)
+        message.options.should == {:arguments => [1]}
+        message.elapsed_time.should be_a(Float)
+
+        instance.batch do
+          instance.insert(table, :owner => 1, :id => 2, :val => 'foo')
+          instance.delete(table, :owner => 1)
+        end
+        messages.size.should == 1
+        message = messages.shift
+        message.statement.should be_a(Cassandra::Statements::Batch)
+        message.options.should == nil
+        message.elapsed_time.should be_a(Float)
+      ensure
+        instance.subscribers.clear
+      end
+    end
   end
   
   describe "consistency" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whi-cassie
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - We Heart It
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cassandra-driver