cql-instrumentation 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1fbcc065324776bdf9ce523c916a1f12ba1084cb
+  data.tar.gz: 0eddb84b1b1941a6de1c2e09b337d7d07d45216e
+SHA512:
+  metadata.gz: 2006513b5f6797723cb5f1ed3c79f3deed9c450ef365ffa9fa64ec567e68e099d73e17422bb67a8f5b9664e52d2b6b9e61d427f9e4738d83e08a9a1fa59114e1
+  data.tar.gz: 6abd308b4470b7c5e0ed35caa90612c60301ec5c60680a96513fdfb5456d907722ca35d1c82c0faa5b11b80f81dafe23c57a17e34b02688b125425d9df2a4361

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cql-instrumentation.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nikita Afanasenko
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# Cassandra CQL Instrumentations
+
+Performs logging for [cql-rb](https://github.com/iconara/cql-rb) queries and durations similar to ActiveRecord logging for SQL queries.
+
+Example logs:
+
+```
+Cassandra Query (34.1ms)  SELECT * FROM timeseries WHERE name = ?  ["counts"]
+Completed 200 OK in 141ms (Views: 7.8ms | ActiveRecord: 0.0ms | Cassandra: 117.3ms)
+```
+
+## Usage With Rails
+
+All you need to do is to add this line to your application's Gemfile:
+
+```
+gem 'cql-instrumentation'
+```
+
+## Usage Without Rails
+
+If you want to use this logging without Rails, setup it manually:
+
+```ruby
+ActiveSupport::LogSubscriber.logger = mylogger
+CqlInstrumentation.setup_instrumentation
+CqlInstrumentation.attach_log_subscriber
+```
+
+Full example:
+
+```ruby
+require 'cql'
+require 'cql/instrumentation'
+require 'logger'
+
+logger = Logger.new(STDOUT)
+ActiveSupport::LogSubscriber.logger = logger
+
+CqlInstrumentation.setup_instrumentation
+CqlInstrumentation.attach_log_subscriber
+
+Cql::Client.connect.execute('SELECT * FROM timeseries WHERE name = ?', 'counts')
+```
+
+And you'll get:
+
+```
+Cassandra Query (1.7ms)  SELECT * FROM timeseries WHERE name = ?  ["counts"]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/cql-instrumentation/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/cql-instrumentation.gemspec

@@ -0,0 +1,22 @@
+require_relative 'lib/cql_instrumentation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cql-instrumentation"
+  spec.version       = CqlInstrumentation::VERSION
+  spec.authors       = ["Nikita Afanasenko"]
+  spec.email         = ["nikita@afanasenko.name"]
+  spec.summary       = %q{CQL queries and durations logging for cql-rb and Rails}
+  spec.homepage      = "https://github.com/spbtv/cql-instrumentation"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", "~> 4.0"
+  spec.add_runtime_dependency "cql-rb", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/cql/instrumentation.rb

@@ -0,0 +1 @@
+require 'cql_instrumentation'

data/lib/cql_instrumentation.rb

@@ -0,0 +1,35 @@
+require 'active_support/notifications'
+require 'active_support/core_ext/module/aliasing'
+
+module CqlInstrumentation
+  SERVICE_ID = :cassandra
+
+  class << self
+    def setup_instrumentation
+      instrument(Cql::Client::SynchronousClient)
+    end
+
+    def attach_log_subscriber
+      LogSubscriber.attach_to(SERVICE_ID)
+    end
+
+    private
+
+    def instrument(klass)
+      klass.class_eval do
+        def execute_with_instrumentation(cql, *binds)
+          ActiveSupport::Notifications.instrument("query.#{SERVICE_ID}", cql: cql, binds: binds) do
+            execute_without_instrumentation(cql, *binds)
+          end
+        end
+
+        alias_method_chain :execute, :instrumentation unless method_defined?(:execute_without_instrumentation)
+      end
+    end
+  end
+
+  require_relative 'cql_instrumentation/version'
+  require_relative 'cql_instrumentation/log_subscriber'
+  require_relative 'cql_instrumentation/controller_runtime'
+  require_relative 'cql_instrumentation/railtie' if defined?(Rails)
+end

data/lib/cql_instrumentation/controller_runtime.rb

@@ -0,0 +1,22 @@
+require 'active_support/concern'
+
+module CqlInstrumentation
+  module ControllerRuntime
+    extend ActiveSupport::Concern
+
+    protected
+
+    def append_info_to_payload(payload)
+      super
+      payload[:cassandra_runtime] = LogSubscriber.reset_runtime
+    end
+
+    module ClassMethods
+      def log_process_action(payload)
+        messages, cassandra_runtime = super, payload[:cassandra_runtime]
+        messages << "Cassandra: #{cassandra_runtime.round(1)}ms" if cassandra_runtime
+        messages
+      end
+    end
+  end
+end

data/lib/cql_instrumentation/log_subscriber.rb

@@ -0,0 +1,45 @@
+require 'active_support/per_thread_registry'
+require 'active_support/log_subscriber'
+
+module CqlInstrumentation
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    cattr_accessor :calculate_runtime
+
+    def query(event)
+      self.class.runtime += event.duration if self.class.calculate_runtime
+      return unless logger.debug?
+
+      cql = event.payload[:cql]
+      binds = event.payload[:binds]
+      name = "Cassandra Query (#{event.duration.round(1)}ms)"
+      debug "  #{color(name, YELLOW, true)}  #{color(cql, nil, true)}  #{binds.any? ? binds.inspect : nil}"
+    end
+
+    def self.runtime=(value)
+      RuntimeRegistry.cql_runtime = value
+    end
+
+    def self.runtime
+      RuntimeRegistry.cql_runtime ||= 0
+    end
+
+    def self.reset_runtime
+      rt, self.runtime = runtime, 0
+      rt
+    end
+  end
+
+  class RuntimeRegistry
+    extend ActiveSupport::PerThreadRegistry
+
+    attr_accessor :cql_runtime
+
+    def self.cql_runtime
+      instance.cql_runtime
+    end
+
+    def self.cql_runtime=(val)
+      instance.cql_runtime = val
+    end
+  end
+end

data/lib/cql_instrumentation/railtie.rb

@@ -0,0 +1,13 @@
+module CqlInstrumentation
+  class Railtie < Rails::Railtie
+    initializer "cql_instrumentation" do
+      CqlInstrumentation.setup_instrumentation
+      CqlInstrumentation.attach_log_subscriber
+
+      ActiveSupport.on_load(:action_controller) do
+        include ControllerRuntime
+        LogSubscriber.calculate_runtime = true
+      end
+    end
+  end
+end

data/lib/cql_instrumentation/version.rb

@@ -0,0 +1,3 @@
+module CqlInstrumentation
+  VERSION = "1.0"
+end

data/test/cql_instrumentation_test.rb

@@ -0,0 +1,39 @@
+require 'minitest/autorun'
+require_relative '../lib/cql_instrumentation'
+require 'logger'
+
+class CqlInstrumentationTest < Minitest::Test
+  class FakeLogger < Logger
+    attr_accessor :debug_called
+
+    def debug(*args)
+      self.debug_called = true
+      super
+    end
+  end
+
+  class FakeClient
+    def execute(cql, *binds)
+    end
+  end
+
+  CqlInstrumentation.send(:instrument, FakeClient)
+  CqlInstrumentation.attach_log_subscriber
+  CqlInstrumentation::LogSubscriber.calculate_runtime = true
+
+  def setup
+    @client = FakeClient.new
+    @logger = FakeLogger.new('/dev/null')
+    ActiveSupport::LogSubscriber.logger = @logger
+  end
+
+  def test_query_logging
+    @client.execute('SELECT * FROM timeseries WHERE value = ?', 1)
+    assert @logger.debug_called, 'Query was not logged'
+  end
+
+  def test_runtime_calculation
+    @client.execute('SELECT * FROM timeseries WHERE value = ?', 1)
+    assert CqlInstrumentation::LogSubscriber.reset_runtime > 0, 'Execution time was not calculated'
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: cql-instrumentation
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Nikita Afanasenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: cql-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 
+email:
+- nikita@afanasenko.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cql-instrumentation.gemspec
+- lib/cql/instrumentation.rb
+- lib/cql_instrumentation.rb
+- lib/cql_instrumentation/controller_runtime.rb
+- lib/cql_instrumentation/log_subscriber.rb
+- lib/cql_instrumentation/railtie.rb
+- lib/cql_instrumentation/version.rb
+- test/cql_instrumentation_test.rb
+homepage: https://github.com/spbtv/cql-instrumentation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: CQL queries and durations logging for cql-rb and Rails
+test_files:
+- test/cql_instrumentation_test.rb
+has_rdoc: