instana 0.12.0 → 0.12.1

data/README.md

@@ -7,6 +7,8 @@
 The Instana gem provides Ruby metrics and traces (request, queue & cross-host) for [Instana](https://www.instana.com/).
 
 [![Build Status](https://travis-ci.org/instana/ruby-sensor.svg?branch=master)](https://travis-ci.org/instana/ruby-sensor)
+[![Code
+Climate](https://codeclimate.com/github/instana/ruby-sensor/badges/gpa.svg)](https://codeclimate.com/github/instana/ruby-sensor)
 [![Gem Version](https://badge.fury.io/rb/instana.svg)](https://badge.fury.io/rb/instana)
 
 ## Note
@@ -15,6 +17,13 @@ This gem supports Ruby versions 2.0 or greater.
 
 Any and all feedback is welcome.  Happy Ruby visibility.
 
+![rails](https://s3.amazonaws.com/instana/rails-logo.jpg?1)
+![roda](https://s3.amazonaws.com/instana/roda-logo.png?1)
+![cuba](https://s3.amazonaws.com/instana/cuba-logo.png?1)
+![sinatra](https://s3.amazonaws.com/instana/sinatra-logo.png?1)
+![padrino](https://s3.amazonaws.com/instana/padrino-logo.png?1)
+![rack](https://s3.amazonaws.com/instana/rack-logo.png?1)
+
 ## Installation
 
 The gem is available on [Rubygems](https://rubygems.org/gems/instana).  To install, add this line to _the end_ of your application's Gemfile:

data/lib/instana/agent.rb

@@ -397,9 +397,9 @@ module Instana
       Net::HTTP.start(req.uri.hostname, req.uri.port, :open_timeout => 1, :read_timeout => 1) do |http|
         response = http.request(req)
       end
-      ::Instana.logger.agent_comm "#{req.method} Req -> -body-: #{req.uri} -> -#{req.body}- Resp -> body:#{response} -> -#{response.body}-"
+      ::Instana.logger.agent_comm "#{req.method}->#{req.uri} body:(#{req.body}) Response:#{response} body:(#{response.body})"
       response
-    rescue Errno::ECONNREFUSED => e
+    rescue Errno::ECONNREFUSED
       return nil
     rescue => e
       Instana.logger.error "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"

data/lib/instana/frameworks/cuba.rb

@@ -1,6 +1,6 @@
 require "instana/rack"
 
 if defined?(::Cuba)
-  ::Instana.logger.warn "Instana: Instrumenting Cuba"
+  ::Instana.logger.warn "Instrumenting Cuba"
   Cuba.use ::Instana::Rack
 end

data/lib/instana/frameworks/rails.rb

@@ -6,14 +6,14 @@ if defined?(::Rails)
 
   if ::Rails::VERSION::MAJOR < 3
     ::Rails.configuration.after_initialization do
-      ::Instana.logger.warn "Instana: Instrumenting Rack"
+      ::Instana.logger.warn "Instrumenting Rack"
       ::Rails.configuration.middleware.insert 0, ::Instana::Rack
     end
   else
     module ::Instana
       class Railtie < ::Rails::Railtie
         initializer 'instana.rack' do |app|
-          ::Instana.logger.warn "Instana: Instrumenting Rack"
+          ::Instana.logger.warn "Instrumenting Rack"
           app.config.middleware.insert 0, ::Instana::Rack
         end
       end

data/lib/instana/frameworks/roda.rb

@@ -1,6 +1,6 @@
 require "instana/rack"
 
 if defined?(::Roda)
-  ::Instana.logger.warn "Instana: Instrumenting Roda"
+  ::Instana.logger.warn "Instrumenting Roda"
   Roda.use ::Instana::Rack
 end

data/lib/instana/frameworks/sinatra.rb

@@ -4,6 +4,6 @@ require "instana/rack"
 # the latter is based on Sinatra
 
 if defined?(::Sinatra)
-  ::Instana.logger.warn "Instana: Instrumenting Sinatra"
+  ::Instana.logger.warn "Instrumenting Sinatra"
   ::Sinatra::Base.use ::Instana::Rack
 end

data/lib/instana/instrumentation.rb

@@ -1,25 +1,18 @@
-#
-# Load all of the files in the instrumentation subdirectory
-#
-pattern = File.join(File.dirname(__FILE__), 'instrumentation', '*.rb')
-Dir.glob(pattern) do |f|
-  begin
-    require f
-  rescue => e
-    Instana.logger.error "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
-    Instana.logger.debug e.backtrace.join("\r\n")
-  end
+module Instana
+  AUTOLOAD_DIRECTORIES = [:instrumentation, :frameworks].freeze
 end
 
 #
-# Load all of the files in the frameworks subdirectory
+# Load all of the files in the specified subdirectories
 #
-pattern = File.join(File.dirname(__FILE__), 'frameworks', '*.rb')
-Dir.glob(pattern) do |f|
-  begin
-    require f
-  rescue => e
-    Instana.logger.error "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
-    Instana.logger.debug e.backtrace.join("\r\n")
+::Instana::AUTOLOAD_DIRECTORIES.each do |d|
+  pattern = File.join(File.dirname(__FILE__), d.to_s, '*.rb')
+  Dir.glob(pattern) do |f|
+    begin
+      require f
+    rescue => e
+      Instana.logger.error "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
+      Instana.logger.debug e.backtrace.join("\r\n")
+    end
   end
 end

data/lib/instana/instrumentation/net-http.rb

@@ -43,7 +43,7 @@ Net::HTTP.class_eval {
     ::Instana.tracer.log_exit(:'net-http')
   end
 
-  Instana.logger.info "Instana: Instrumenting net/http"
+  Instana.logger.info "Instrumenting net/http"
 
   alias request_without_instana request
   alias request request_with_instana

data/lib/instana/tracing/span.rb

@@ -33,5 +33,9 @@ module Instana
     def raw
       @data
     end
+
+    def custom?
+      @data[:n] == :sdk
+    end
   end
 end

data/lib/instana/tracing/trace.rb

@@ -1,5 +1,7 @@
 module Instana
   class Trace
+    REGISTERED_SPANS = [ :rack, :'net-http' ]
+
     # @return [Integer] the ID for this trace
     attr_reader :id
 
@@ -31,14 +33,20 @@ module Instana
       # This is a new trace so open the first span with the proper
       # root span IDs.
       @current_span = Span.new({
-        :s => @id,      # Span ID
-        :n => name,     # Span name
-        :ts => ts_now,  # Timestamp
-        :ta => :ruby,   # Agent
-        :data => kvs,   # Data
+        :s => @id,         # Span ID
+        :ts => ts_now,     # Timestamp
+        :ta => :ruby,      # Agent
         :f => { :e => ::Instana.agent.report_pid, :h => ::Instana.agent.agent_uuid } # Entity Source
       })
 
+      # Check for custom tracing
+      if !REGISTERED_SPANS.include?(name.to_sym)
+        configure_custom_span(name, kvs)
+      else
+        @current_span[:n]    = name.to_sym
+        @current_span[:data] = kvs
+      end
+
       # Handle potential incoming context
       if incoming_context.empty?
         # No incoming context. Set trace ID the same
@@ -65,15 +73,22 @@ module Instana
         :s => generate_id,          # Span ID
         :t => @id,                  # Trace ID (same as :s for root span)
         :p => @current_span[:s],    # Parent ID
-        :n => name,                 # Span name
         :ts => ts_now,              # Timestamp
         :ta => :ruby,               # Agent
-        :data => kvs,               # Data
         :f => { :e => Process.pid, :h => :agent_id } # Entity Source
       })
+
       new_span.parent = @current_span
       @spans.add(new_span)
       @current_span = new_span
+
+      # Check for custom tracing
+      if !REGISTERED_SPANS.include?(name.to_sym)
+        configure_custom_span(name, kvs)
+      else
+        @current_span[:n]    = name.to_sym
+        @current_span[:data] = kvs
+      end
     end
 
     # Add KVs to the current span
@@ -81,7 +96,15 @@ module Instana
     # @param kvs [Hash] list of key values to be reported in the span
     #
     def add_info(kvs)
-      @current_span[:data].merge!(kvs)
+      if @current_span.custom?
+        if @current_span[:data][:sdk].key?(:custom)
+          @current_span[:data][:sdk][:custom].merge!(kvs)
+        else
+          @current_span[:data][:sdk][:custom] = kvs
+        end
+      else
+        @current_span[:data].merge!(kvs)
+      end
     end
 
     # Log an error into the current span
@@ -90,6 +113,24 @@ module Instana
     #
     def add_error(e)
       @current_span[:error] = true
+
+      if @current_span.key?(:ec)
+        @current_span[:ec] = @current_span[:ec] + 1
+      else
+        @current_span[:ec] = 1
+      end
+
+      #if e.backtrace && e.backtrace.is_a?(Array)
+      #  @current_span[:stack] = []
+      #  e.backtrace.each do |x|
+      #    file, line, method = x.split(':')
+      #    @current_span[:stack] << {
+      #      :f => file,
+      #      :n => line
+      #      #:m => method
+      #    }
+      #  end
+      #end
     end
 
     # Close out the current span and set the parent as
@@ -133,7 +174,9 @@ module Instana
     def has_error?
       @spans.each do |s|
         if s.key?(:error)
-          return s[:error]
+          if s[:error] == true
+            return true
+          end
         end
       end
       false
@@ -150,6 +193,26 @@ module Instana
 
     private
 
+    # Configure @current_span to be a custom span per the
+    # SDK generic span type.
+    #
+    def configure_custom_span(name, kvs = {})
+      @current_span[:n] = :sdk
+      @current_span[:data] = { :sdk => { :name => name.to_sym } }
+      @current_span[:data][:sdk][:type] = kvs.key?(:type) ? kvs[:type] : :local
+
+      if kvs.key?(:arguments)
+        @current_span[:data][:sdk][:arguments] = kvs[:arguments]
+      end
+
+      if kvs.key?(:return)
+        @current_span[:data][:sdk][:return] = kvs[:return]
+      end
+      @current_span[:data][:sdk][:custom] = kvs unless kvs.empty?
+      #@current_span[:data][:sdk][:custom][:tags] = {}
+      #@current_span[:data][:sdk][:custom][:logs] = {}
+    end
+
     # Get the current time in milliseconds
     #
     # @return [Integer] the current time in milliseconds

data/lib/instana/version.rb

@@ -1,3 +1,3 @@
 module Instana
-  VERSION = "0.12.0"
+  VERSION = "0.12.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2016-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,7 +115,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Configuration.md
 - Gemfile