instana 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9eab4fef33e50acc7b26498aacc90ecd3d63f8a
-  data.tar.gz: 3f0ff725ff8193baa57e00c0f4ea4725ee9cb052
+  metadata.gz: ae7d78fd94912eaec8e882d9dd08f34361657778
+  data.tar.gz: dd3f522c3e0dce7cc21ad3513114998637b88803
 SHA512:
-  metadata.gz: 497750052b7d92097a37e178e910dbfdd584df7cb7cde046c1d21cef1b617e08d371ad7ce71afe8178b2e354440a19e81f913fc53bf21c50960a5c3c1a57ebd9
-  data.tar.gz: 004da2067917cde50fe846d9f068af919ab2c2b06a2f06ba49210f7362d8592457ee03cecf9dad82f5f0ad7adf4bb624930ade4e91f63da43994de9c5af281db
+  metadata.gz: 9cad401a7c37240c344406a860021073f3195c1d395cae42f9d3b1a85a1a88b430f5f739e3cc3853c6f871fcbc0b7e5d8f331a7fe53c3d50a0ca16ffb5550c6e
+  data.tar.gz: 8fbf28bf702a802e5a850069ba9d349cd12e12a2689d2cccbcca600e9a93f7d8d607df0d777244f7e2ef508aa98371e8d3ab53f8bf4bb039f118c796c2561f27

data/Gemfile

@@ -5,6 +5,7 @@ group :development, :test do
   gem 'minitest'
   gem 'minitest-reporters'
   gem 'minitest-debugger', :require => false
+  gem 'webmock'
 end
 
 group :development do

data/README.md

@@ -6,6 +6,9 @@
 
 The Instana gem provides Ruby metrics 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)
+[![Gem Version](https://badge.fury.io/rb/instana.svg)](https://badge.fury.io/rb/instana)
+
 ## Note
 
 This gem is currently in beta and supports Ruby versions 2.0 or greater.
@@ -43,6 +46,10 @@ To disable a single component in the gem, you can disable a single component wit
 ```
 Current components are `:gc`, `:memory` and `:thread`.
 
+## Documentation
+
+You can find more documentation covering supported components and minimum versions in the Instana [documentation portal](https://instana.atlassian.net/wiki/display/DOCS/Ruby).
+
 ## 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/lib/instana/agent.rb

@@ -1,12 +1,13 @@
 require 'net/http'
 require 'uri'
 require 'json'
+require 'timers'
 require 'sys/proctable'
 include Sys
 
 module Instana
   class Agent
-    attr_accessor :last_entity_response
+    attr_accessor :state
 
     def initialize
       # Host agent defaults.  Can be configured via Instana.config
@@ -15,6 +16,9 @@ module Instana
       @port = 42699
       @server_header = 'Instana Agent'
 
+      # Supported two states (unannounced & announced)
+      @state = :unannounced
+
       # Snapshot data is collected once per process but resent
       # every 10 minutes along side process metrics.
       @snapshot = take_snapshot
@@ -22,52 +26,62 @@ module Instana
       # Set last snapshot to 10 minutes ago
       # so we send a snapshot on first report
       @last_snapshot = Time.now - 601
+
+      # Timestamp of the last successful response from
+      # entity data reporting.
+      @entity_last_seen = Time.now
+
+      # Two timers, one for each state (unannounced & announced)
+      @timers = ::Timers::Group.new
+      @announce_timer = nil
+      @collect_timer = nil
     end
 
     ##
-    # take_snapshot
+    # start
     #
-    # Method to collect up process info for snapshots.  This
-    # is generally used once per process.
     #
-    def take_snapshot
-      data = {}
-
-      data[:sensorVersion] = ::Instana::VERSION
-      data[:pid] = Process.pid
-      data[:ruby_version] = RUBY_VERSION
-
-      process = ProcTable.ps(Process.pid)
-      arguments = process.cmdline.split(' ')
-      data[:name] = arguments.shift
-      data[:exec_args] = arguments
-
-      # Since a snapshot is only taken on process boot,
-      # this is ok here.
-      data[:start_time] = Time.now.to_s
-
-      # Framework Detection
-      if defined?(::RailsLts::VERSION)
-        data[:framework] = "Rails on Rails LTS-#{::RailsLts::VERSION}"
-
-      elsif defined?(::Rails.version)
-        data[:framework] = "Ruby on Rails #{::Rails.version}"
-
-      elsif defined?(::Grape::VERSION)
-        data[:framework] = "Grape #{::Grape::VERSION}"
-
-      elsif defined?(::Padrino::VERSION)
-        data[:framework] = "Padrino #{::Padrino::VERSION}"
+    def start
+      # The announce timer
+      # We attempt to announce this ruby sensor to the host agent.
+      # In case of failure, we try again in 30 seconds.
+      @announce_timer = @timers.now_and_every(30) do
+        if host_agent_ready? && announce_sensor
+          ::Instana.logger.debug "Announce successful. Switching to metrics collection."
+          transition_to(:announced)
+        end
+      end
 
-      elsif defined?(::Sinatra::VERSION)
-        data[:framework] = "Sinatra #{::Sinatra::VERSION}"
+      # 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
+        if @state == :announced
+          unless ::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
+              ::Instana.logger.debug "Metrics reporting failed for >1 min.  Falling back to unannounced state."
+              transition_to(:unannounced)
+            end
+          end
+        end
       end
 
-      data
-    rescue => e
-      ::Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
-      ::Instana.logger.debug e.backtrace.join("\r\n")
-      return data
+      # Start the background ruby sensor thread.  It works off of timers and
+      # is sleeping otherwise
+      Thread.new do
+        loop {
+          if @state == :unannounced
+            @collect_timer.pause
+            @announce_timer.resume
+          else
+            @announce_timer.pause
+            @collect_timer.resume
+          end
+          @timers.wait
+        }
+      end
     end
 
     ##
@@ -88,18 +102,10 @@ module Instana
       path = 'com.instana.plugin.ruby.discovery'
       uri = URI.parse("http://#{@host}:#{@port}/#{path}")
       req = Net::HTTP::Put.new(uri)
-
-      req['Accept'] = 'application/json'
-      req['Content-Type'] = 'application/json'
       req.body = announce_payload.to_json
 
-      ::Instana.logger.debug "Announcing sensor to #{path} for pid #{Process.pid}: #{announce_payload.to_json}"
-
-      response = nil
-      Net::HTTP.start(uri.hostname, uri.port) do |http|
-        response = http.request(req)
-      end
-      Instana.logger.debug response.code
+      response = make_host_agent_request(req)
+      response && (response.code.to_i == 200) ? true : false
     rescue => e
       Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
       Instana.logger.debug e.backtrace.join("\r\n")
@@ -108,41 +114,36 @@ module Instana
     ##
     # report_entity_data
     #
-    # Method to report metrics data to the host agent.  Every 10 minutes, this
-    # method will also send a process snapshot data.
+    # Method to report metrics data to the host agent.
     #
     def report_entity_data(payload)
+      with_snapshot = false
       path = "com.instana.plugin.ruby.#{Process.pid}"
       uri = URI.parse("http://#{@host}:#{@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)
-        @last_snapshot = Time.now
       end
 
-      req['Accept'] = 'application/json'
-      req['Content-Type'] = 'application/json'
       req.body = payload.to_json
+      response = make_host_agent_request(req)
 
-      #Instana.logger.debug "Posting metrics to #{path}: #{payload.to_json}"
+      if response
+        last_entity_response = response.code.to_i
 
-      response = nil
-      Net::HTTP.start(uri.hostname, uri.port) do |http|
-        response = http.request(req)
-      end
+        if last_entity_response == 200
+          @entity_last_seen = Time.now
+          @last_snapshot = Time.now if with_snapshot
 
-      # If snapshot data is in the payload and last response
-      # was ok then delete the snapshot data.  Otherwise let it
-      # ride for another run.
-      if response.code.to_i == 200
-        @snapshot.each do |k, v|
-          payload.delete(k)
+          #::Instana.logger.debug "entity response #{last_entity_response}: #{payload.to_json}"
+          return true
         end
+        #::Instana.logger.debug "entity response #{last_entity_response}: #{payload.to_json}"
       end
-      Instana.logger.debug response.code unless response.code.to_i == 200
-      @last_entity_response = response.code.to_i
+      false
     rescue => e
       Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
       Instana.logger.debug e.backtrace.join("\r\n")
@@ -157,29 +158,111 @@ module Instana
       uri = URI.parse("http://#{@host}:#{@port}/")
       req = Net::HTTP::Get.new(uri)
 
+      response = make_host_agent_request(req)
+
+      (response && response.code.to_i == 200) ? true : false
+    rescue => e
+      Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
+      Instana.logger.debug e.backtrace.join("\r\n")
+      return false
+    end
+
+    private
+
+    ##
+    # transition_to
+    #
+    # Handles any/all steps required in the transtion
+    # between states.
+    #
+    def transition_to(state)
+      case state
+      when :announced
+        # announce successful; set state
+        @state = :announced
+
+        # 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
+      else
+        ::Instana.logger.warn "Uknown agent state: #{state}"
+      end
+    end
+
+    ##
+    # make host_agent_request
+    #
+    # Centralization of the net/http communications
+    # with the host agent. Pass in a prepared <req>
+    # of type Net::HTTP::Get|Put|Head
+    #
+    def make_host_agent_request(req)
       req['Accept'] = 'application/json'
       req['Content-Type'] = 'application/json'
 
-      ::Instana.logger.debug "Checking agent availability...."
-
       response = nil
-      Net::HTTP.start(uri.hostname, uri.port) do |http|
+      Net::HTTP.start(req.uri.hostname, req.uri.port, :open_timeout => 1, :read_timeout => 1) do |http|
         response = http.request(req)
       end
+      response
+    rescue Errno::ECONNREFUSED => e
+      Instana.logger.debug "Agent not responding. Connection refused."
+      return nil
+    rescue => e
+      Instana.logger.debug "Host agent request error: #{e.inspect}"
+      return nil
+    end
 
-      if response.code.to_i != 200
-        Instana.logger.debug "Host agent returned #{response.code}"
-        false
-      else
-        true
+    private
+    ##
+    # take_snapshot
+    #
+    # Method to collect up process info for snapshots.  This
+    # is generally used once per process.
+    #
+    def take_snapshot
+      data = {}
+
+      data[:sensorVersion] = ::Instana::VERSION
+      data[:pid] = ::Process.pid
+      data[:ruby_version] = RUBY_VERSION
+
+      process = ::ProcTable.ps(Process.pid)
+      arguments = process.cmdline.split(' ')
+      data[:name] = arguments.shift
+      data[:exec_args] = arguments
+
+      # Since a snapshot is only taken on process boot,
+      # this is ok here.
+      data[:start_time] = Time.now.to_s
+
+      # Framework Detection
+      if defined?(::RailsLts::VERSION)
+        data[:framework] = "Rails on Rails LTS-#{::RailsLts::VERSION}"
+
+      elsif defined?(::Rails.version)
+        data[:framework] = "Ruby on Rails #{::Rails.version}"
+
+      elsif defined?(::Grape::VERSION)
+        data[:framework] = "Grape #{::Grape::VERSION}"
+
+      elsif defined?(::Padrino::VERSION)
+        data[:framework] = "Padrino #{::Padrino::VERSION}"
+
+      elsif defined?(::Sinatra::VERSION)
+        data[:framework] = "Sinatra #{::Sinatra::VERSION}"
       end
-    rescue Errno::ECONNREFUSED => e
-      Instana.logger.debug "Agent not responding: #{e.inspect}"
-      return false
+
+      data
     rescue => e
-      Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
-      Instana.logger.debug e.backtrace.join("\r\n")
-      return false
+      ::Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
+      ::Instana.logger.debug e.backtrace.join("\r\n")
+      return data
     end
   end
 end

data/lib/instana/collectors.rb

@@ -7,6 +7,30 @@ module Instana
   module Collector
     class << self
       attr_accessor :interval
+      attr_accessor :snapshot
+
+      ##
+      # collect_and_report
+      #
+      # Run through each collector, let them collect up
+      # data and then report what we have via the agent
+      #
+      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
+
+        # Report all the collected goodies
+        ::Instana.agent.report_entity_data(payload)
+      end
+
     end
   end
 end
@@ -16,32 +40,3 @@ if ENV.key?('INSTANA_GEM_DEV')
 else
   ::Instana::Collector.interval = 1
 end
-
-::Thread.new do
-  timers = ::Timers::Group.new
-  payload = {}
-
-  timers.every(::Instana::Collector.interval) {
-
-    # Check if we forked (unicorn, puma) and
-    # if so, re-announce the process sensor
-    if ::Instana.pid_change?
-      ::Instana.logger.debug "Detected a fork (old: #{::Instana.pid} new: #{::Process.pid}).  Re-announcing sensor."
-      ::Instana.pid = Process.pid
-      Instana.agent.announce_sensor
-    end
-
-    ::Instana.collectors.each do |c|
-      metrics = c.collect
-      if metrics
-        payload[c.payload_key] = metrics
-      else
-        payload.delete(c.payload_key)
-      end
-    end
-
-    # Report all the collected goodies
-    ::Instana.agent.report_entity_data(payload)
-  }
-  loop { timers.wait }
-end

data/lib/instana/version.rb

@@ -1,3 +1,3 @@
 module Instana
-  VERSION = "0.8.1"
+  VERSION = "0.8.2"
 end

data/lib/instana.rb

@@ -17,14 +17,14 @@ module Instana
     # Initialize the Instana language agent
     #
     def start
-      Instana.agent = Instana::Agent.new
-      Instana.collectors = []
-      Instana.logger = Logger.new(STDOUT)
-      Instana.logger.info "Stan is on the scene.  Starting Instana instrumentation."
+      @agent = Instana::Agent.new
+      @collectors = []
+      @logger = Logger.new(STDOUT)
+      @logger.info "Stan is on the scene.  Starting Instana instrumentation."
 
       # Store the current pid so we can detect a potential fork
       # later on
-      Instana.pid = Process.pid
+      @pid = Process.pid
     end
 
     def pid_change?
@@ -33,14 +33,12 @@ module Instana
   end
 end
 
+
 require "instana/config"
 require "instana/agent"
 
 ::Instana.start
 
-if ::Instana.agent.host_agent_ready?
-  ::Instana.agent.announce_sensor
-  require "instana/collectors"
-else
-  ::Instana.logger.info "Instana host agent not available.  Going to sit in a corner quietly."
-end
+require "instana/collectors"
+
+::Instana.agent.start

metadata

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