instana 0.14.0 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72f8c1fa60c3d84f52025ce41ebb803ce83b36d8
-  data.tar.gz: cb85eb7203cc6d028712351d642dc153a28a6468
+  metadata.gz: ce0309a7d8eace834f73f721b1e3b008562f9a32
+  data.tar.gz: 1ff1ad55ad736c0ef64f1dca370100143f390cbd
 SHA512:
-  metadata.gz: 21b2723fc3ee132868586e0f4dd0ad218dafc0a6e39c0fd56ff18c508fe984c32f1431134d1f467a91c687b2b3eb1f34976b76629a675bbe0d829011415e70ad
-  data.tar.gz: af75b8240335a5c8484400c6d1dca6197b0121d7a0d20569af8bbd0911ab336b68b935b352809f841a571b36cbbe789767dd99d54eeabdacb6084467d6a6c59c
+  metadata.gz: a65f865e28aea63228d6c4bfce3c7b5eb4ba1bb6dd1370ce6b3e674083c69905879658e23ecb5329afbab03723ee1aca4c7643db7ea3ba71460d6e59fd5059ed
+  data.tar.gz: 5a7b593a95f1f9857f7d6944f0bac2716767b4ec4c720aabd6852e21e20a15d17c841fe862bb715fc47a642062d4053567efa4cfe967ec69b5888c8c183c150c

data/.codeclimate.yml

@@ -12,6 +12,9 @@ engines:
     enabled: true
   rubocop:
     enabled: true
+    checks:
+      Rubocop/Metrics/CyclomaticComplexity:
+        enabled: false
 ratings:
   paths:
   - "**.inc"

data/README.md

@@ -56,6 +56,10 @@ See [Tracing.md](https://github.com/instana/ruby-sensor/blob/master/Tracing.md)
 
 You can find more documentation covering supported components and minimum versions in the Instana [documentation portal](https://instana.atlassian.net/wiki/display/DOCS/Ruby).
 
+## Want End User Monitoring?
+
+Instana provides deep end user monitoring that links server side traces with browser events.  See [End User Monitoring](https://instana.atlassian.net/wiki/display/DOCS/Web+End-User+Monitoring) in the Instana documentation portal.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Tracing.md

@@ -21,8 +21,17 @@ ensure
 end
 ```
 
-The above is a simple example but shows how easy it is to instrument any code you like.  Instana will
-take care of the rest.
+or alternatively you can use the `trace` block method that will automagically capture and
+log any exceptions raised:
+
+```Ruby
+::Instana.tracer.trace(:mywork, { :helpful_kvs => @user.id }) do
+  # The code to be instrumented
+  @id = User.find_by_name('john.smith')
+ end
+```
+
+The above are simple examples but shows how easy it is to instrument any arbitrary piece of code you like.
 
 See the [examples directory](https://github.com/instana/ruby-sensor/blob/master/examples/tracing.rb) for
 an expanded view and quick cheat sheet on tracing.

data/lib/instana/agent.rb

@@ -22,9 +22,6 @@ module Instana
       # Supported two states (unannounced & announced)
       @state = :unannounced
 
-      # Store the pid from process boot so we can detect forks
-      @pid = Process.pid
-
       # Snapshot data is collected once per process but resent
       # every 10 minutes along side process metrics.
       @snapshot = ::Instana::Util.take_snapshot
@@ -57,29 +54,7 @@ module Instana
       # The agent UUID returned from the host agent
       @agent_uuid = nil
 
-      collect_process_info
-    end
-
-    # Used in class initialization and after a fork, this method
-    # collects up process information and stores it in @process
-    #
-    def collect_process_info
-      @process = {}
-      cmdline = ProcTable.ps(Process.pid).cmdline.split("\0")
-      @process[:name] = cmdline.shift
-      @process[:arguments] = cmdline
-
-      if @is_osx
-        # Handle OSX bug where env vars show up at the end of process name
-        # such as MANPATH etc..
-        @process[:name].gsub!(/[_A-Z]+=\S+/, '')
-        @process[:name].rstrip!
-      end
-
-      @process[:original_pid] = @pid
-      # This is usually Process.pid but in the case of docker, the host agent
-      # will return to us the true host pid in which we use to report data.
-      @process[:report_pid] = nil
+      @process = ::Instana::Util.collect_process_info
     end
 
     # Used post fork to re-initialize state and restart communications with
@@ -89,8 +64,7 @@ module Instana
       ::Instana.logger.agent "after_fork hook called. Falling back to unannounced state and spawning a new background agent thread."
 
       # Re-collect process information post fork
-      @pid = Process.pid
-      collect_process_info
+      @process = ::Instana::Util.collect_process_info
 
       transition_to(:unannounced)
       setup
@@ -451,7 +425,7 @@ module Instana
     # @ return [Boolean] true or false to indicate if forked
     #
     def forked?
-      @pid != Process.pid
+      @process[:pid] != Process.pid
     end
   end
 end

data/lib/instana/base.rb

@@ -20,25 +20,28 @@ module Instana
     #
     def setup
       @logger = ::Instana::XLogger.new(STDOUT)
-      if ENV.key?('INSTANA_GEM_TEST') || ENV.key?('INSTANA_GEM_DEV')
-        @logger.level = Logger::DEBUG
-      else
-        @logger.level = Logger::WARN
-      end
       @logger.unknown "Stan is on the scene.  Starting Instana instrumentation."
 
       @agent  = ::Instana::Agent.new
       @tracer = ::Instana::Tracer.new
       @processor = ::Instana::Processor.new
       @collectors = []
+    end
 
-      # Store the current pid so we can detect a potential fork
-      # later on
-      @pid = ::Process.pid
+    # Indicates whether we are running in a development environment.
+    #
+    # @return Boolean
+    #
+    def debug?
+      ENV.key?('INSTANA_GEM_DEV')
     end
 
-    def pid_change?
-      @pid != ::Process.pid
+    # Indicates whether we are running in the test environment.
+    #
+    # @return Boolean
+    #
+    def test?
+      ENV.key?('INSTANA_GEM_TEST')
     end
   end
 end

data/lib/instana/collectors.rb

@@ -7,7 +7,6 @@ module Instana
   module Collector
     class << self
       attr_accessor :interval
-      attr_accessor :snapshot
 
       ##
       # collect_and_report

data/lib/instana/collectors/gc.rb

@@ -28,8 +28,8 @@ module Instana
         # GC metrics only available on newer Ruby versions
         if RUBY_VERSION >= '2.1'
           # GC runs.  Calculate how many have occurred since the last call
-          @this_gc[:minorGcs]  = stats[:minor_gc_count] - @last_minor_count
-          @this_gc[:majorGcs]  = stats[:major_gc_count] - @last_major_count
+          @this_gc[:minorGcs] = stats[:minor_gc_count] - @last_minor_count
+          @this_gc[:majorGcs] = stats[:major_gc_count] - @last_major_count
 
           # Store these counts so that we have something to compare to next
           # time around.

data/lib/instana/instrumentation/excon.rb

@@ -46,6 +46,12 @@ if defined?(::Excon) && ::Instana.config[:excon][:enabled]
             status = datum[:response][:status]
           end
 
+          if status.between?(500, 511)
+            # Because of the 5xx response, we flag this span as errored but
+            # without a backtrace (no exception)
+            ::Instana.tracer.log_error(nil)
+          end
+
           if datum[:pipeline] == true
             # Pickup context of this async span from datum[:instana_id]
             ::Instana.tracer.log_async_exit(:excon, { :http => {:status => status } }, datum[:instana_context])

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

@@ -11,36 +11,48 @@ Net::HTTP.class_eval {
 
     # Send out the tracing context with the request
     request = args[0]
-    our_trace_id = ::Instana.tracer.trace_id
-    our_span_id  = ::Instana.tracer.span_id
 
     # Set request headers; encode IDs as hexadecimal strings
-    request['X-Instana-T'] = ::Instana.tracer.id_to_header(our_trace_id)
-    request['X-Instana-S'] = ::Instana.tracer.id_to_header(our_span_id)
+    request['X-Instana-T'] = ::Instana.tracer.trace_id_header
+    request['X-Instana-S'] = ::Instana.tracer.span_id_header
 
+    # Collect up KV info now in case any exception is raised
+    kv_payload = { :http => {} }
+    kv_payload[:http][:method] = request.method
+
+    if request.uri
+      kv_payload[:http][:url] = request.uri.to_s
+    else
+      if use_ssl?
+        kv_payload[:http][:url] = "https://#{@address}:#{@port}#{request.path}"
+      else
+        kv_payload[:http][:url] = "http://#{@address}:#{@port}#{request.path}"
+      end
+    end
+
+    # The core call
     response = request_without_instana(*args, &block)
 
     # Pickup response headers; convert back to base 10 integer
-    if response.key?('X-Instana-T')
-      their_trace_id = ::Instana.tracer.header_to_id(response.header['X-Instana-T'])
-
-      if our_trace_id != their_trace_id
-        ::Instana.logger.debug "#{Thread.current}: Trace ID mismatch on net/http response! ours: #{our_trace_id} theirs: #{their_trace_id}"
+    if ::Instana.debug? && response.key?('X-Instana-T')
+      if ::Instana.tracer.trace_id != ::Instana.tracer.header_to_id(response.header['X-Instana-T'])
+        ::Instana.logger.debug "#{Thread.current}: Trace ID mismatch on net/http response! ours: #{::Instana.tracer.trace_id} theirs: #{their_trace_id}"
       end
     end
 
-    kv_payload = { :http => {} }
     kv_payload[:http][:status] = response.code
-    kv_payload[:http][:url] = request.uri.to_s
-    kv_payload[:http][:method] = request.method
-    ::Instana.tracer.log_info(kv_payload)
+    if response.code.to_i.between?(500, 511)
+      # Because of the 5xx response, we flag this span as errored but
+      # without a backtrace (no exception)
+      add_error(nil)
+    end
 
     response
   rescue => e
     ::Instana.tracer.log_error(e)
     raise
   ensure
-    ::Instana.tracer.log_exit(:'net-http')
+    ::Instana.tracer.log_exit(:'net-http', kv_payload)
   end
 
   Instana.logger.warn "Instrumenting Net::HTTP"

data/lib/instana/instrumentation/rack.rb

@@ -30,6 +30,12 @@ module Instana
       if ::Instana.tracer.tracing?
         kvs[:http][:status] = status
 
+        if status.between?(500, 511)
+          # Because of the 5xx response, we flag this span as errored but
+          # without a backtrace (no exception)
+          ::Instana.tracer.log_error(nil)
+        end
+
         # Save the IDs before the trace ends so we can place
         # them in the response headers in the ensure block
         trace_id = ::Instana.tracer.trace_id

data/lib/instana/logger.rb

@@ -6,8 +6,13 @@ module Instana
     STAMP = "Instana: ".freeze
 
     def initialize(*args)
-      if ENV['INSTANA_GEM_DEV']
-        self.debug_level=:agent
+      if ENV.key?('INSTANA_GEM_TEST')
+        self.level = Logger::DEBUG
+      elsif ENV.key?('INSTANA_GEM_DEV')
+        self.level = Logger::DEBUG
+        self.debug_level = nil
+      else
+        self.level = Logger::WARN
       end
       super(*args)
     end
@@ -24,6 +29,8 @@ module Instana
     # ::Instana.logger.debug_level = [:agent_comm, :trace]
     #
     def debug_level=(levels)
+      return unless levels
+
       LEVELS.each do |l|
         instance_variable_set("@level_#{l}", false)
       end

data/lib/instana/tracing/trace.rb

@@ -1,8 +1,9 @@
 module Instana
   class Trace
-    REGISTERED_SPANS = [ :rack, :'net-http', :excon ]
-    ENTRY_SPANS = [ :rack ]
-    EXIT_SPANS = [ :'net-http', :excon ]
+    REGISTERED_SPANS = [ :rack, :'net-http', :excon ].freeze
+    ENTRY_SPANS = [ :rack ].freeze
+    EXIT_SPANS = [ :'net-http', :excon ].freeze
+    HTTP_SPANS = ENTRY_SPANS + EXIT_SPANS
 
     # @return [Integer] the ID for this trace
     attr_reader :id
@@ -135,6 +136,10 @@ module Instana
     # @param e [Exception] Add exception to the current span
     #
     def add_error(e, span = nil)
+      # Return if we've already logged this exception and it
+      # is just propogating up the spans.
+      return if e && e.instance_variable_get(:@instana_logged)
+
       span ||= @current_span
 
       span[:error] = true
@@ -145,9 +150,22 @@ module Instana
         span[:ec] = 1
       end
 
-      add_info(:log => {
-        :message => e.message,
-        :parameters => e.class })
+      # If a valid exception has been passed in, log the information about it
+      # In case of just logging an error for things such as HTTP client 5xx
+      # responses, an exception/backtrace may not exist.
+      if e
+        if e.backtrace.is_a?(Array)
+          add_backtrace_to_span(e.backtrace, nil, span)
+        end
+
+        if HTTP_SPANS.include?(span.name)
+          add_info(:http => { :error => "#{e.class}: #{e.message}" })
+        else
+          add_info(:log => { :message => e.message, :parameters => e.class })
+        end
+        e.instance_variable_set(:@instana_logged, true)
+      end
+
     end
 
     # Close out the current span and set the parent as
@@ -157,7 +175,7 @@ module Instana
     #
     def end_span(kvs = {})
       @current_span[:d] = ts_now - @current_span[:ts]
-      add_info(kvs) unless kvs.empty?
+      add_info(kvs) if kvs && !kvs.empty?
       @current_span = @current_span.parent unless @current_span.is_root?
     end
 
@@ -398,8 +416,7 @@ module Instana
       end
     end
 
-    # Adds a backtrace to the passed in span or on
-    # @current_span if not.
+    # Adds a backtrace to the passed in span or on @current_span if not.
     #
     # @param limit [Integer] Limit the backtrace to the top <limit> frames
     # @param span [Span] the span to add the backtrace to or if unspecified
@@ -407,10 +424,21 @@ module Instana
     #
     def add_stack(limit = nil, span = nil)
       span ||= @current_span
-      span[:stack] = []
-      frame_count = 0
 
-      bt = Kernel.caller
+      add_backtrace_to_span(Kernel.caller, limit, span)
+    end
+
+    # Adds the passed in backtrace to the specified span.  Backtrace can be one
+    # generated from Kernel.caller or one attached to an exception
+    #
+    # @param bt [Array] the backtrace
+    # @param limit [Integer] Limit the backtrace to the top <limit> frames
+    # @param span [Span] the span to add the backtrace to or if unspecified
+    #   the current span
+    #
+    def add_backtrace_to_span(bt, limit = nil, span)
+      frame_count = 0
+      span[:stack] = []
 
       bt.each do |i|
         # If the stack has the full instana gem version in it's path

data/lib/instana/util.rb

@@ -117,6 +117,29 @@ module Instana
         ::Instana.logger.debug e.backtrace.join("\r\n")
         return data
       end
+
+      # Used in class initialization and after a fork, this method
+      # collects up process information
+      #
+      def collect_process_info
+        process = {}
+        cmdline = ProcTable.ps(Process.pid).cmdline.split("\0")
+        process[:name] = cmdline.shift
+        process[:arguments] = cmdline
+
+        if RUBY_PLATFORM =~ /darwin/i
+          # Handle OSX bug where env vars show up at the end of process name
+          # such as MANPATH etc..
+          process[:name].gsub!(/[_A-Z]+=\S+/, '')
+          process[:name].rstrip!
+        end
+
+        process[:pid] = Process.pid
+        # This is usually Process.pid but in the case of docker, the host agent
+        # will return to us the true host pid in which we use to report data.
+        process[:report_pid] = nil
+        process
+      end
     end
   end
 end

data/lib/instana/version.rb

@@ -1,4 +1,4 @@
 module Instana
-  VERSION = "0.14.0"
+  VERSION = "0.14.2"
   VERSION_FULL = "instana-#{VERSION}"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.2
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-19 00:00:00.000000000 Z
+date: 2016-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler