instana 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68e23278bff6774c0cc9d5d3a82677044c03db4f
-  data.tar.gz: 0ff491c646782556866bfa6c0751e22f19f6dca8
+  metadata.gz: e4988b08659f80e1f76d21135af688030ee190a0
+  data.tar.gz: c773f6f64f7559da3e10dbfef73d1ca8012bd289
 SHA512:
-  metadata.gz: b82e66f9aae2e19b921332f6daecd7e184ee6e98fa38802490bcd291ea35881ebc0b1396def590b8825542b40932513aa959ab69a488234fbf0f0bd6c99e8952
-  data.tar.gz: 013a6f0b98e114cfecca44c05b47b2b8af4e365398e71d3133ae796a671812e3e05ca829ae368c51d38ea068cc61364a713e10c2180bd700f9b04b9edad05275
+  metadata.gz: 2b6c215de5684fffe16f8338958b47b8b09cc8b17e6a15b4e2e8a6361f9eb14ba8ca343d8b7ca6a08c7b8d92d95a6ea5a368cd21d4211194c1175ef0a2f796bd
+  data.tar.gz: 9e22ce676e64dd9eb0adab68ea0a9933e1343f83356f88a0796ac6aa3f89582d76fe01d3dc4636afe62b2f6e77cdeca38d7e3a61861dd328e24aa00828cb2dbc

data/lib/instana/agent.rb

@@ -9,6 +9,7 @@ module Instana
   class Agent
     attr_accessor :state
     attr_accessor :agent_uuid
+    attr_accessor :process
 
     LOCALHOST = '127.0.0.1'.freeze
     MIME_JSON = 'application/json'.freeze
@@ -18,14 +19,6 @@ module Instana
       # Supported two states (unannounced & announced)
       @state = :unannounced
 
-      # Snapshot data is collected once per process but resent
-      # every 10 minutes along side process metrics.
-      @snapshot = ::Instana::Util.take_snapshot
-
-      # Set last snapshot to just under 10 minutes ago
-      # so we send a snapshot sooner than later
-      @last_snapshot = Time.now - 570
-
       # Timestamp of the last successful response from
       # entity data reporting.
       @entity_last_seen = Time.now
@@ -114,10 +107,10 @@ module Instana
 
       # The collect timer
       # If we are in announced state, send metric data (only delta reporting)
-      # every ::Instana::Collector.interval seconds.
-      @collect_timer = @timers.every(::Instana::Collector.interval) do
+      # every ::Instana.config[:collector][:interval] seconds.
+      @collect_timer = @timers.every(::Instana.config[:collector][:interval]) do
         if @state == :announced
-          if !::Instana::Collector.collect_and_report
+          if !::Instana.collector.collect_and_report
             # If report has been failing for more than 1 minute,
             # fall back to unannounced state
             if (Time.now - @entity_last_seen) > 60
@@ -197,30 +190,18 @@ module Instana
     #
     # @param paylod [Hash] The collection of metrics to report.
     #
-    def report_entity_data(payload)
+    # @return [Boolean] true on success, false otherwise
+    #
+    def report_metrics(payload)
       unless @discovered
         ::Instana.logger.agent("#{__method__} called but discovery hasn't run yet!")
         return false
       end
 
-      with_snapshot = false
       path = "com.instana.plugin.ruby.#{@process[:report_pid]}"
       uri = URI.parse("http://#{@discovered[:agent_host]}:#{@discovered[:agent_port]}/#{path}")
       req = Net::HTTP::Post.new(uri)
 
-      # Every 5 minutes, send snapshot data as well
-      if (Time.now - @last_snapshot) > 600
-        with_snapshot = true
-        payload.merge!(@snapshot)
-
-        # Add in process related that could have changed since
-        # snapshot was taken.
-        p = { :pid => @process[:report_pid] }
-        p[:name] = @process[:name]
-        p[:exec_args] = @process[:arguments]
-        payload.merge!(p)
-      end
-
       req.body = payload.to_json
       response = make_host_agent_request(req)
 
@@ -233,7 +214,6 @@ module Instana
 
         if response.code.to_i == 200
           @entity_last_seen = Time.now
-          @last_snapshot = Time.now if with_snapshot
           return true
         end
 
@@ -417,18 +397,14 @@ module Instana
         # Reset the entity timer
         @entity_last_seen = Time.now
 
-        # Set last snapshot to 10 minutes ago
-        # so we send a snapshot on first report
-        @last_snapshot = Time.now - 601
       when :unannounced
         @state = :unannounced
 
-        # Set last snapshot to 10 minutes ago
-        # so we send a snapshot on first report
-        @last_snapshot = Time.now - 601
       else
         ::Instana.logger.warn "Uknown agent state: #{state}"
       end
+      ::Instana.collector.reset_timer!
+      true
     end
 
     # Centralization of the net/http communications

data/lib/instana/base.rb

@@ -6,7 +6,7 @@ require "instana/helpers"
 module Instana
   class << self
     attr_accessor :agent
-    attr_accessor :collectors
+    attr_accessor :collector
     attr_accessor :tracer
     attr_accessor :processor
     attr_accessor :config
@@ -20,13 +20,10 @@ module Instana
     # to run" state.
     #
     def setup
-      @logger = ::Instana::XLogger.new(STDOUT)
-      @logger.unknown "Stan is on the scene.  Starting Instana instrumentation."
-
       @agent  = ::Instana::Agent.new
       @tracer = ::Instana::Tracer.new
       @processor = ::Instana::Processor.new
-      @collectors = []
+      @collector = ::Instana::Collector.new
     end
 
     # Indicates whether we are running in a development environment.
@@ -46,3 +43,7 @@ module Instana
     end
   end
 end
+
+# Setup the logger as early as possible
+::Instana.logger = ::Instana::XLogger.new(STDOUT)
+::Instana.logger.unknown "Stan is on the scene.  Starting Instana instrumentation."

data/lib/instana/collector.rb

@@ -0,0 +1,115 @@
+module Instana
+  class Collector
+    attr_accessor :collectors
+    attr_accessor :last_report_log
+
+    def initialize
+      @collectors = []
+
+      # Snapshot data is collected once per process but resent
+      # every 10 minutes along side process metrics.
+      @snapshot = ::Instana::Util.take_snapshot
+
+      # Set last snapshot to just under 10 minutes ago
+      # so we send a snapshot sooner than later
+      @last_snapshot = Time.now - 570
+
+      # We track what we last sent as a metric payload so that
+      # we can do delta reporting
+      @last_values = {}
+    end
+
+    # Register an individual collector.
+    #
+    # @param [Object] the class of the collector to register
+    #
+    def register(klass)
+      ::Instana.logger.debug "Adding #{klass} to collectors..."
+      @collectors << klass.new
+    end
+
+    # Resets the timer on when to send process snapshot data.
+    #
+    def reset_timer!
+      # Set last snapshot to 10 minutes ago
+      # so we send a snapshot on first report
+      @last_snapshot = Time.now - 601
+    end
+
+    ##
+    # collect_and_report
+    #
+    # Run through each collector, let them collect up
+    # data and then report what we have via the agent
+    #
+    # @return Boolean true on success
+    #
+    def collect_and_report
+      payload = {}
+      with_snapshot = false
+
+      # Run through the registered collectors and
+      # get all the metrics
+      #
+      @collectors.each do |c|
+        metrics = c.collect
+        if metrics
+          payload[c.payload_key] = metrics
+        else
+          payload.delete(c.payload_key)
+        end
+      end
+
+      # Every 5 minutes, send snapshot data as well
+      if (Time.now - @last_snapshot) > 600
+        with_snapshot = true
+        payload.merge!(@snapshot)
+
+        # Add in process related that could have changed since
+        # snapshot was taken.
+        p = { :pid => ::Instana.agent.report_pid }
+        p[:name] = ::Instana.agent.process[:name]
+        p[:exec_args] = ::Instana.agent.process[:arguments]
+        payload.merge!(p)
+      else
+        payload = enforce_deltas(payload, @last_values)
+      end
+
+      if ENV['INSTANA_GEM_TEST']
+        true
+      else
+        # Report all the collected goodies
+        if ::Instana.agent.report_metrics(payload) && with_snapshot
+          @last_snapshot = Time.now
+        end
+      end
+    end
+
+    # Take two hashes and enforce delta reporting.
+    # We only report when values change (instead of reporting all of
+    # the time).  This is a recursive method.
+    #
+    # @param [Hash] the payload have delta reporting applied to
+    # @param [Hash] a hash of the last values reported
+    #
+    # @return [Hash] the candidate hash with delta reporting applied
+    #
+    def enforce_deltas(candidate, last)
+      candidate.each do |k,v|
+        if v.is_a?(Hash)
+          last[k] ||= {}
+          candidate[k] = enforce_deltas(candidate[k], last[k])
+          candidate.delete(k) if candidate[k].empty?
+        else
+          if last[k] == v
+            candidate.delete(k)
+          else
+            last[k] = candidate[k]
+          end
+        end
+      end
+      candidate
+    end
+  end
+end
+

data/lib/instana/collectors/gc.rb

@@ -1,11 +1,10 @@
 module Instana
-  module Collector
+  module Collectors
     class GC
       attr_accessor :payload_key
 
       def initialize
         @payload_key = :gc
-        @last_report = {}
         @this_gc = {}
         @last_major_count = 0
         @last_minor_count = 0
@@ -40,15 +39,7 @@ module Instana
         # GC Heap
         @this_gc[:heap_live] = stats[:heap_live_slot] || stats[:heap_live_slots] || stats[:heap_live_num]
         @this_gc[:heap_free] = stats[:heap_free_slot] || stats[:heap_free_slots] || stats[:heap_free_num]
-
-        @this_gc = ::Instana::Util.enforce_deltas(@this_gc, @last_report)
-
-        unless @this_gc.empty?
-          @last_report.merge!(@this_gc)
-          @this_gc
-        else
-          nil
-        end
+        @this_gc
       rescue => e
         ::Instana.logger.error "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
         ::Instana.logger.debug e.backtrace.join("\r\n")
@@ -59,5 +50,5 @@ end
 
 # Register the metrics collector if enabled
 if ::Instana.config[:metrics][:gc][:enabled]
-  ::Instana.collectors << ::Instana::Collector::GC.new
+  ::Instana.collector.register(::Instana::Collectors::GC)
 end

data/lib/instana/collectors/memory.rb

@@ -1,13 +1,12 @@
 require 'get_process_mem'
 
 module Instana
-  module Collector
+  module Collectors
     class Memory
       attr_accessor :payload_key
 
       def initialize
         @payload_key = :memory
-        @last_report = {}
         @this_mem = {}
       end
 
@@ -16,17 +15,11 @@ module Instana
       #
       # To collect process memory usage.
       #
+      # @return [Hash] a collection of metrics (if any)
+      #
       def collect
-        @this_mem.clear
         @this_mem[:rss_size] = ::GetProcessMem.new(Process.pid).kb
-
-        @this_mem = ::Instana::Util.enforce_deltas(@this_mem, @last_report)
-        unless @this_mem.empty?
-          @last_report.merge!(@this_mem)
-          @this_mem
-        else
-          nil
-        end
+        @this_mem
       rescue => e
         ::Instana.logger.error "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
         ::Instana.logger.debug e.backtrace.join("\r\n")
@@ -37,5 +30,5 @@ end
 
 # Register the metrics collector if enabled
 if ::Instana.config[:metrics][:memory][:enabled]
-  ::Instana.collectors << ::Instana::Collector::Memory.new
+  ::Instana.collector.register(::Instana::Collectors::Memory)
 end

data/lib/instana/collectors/thread.rb

@@ -1,11 +1,10 @@
 module Instana
-  module Collector
+  module Collectors
     class Thread
       attr_accessor :payload_key
 
       def initialize
         @payload_key = :thread
-        @last_report = {}
         @this_count = {}
       end
 
@@ -16,15 +15,7 @@ module Instana
       #
       def collect
         @this_count[:count] = ::Thread.list.count
-
-        @this_count = ::Instana::Util.enforce_deltas(@this_count, @last_report)
-
-        unless @this_count.empty?
-          @last_report.merge!(@this_count)
-          @this_count
-        else
-          nil
-        end
+        @this_count
       rescue => e
         ::Instana.logger.error "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
         ::Instana.logger.debug e.backtrace.join("\r\n")
@@ -35,5 +26,5 @@ end
 
 # Register the metrics collector if enabled
 if ::Instana.config[:metrics][:thread][:enabled]
-  ::Instana.collectors << ::Instana::Collector::Thread.new
+  ::Instana.collector.register(::Instana::Collectors::Thread)
 end

data/lib/instana/config.rb

@@ -10,12 +10,20 @@ module Instana
       @config[:metrics][:memory] = { :enabled => true }
       @config[:metrics][:thread] = { :enabled => true }
 
+      if ENV.key?('INSTANA_GEM_DEV')
+        @config[:collector] = { :enabled => true, :interval => 3 }
+      else
+        @config[:collector] = { :enabled => true, :interval => 1 }
+      end
+
       # EUM Related
       @config[:eum_api_key] = nil
       @config[:eum_baggage] = {}
 
       # HTTP Clients
-      @config[:excon] = { :enabled => true }
+      @config[:excon]         = { :enabled => true }
+      @config[:nethttp]       = { :enabled => true }
+      @config[:'rest-client'] = { :enabled => true }
     end
 
     def [](key)

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

@@ -1,63 +1,65 @@
 require 'net/http'
 
-Net::HTTP.class_eval {
+if defined?(::Net::HTTP) && ::Instana.config[:nethttp][:enabled]
+  Net::HTTP.class_eval {
 
-  def request_with_instana(*args, &block)
-    if !Instana.tracer.tracing? || !started?
-      return request_without_instana(*args, &block)
-    end
+    def request_with_instana(*args, &block)
+      if !Instana.tracer.tracing? || !started?
+        return request_without_instana(*args, &block)
+      end
 
-    ::Instana.tracer.log_entry(:'net-http')
+      ::Instana.tracer.log_entry(:'net-http')
 
-    # Send out the tracing context with the request
-    request = args[0]
+      # Send out the tracing context with the request
+      request = args[0]
 
-    # Set request headers; encode IDs as hexadecimal strings
-    t_context = ::Instana.tracer.context
-    request['X-Instana-T'] = t_context.trace_id_header
-    request['X-Instana-S'] = t_context.span_id_header
+      # Set request headers; encode IDs as hexadecimal strings
+      t_context = ::Instana.tracer.context
+      request['X-Instana-T'] = t_context.trace_id_header
+      request['X-Instana-S'] = t_context.span_id_header
 
-    # Collect up KV info now in case any exception is raised
-    kv_payload = { :http => {} }
-    kv_payload[:http][:method] = request.method
+      # 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}"
+      if request.uri
+        kv_payload[:http][:url] = request.uri.to_s
       else
-        kv_payload[:http][:url] = "http://#{@address}:#{@port}#{request.path}"
+        if use_ssl?
+          kv_payload[:http][:url] = "https://#{@address}:#{@port}#{request.path}"
+        else
+          kv_payload[:http][:url] = "http://#{@address}:#{@port}#{request.path}"
+        end
       end
-    end
 
-    # The core call
-    response = request_without_instana(*args, &block)
+      # The core call
+      response = request_without_instana(*args, &block)
 
-    # Pickup response headers; convert back to base 10 integer
-    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}"
+      # Pickup response headers; convert back to base 10 integer
+      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
-    end
 
-    kv_payload[:http][:status] = response.code
-    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
+      kv_payload[:http][:status] = response.code
+      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', kv_payload)
-  end
+      response
+    rescue => e
+      ::Instana.tracer.log_error(e)
+      raise
+    ensure
+      ::Instana.tracer.log_exit(:'net-http', kv_payload)
+    end
 
-  Instana.logger.warn "Instrumenting Net::HTTP"
+    Instana.logger.warn "Instrumenting Net::HTTP"
 
-  alias request_without_instana request
-  alias request request_with_instana
-}
+    alias request_without_instana request
+    alias request request_with_instana
+  }
+end

data/lib/instana/instrumentation/rest-client.rb

@@ -28,7 +28,7 @@ module Instana
   end
 end
 
-if defined?(::RestClient::Request)
+if defined?(::RestClient::Request) && ::Instana.config[:'rest-client'][:enabled]
   ::Instana.logger.warn "Instrumenting RestClient"
   ::RestClient::Request.send(:include, ::Instana::Instrumentation::RestClientRequest)
 end

data/lib/instana/setup.rb

@@ -1,16 +1,19 @@
 require "instana/base"
 require "instana/config"
 require "instana/agent"
+require "instana/collector"
 require "instana/tracer"
 require "instana/tracing/processor"
-
-::Instana.setup
-
-require "instana/collectors"
 require "instana/instrumentation"
 
+::Instana.setup
 ::Instana.agent.setup
 
+# Register the metric collectors
+require 'instana/collectors/gc'
+require 'instana/collectors/memory'
+require 'instana/collectors/thread'
+
 # Require supported OpenTracing interfaces
 require "opentracing"
 

data/lib/instana/util.rb

@@ -39,24 +39,6 @@ module Instana
         target_cls.send(:include, cls) if defined?(target_cls)
       end
 
-      # Take two hashes, and make sure candidate does not have
-      # any of the same values as `last`.  We only report
-      # when values change.
-      #
-      # Note this is not recursive, so only pass in the single
-      # hashes that you want delta reporting with.
-      #
-      def enforce_deltas(candidate, last)
-        return unless last.is_a?(Hash)
-
-        candidate.each do |k,v|
-          if candidate[k] == last[k]
-            candidate.delete(k)
-          end
-        end
-        candidate
-      end
-
       # Debugging helper method
       #
       def pry!

data/lib/instana/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,7 +132,7 @@ files:
 - lib/instana.rb
 - lib/instana/agent.rb
 - lib/instana/base.rb
-- lib/instana/collectors.rb
+- lib/instana/collector.rb
 - lib/instana/collectors/gc.rb
 - lib/instana/collectors/memory.rb
 - lib/instana/collectors/thread.rb

data/lib/instana/collectors.rb

@@ -1,46 +0,0 @@
-require 'timers'
-require 'instana/collectors/gc'
-require 'instana/collectors/memory'
-require 'instana/collectors/thread'
-
-module Instana
-  module Collector
-    class << self
-      attr_accessor :interval
-
-      ##
-      # collect_and_report
-      #
-      # Run through each collector, let them collect up
-      # data and then report what we have via the agent
-      #
-      # @return Boolean true on success
-      #
-      def collect_and_report
-        payload = {}
-
-        ::Instana.collectors.each do |c|
-          metrics = c.collect
-          if metrics
-            payload[c.payload_key] = metrics
-          else
-            payload.delete(c.payload_key)
-          end
-        end
-
-        if ENV['INSTANA_GEM_TEST']
-          true
-        else
-          # Report all the collected goodies
-          ::Instana.agent.report_entity_data(payload)
-        end
-      end
-    end
-  end
-end
-
-if ENV.key?('INSTANA_GEM_DEV')
-  ::Instana::Collector.interval = 3
-else
-  ::Instana::Collector.interval = 1
-end