oboe 1.3.4 → 1.3.5

data/ext/oboe_metal/extconf.rb

@@ -2,6 +2,7 @@
 # All rights reserved.
 
 require 'mkmf'
+dir_config('oboe')
 
 if have_library('oboe')
   $libs = append_library($libs, "oboe")

data/lib/oboe/api/logging.rb

@@ -82,11 +82,13 @@ module Oboe
         xtrace
       end
   
-      def log_entry(layer, opts={})
+      def log_entry(layer, opts={}, protect_op=false)
+        Oboe::Context.layer_op = opts[:Op] if protect_op and opts.has_key?(:Op)
         log_event(layer, 'entry', Oboe::Context.createEvent, opts)
       end
 
-      def log_exit(layer, opts={})
+      def log_exit(layer, opts={}, protect_op=false)
+        Oboe::Context.layer_op = nil if protect_op
         log_event(layer, 'exit', Oboe::Context.createEvent, opts)
       end
   

data/lib/oboe/api/tracing.rb

@@ -10,7 +10,7 @@ module Oboe
       #
       # layer - The layer the block of code belongs to.
       # opts - A hash containing key/value pairs that will be reported along
-      #        with the first event of this layer (optional).
+      # with the first event of this layer (optional).
       #
       # Example
       #
@@ -28,18 +28,18 @@ module Oboe
       #   result = computation_with_oboe(1000)
       #
       # Returns the result of the block.
-      def trace(layer, opts={})
-        log_entry(layer, opts)
+      def trace(layer, opts={}, protect_op=false)
+        log_entry(layer, opts, protect_op)
         begin 
           yield
         rescue Exception => e
           log_exception(layer, e)
           raise
         ensure
-          log_exit(layer)
+          log_exit(layer, {}, protect_op)
         end
       end
-  
+
       # Public: Trace a given block of code which can start a trace depending
       # on configuration and probability. Detect any exceptions thrown by the
       # block and report errors.
@@ -49,7 +49,7 @@ module Oboe
       #
       # layer - The layer the block of code belongs to.
       # opts - A hash containing key/value pairs that will be reported along
-      #        with the first event of this layer (optional).
+      # with the first event of this layer (optional).
       #
       # Example
       #
@@ -89,7 +89,7 @@ module Oboe
       # on configuration and probability. Detect any exceptions thrown by the
       # block and report errors. Insert the oboe metadata into the provided for
       # later user.
-      # 
+      #
       # The motivating use case for this is HTTP streaming in rails3. We need
       # access to the exit event's trace id so we can set the header before any
       # work is done, and before any headers are sent back to the client.
@@ -97,7 +97,7 @@ module Oboe
       # layer - The layer the block of code belongs to.
       # target - The target object in which to place the oboe metadata.
       # opts - A hash containing key/value pairs that will be reported along
-      #        with the first event of this layer (optional).
+      # with the first event of this layer (optional).
       #
       # Example:
       #

data/lib/oboe/frameworks/rails/inst/active_record.rb

@@ -9,7 +9,8 @@ module Oboe
           opts = {}
 
           opts[:Query] = sql.to_s
-          opts[:Name] = name.to_s if name 
+          opts[:Name] = name.to_s if name
+          opts[:Backtrace] = Oboe::API.backtrace
 
           if defined?(ActiveRecord::Base.connection.cfg)
             opts[:Database] = ActiveRecord::Base.connection.cfg[:database]

data/lib/oboe/frameworks/rails/inst/cassandra.rb

@@ -0,0 +1,301 @@
+# Copyright (c) 2012 by Tracelytics, Inc.
+# All rights reserved.
+
+module Oboe
+  module Inst
+    module Cassandra
+      def extract_trace_details(op, column_family, keys, args, options = {})
+        report_kvs = {}
+
+        begin
+          report_kvs[:Op] = op.to_s
+          report_kvs[:Cf] = column_family.to_s
+          report_kvs[:Key] = keys.to_s if keys
+         
+          # Open issue - how to handle multiple Cassandra servers
+          report_kvs[:RemoteHost], report_kvs[:RemotePort] = @servers.first.split(":")
+
+          if options.empty? and args.is_a?(Array)
+            options = args.last if args.last.is_a?(Hash)
+          end
+          
+          unless options.empty?
+            [:start_key, :finish_key, :key_count, :batch_size, :columns, :count, :start,
+             :stop, :finish, :finished, :reversed, :consistency, :ttl].each do |k|
+              report_kvs[k.capitalize] = options[k] if options.has_key?(k)
+            end
+
+            if op == :get_indexed_slices
+              index_clause = columns_and_options[:index_clause] || {}
+              unless index_clause.empty?
+                [:column_name, :value, :comparison].each do |k|
+                  report_kvs[k.capitalize] = index_clause[k] if index_clause.has_key?(k)
+                end
+              end
+            end
+          end
+        rescue
+        end
+
+        report_kvs
+      end
+
+      def insert_with_oboe(column_family, key, hash, options = {})
+        if Oboe::Config.tracing?
+          report_kvs = extract_trace_details(:insert, column_family, key, hash, options)
+
+          Oboe::API.trace('cassandra', report_kvs) do
+            insert_without_oboe(column_family, key, hash, options = {})
+          end
+        else
+          insert_without_oboe(column_family, key, hash, options = {})
+        end
+      end
+
+      def remove_with_oboe(column_family, key, *columns_and_options)
+        args = [column_family, key] + columns_and_options
+        
+        if Oboe::Config.tracing?
+          report_kvs = extract_trace_details(:remove, column_family, key, columns_and_options)
+
+          Oboe::API.trace('cassandra', report_kvs) do
+            send :remove_without_oboe, *args
+          end
+        else
+          send :remove_without_oboe, *args
+        end
+      end
+
+      def count_columns_with_oboe(column_family, key, *columns_and_options)
+        args = [column_family, key] + columns_and_options
+        
+        if Oboe::Config.tracing?
+          report_kvs = extract_trace_details(:count_columns, column_family, key, columns_and_options)
+
+          Oboe::API.trace('cassandra', report_kvs) do
+            send :count_columns_without_oboe, *args
+          end
+        else
+          send :count_columns_without_oboe, *args
+        end
+      end
+      
+      def get_columns_with_oboe(column_family, key, *columns_and_options)
+        args = [column_family, key] + columns_and_options
+        
+        if Oboe::Config.tracing? and not Oboe::Context.layer_op?(:multi_get_columns)
+          report_kvs = extract_trace_details(:get_columns, column_family, key, columns_and_options)
+
+          Oboe::API.trace('cassandra', report_kvs) do
+            send :get_columns_without_oboe, *args
+          end
+        else
+          send :get_columns_without_oboe, *args
+        end
+      end
+      
+      def multi_get_columns_with_oboe(column_family, key, *columns_and_options)
+        args = [column_family, key] + columns_and_options
+        
+        if Oboe::Config.tracing?
+          report_kvs = extract_trace_details(:multi_get_columns, column_family, key, columns_and_options)
+
+          Oboe::API.trace('cassandra', report_kvs, true) do
+            send :multi_get_columns_without_oboe, *args
+          end
+        else
+          send :multi_get_columns_without_oboe, *args
+        end
+      end
+
+      def get_with_oboe(column_family, key, *columns_and_options)
+        args = [column_family, key] + columns_and_options
+        
+        if Oboe::Config.tracing?
+          report_kvs = extract_trace_details(:get, column_family, key, columns_and_options)
+
+          Oboe::API.trace('cassandra', report_kvs, true) do
+            send :get_without_oboe, *args
+          end
+        else
+          send :get_without_oboe, *args
+        end
+      end
+      
+      def multi_get_with_oboe(column_family, key, *columns_and_options)
+        args = [column_family, key] + columns_and_options
+        
+        if Oboe::Config.tracing? and not Oboe::Context.layer_op?(:get)
+          report_kvs = extract_trace_details(:multi_get, column_family, key, columns_and_options)
+
+          Oboe::API.trace('cassandra', report_kvs) do
+            send :multi_get_without_oboe, *args
+          end
+        else
+          send :multi_get_without_oboe, *args
+        end
+      end
+
+      def exists_with_oboe?(column_family, key, *columns_and_options)
+        args = [column_family, key] + columns_and_options
+        
+        if Oboe::Config.tracing?
+          report_kvs = extract_trace_details(:exists?, column_family, key, columns_and_options)
+
+          Oboe::API.trace('cassandra', report_kvs) do
+            send :exists_without_oboe?, *args
+          end
+        else
+          send :exists_without_oboe?, *args
+        end
+      end
+      
+      def get_range_single_with_oboe(column_family, options = {})
+        if Oboe::Config.tracing? and not Oboe::Context.layer_op?(:get_range_batch)
+          report_kvs = extract_trace_details(:get_range_single, column_family, nil, nil)
+          args = [column_family, options]
+
+          Oboe::API.trace('cassandra', report_kvs) do
+            get_range_single_without_oboe(column_family, options)
+          end
+        else
+          get_range_single_without_oboe(column_family, options)
+        end
+      end
+      
+      def get_range_batch_with_oboe(column_family, options = {})
+        if Oboe::Config.tracing?
+          report_kvs = extract_trace_details(:get_range_batch, column_family, nil, nil)
+          args = [column_family, options]
+
+          Oboe::API.trace('cassandra', report_kvs, true) do
+            get_range_batch_without_oboe(column_family, options)
+          end
+        else
+          get_range_batch_without_oboe(column_family, options)
+        end
+      end
+      
+      def get_indexed_slices_with_oboe(column_family, index_clause, *columns_and_options)
+        args = [column_family, index_clause] + columns_and_options
+        
+        if Oboe::Config.tracing?
+          report_kvs = extract_trace_details(:get_indexed_slices, column_family, nil, columns_and_options)
+
+          Oboe::API.trace('cassandra', report_kvs) do
+            send :get_indexed_slices_without_oboe, *args
+          end
+        else
+          send :get_indexed_slices_without_oboe, *args
+        end
+      end
+
+      def create_index_with_oboe(keyspace, column_family, column_name, validation_class)
+        if Oboe::Config.tracing?
+          report_kvs = extract_trace_details(:create_index, column_family, nil, nil)
+          report_kvs[:Keyspace] = keyspace.to_s
+          report_kvs[:Column_name] = column_name.to_s
+          report_kvs[:Validation_class] = validation_class.to_s
+
+          Oboe::API.trace('cassandra', report_kvs) do
+            create_index_without_oboe(keyspace, column_family, column_name, validation_class)
+          end
+        else
+          create_index_without_oboe(keyspace, column_family, column_name, validation_class)
+        end
+      end
+
+      def drop_index_with_oboe(keyspace, column_family, column_name)
+        if Oboe::Config.tracing?
+          report_kvs = extract_trace_details(:drop_index, column_family, nil, nil)
+          report_kvs[:Keyspace] = keyspace.to_s
+          report_kvs[:Column_name] = column_name.to_s
+
+          Oboe::API.trace('cassandra', report_kvs) do
+            drop_index_without_oboe(keyspace, column_family, column_name)
+          end
+        else
+          drop_index_without_oboe(keyspace, column_family, column_name)
+        end
+      end
+
+      def add_column_family_with_oboe(cf_def)
+        if Oboe::Config.tracing?
+          report_kvs = extract_trace_details(:add_column_family, nil, nil, nil)
+          report_kvs[:Name] = cf_def[:name] if cf_def.is_a?(Hash) and cf_def.has_key?(:name)
+
+          Oboe::API.trace('cassandra', report_kvs) do
+            add_column_family_without_oboe(cf_def)
+          end
+        else
+          add_column_family_without_oboe(cf_def)
+        end
+      end
+      
+      def drop_column_family_with_oboe(column_family)
+        if Oboe::Config.tracing?
+          report_kvs = extract_trace_details(:drop_column_family, column_family, nil, nil)
+
+          Oboe::API.trace('cassandra', report_kvs) do
+            drop_column_family_without_oboe(column_family)
+          end
+        else
+          drop_column_family_without_oboe(column_family)
+        end
+      end
+      
+      def add_keyspace_with_oboe(ks_def)
+        if Oboe::Config.tracing?
+          report_kvs = extract_trace_details(:add_keyspace, nil, nil, nil)
+          report_kvs[:Name] = ks_def[:name] if ks_def.is_a?(Hash) and ks_def.has_key?(:name)
+
+          Oboe::API.trace('cassandra', report_kvs) do
+            add_keyspace_without_oboe(ks_def)
+          end
+        else
+          add_keyspace_without_oboe(ks_def)
+        end
+      end
+      
+      def drop_keyspace_with_oboe(keyspace)
+        if Oboe::Config.tracing?
+          report_kvs = extract_trace_details(:drop_keyspace, nil, nil, nil)
+          report_kvs[:Name] = keyspace.to_s
+
+          Oboe::API.trace('cassandra', report_kvs) do
+            drop_keyspace_without_oboe(keyspace)
+          end
+        else
+          drop_keyspace_without_oboe(keyspace)
+        end
+      end
+    end
+  end
+end
+
+if defined?(::Cassandra)
+  puts "[oboe/loading] Instrumenting Cassandra"
+  class ::Cassandra
+    include Oboe::Inst::Cassandra
+
+    [ :insert, :remove, :count_columns, :get_columns, :multi_get_columns, :get, 
+      :multi_get, :get_range_single, :get_range_batch, :get_indexed_slices,
+      :create_index, :drop_index, :add_column_family, :drop_column_family,
+      :add_keyspace, :drop_keyspace].each do |m|
+      if method_defined?(m)
+        class_eval "alias #{m}_without_oboe #{m}"
+        class_eval "alias #{m} #{m}_with_oboe"
+      else puts "[oboe/loading] Couldn't properly instrument Cassandra (#{m}).  Partial traces may occur."
+      end
+    end
+
+    # Special case handler for question mark methods
+    if method_defined?(:exists?)
+      alias exists_without_oboe? exists?
+      alias exists? exists_with_oboe?
+    else puts "[oboe/loading] Couldn't properly instrument Cassandra (exists?).  Partial traces may occur."
+    end
+  end # class Cassandra
+end
+
+

data/lib/oboe/version.rb

@@ -2,7 +2,7 @@ module Oboe
   module Version
     MAJOR = 1
     MINOR = 3
-    PATCH = 4
+    PATCH = 5
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/lib/oboe_metal.rb

@@ -16,6 +16,18 @@ module Oboe_metal
 
       Oboe.reporter.sendReport(evt)
     end
+
+    def self.layer_op=(op)
+      @layer_op = op.to_s
+    end
+
+    def self.layer_op
+      @layer_op
+    end
+
+    def self.layer_op?(operation)
+      @layer_op == operation.to_s
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oboe
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.5
   prerelease: 
 platform: ruby
 authors:
@@ -37,6 +37,7 @@ files:
 - lib/oboe/frameworks/rails/inst/action_controller.rb
 - lib/oboe/frameworks/rails/inst/dalli.rb
 - lib/oboe/frameworks/rails/inst/active_record.rb
+- lib/oboe/frameworks/rails/inst/cassandra.rb
 - lib/oboe/frameworks/rails/inst/memcached.rb
 - lib/oboe/frameworks/rails/rails.rb
 - lib/oboe_fu.rb