instana 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e188f12fcff2a78ced457b2640b460b257e5684
-  data.tar.gz: c149e734156bf8b02ffd757cc564618c83ba7153
+  metadata.gz: 45d083c0409f57536ece61d39aad0bc07234f48f
+  data.tar.gz: 55b44b71738b9821aa79538aa184129a7fc8da54
 SHA512:
-  metadata.gz: 46e488894d84fa5b4afd32b486ae5c4af61ce30ceee001b6395f5c4dbb7fdfe68421093d765e59ecab0c647ef63992d0ebeb9c6abc1eed7af401cd69ad742cb1
-  data.tar.gz: 26be2c7a4a825baa23897a143ddbaabf631a1797e43716066509f984f84aa0d9c85054f7a67e3f9b8d59e3c9054f952c1769fd2b73a6d880c50df204585f46f1
+  metadata.gz: ebcf2e4efb164d9abc59d82e750354d3feaebd57658eb6c32dfe184a25f9c3cc7a8c976da2263a0d645c3c0b75a58af4d3d8d996b19ef0bc611426f4329f7c37
+  data.tar.gz: c2c486f05c4c7ae075bde638f74089e594527063c11488f9ae4ac52ed3cff4d4f3e73bc71852c89f2a8d831415e88a8ec0d81b0c1aac7ea97f2c0846f2c1ddc2

data/Configuration.md

@@ -0,0 +1,53 @@
+# Configuration
+
+## Logging
+
+The Instana logger is a standard Ruby logger that logs debug, warn, info
+(etc.) messages and can be set as follows:
+
+```Ruby
+require "logger"
+::Instana.logger.level = ::Logger::WARN
+```
+
+It also allows the debug level to be configured that affects
+what extra debug info it reports.  It allows for:
+
+* `:agent` - shows all agent state related debug messages
+* `:agent_comm` - outputs all request/response pairs to and from the
+  host agent
+
+Log messages can be generated for these channels using:
+
+```Ruby
+::Instana.logger.agent("agent specific log msg")
+::Instana.logger.agent_comm("agent communication specific log msg")
+```
+
+To set the debug log level:
+
+```Ruby
+::Instana.logger.debug_level = [:agent, :agent_comm]
+# or
+::Instana.logger.debug_level = [:agent_comm]
+# or
+::Instana.logger.debug_level = :agent
+```
+
+or to reset it:
+
+```Ruby
+::Instana.logger.debug_level = nil
+```
+
+Example output:
+```bash
+[2] pry(main)> Instana.logger.debug_level = :agent_comm
+=> :agent_comm
+
+D, [2016-12-01T11:45:12.876527 #74127] DEBUG -- : Instana: POST Req -> -body-: http://127.0.0.1:42699/com.instana.plugin.ruby.74127 ->
+-{"gc":{"heap_live":171890,"heap_free":522},"memory":{"rss_size":51212.0}}- Resp -> body:#<Net::HTTPOK:0x007faee2161078> -> -[]-
+
+[3] pry(main)> Instana.logger.debug_level = nil
+=> nil
+```

data/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 group :development, :test do
   gem 'rake'
-  gem 'minitest'
+  gem 'minitest', '5.9.1'
   gem 'minitest-reporters'
   gem 'minitest-debugger', :require => false
   gem 'rack-test'

data/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-<img src="https://www.instana.com/wp-content/uploads/2016/04/stan@2x.png" height="300px"/>
+<img src="http://www.instana.com/wp-content/uploads/2016/11/Instana-Infrastructure-Map-1-1024x551.png"/>
 </div>
 
 # Instana
@@ -61,6 +61,25 @@ Thread.new do
 end
 ```
 
+#### Caveat
+
+In the case of forking webservers such as Unicorn or Puma in clustered mode, the agent detects the pid change and re-spawns the background thread.  If you are managing the background thread yourself with the steps above _and_ you are using a forking webserver (or anything else that may fork the original process), you should also do the following.
+
+When a fork is detected, the agent handles the re-initialization and then calls `::Agent.instana.spawn_background_thread`.  This by default uses the standard `Thread.new`.  If you wish to control this, you should override this method by re-defining that method.  For example:
+
+```ruby
+# This method can be overridden with the following:
+#
+module Instana
+  class Agent
+    def spawn_background_thread
+      # start/identify custom thread
+      ::Instana.agent.start
+    end
+  end
+end
+```
+
 ### Components
 
 Individual components can be disabled with a local config.
@@ -97,3 +116,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/instana/ruby-sensor.
 
+## More
+
+Want Chef change visibility for your deploys?  Checkout [instana-chef](https://github.com/instana/instana-chef).
+

data/lib/instana/agent.rb

@@ -94,7 +94,7 @@ module Instana
     # the host agent.
     #
     def after_fork
-      ::Instana.logger.debug "after_fork hook called. Falling back to unannounced state and spawning a new background agent thread."
+      ::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
@@ -137,7 +137,7 @@ module Instana
       # 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. pid: #{Process.pid}"
+          ::Instana.logger.debug "Announce successful. Switching to metrics collection."
           transition_to(:announced)
         end
       end
@@ -165,6 +165,7 @@ module Instana
     # called from an already initialized background thread.
     #
     def start
+      ::Instana.logger.warn "Host agent not available.  Will retry periodically." unless host_agent_ready?
       loop do
         if @state == :unannounced
           @collect_timer.pause
@@ -176,7 +177,15 @@ module Instana
         @timers.wait
       end
     ensure
-      Instana.logger.debug "Agent start method exiting.  state: #{@state} pid: #{Process.pid}"
+      if @state == :announced
+        # Pause the timers so they don't fire while we are
+        # reporting traces
+        @collect_timer.pause
+        @announce_timer.pause
+
+        ::Instana.logger.debug "Agent exiting. Reporting final #{::Instana.processor.queue_count} trace(s)."
+        ::Instana.processor.send
+      end
     end
 
     # Indicates if the agent is ready to send metrics
@@ -187,7 +196,7 @@ module Instana
       return true if ENV['INSTANA_GEM_TEST']
 
       if forked?
-        ::Instana.logger.debug "Instana: detected fork.  Calling after_fork"
+        ::Instana.logger.agent "Instana: detected fork.  Calling after_fork"
         after_fork
       end
 
@@ -216,7 +225,7 @@ module Instana
       req = Net::HTTP::Put.new(uri)
       req.body = announce_payload.to_json
 
-      # ::Instana.logger.debug "Announce: http://#{@host}:#{@port}/#{DISCOVERY_PATH} - payload: #{req.body}"
+      ::Instana.logger.agent "Announce: http://#{@host}:#{@port}/#{DISCOVERY_PATH} - payload: #{req.body}"
 
       response = make_host_agent_request(req)
 
@@ -263,8 +272,6 @@ module Instana
       if response
         last_entity_response = response.code.to_i
 
-        #::Instana.logger.debug "entity http://#{@host}:#{@port}/#{path}: response=#{last_entity_response}: #{payload.to_json}"
-
         if last_entity_response == 200
           @entity_last_seen = Time.now
           @last_snapshot = Time.now if with_snapshot
@@ -296,8 +303,6 @@ module Instana
       if response
         last_trace_response = response.code.to_i
 
-        #::Instana.logger.debug "traces response #{last_trace_response}: #{spans.to_json}"
-
         if [200, 204].include?(last_trace_response)
           return true
         end
@@ -354,6 +359,7 @@ module Instana
     #   `:announced`, `:unannounced`
     #
     def transition_to(state)
+      ::Instana.logger.agent("Transitioning to #{state}")
       case state
       when :announced
         # announce successful; set state
@@ -391,6 +397,7 @@ 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}-"
       response
     rescue Errno::ECONNREFUSED => e
       return nil

data/lib/instana/base.rb

@@ -1,5 +1,5 @@
-require 'logger'
 require "instana/version"
+require 'instana/logger'
 require "instana/util"
 
 module Instana
@@ -19,7 +19,7 @@ module Instana
     # to run" state.
     #
     def setup
-      @logger = Logger.new(STDOUT)
+      @logger = ::Instana::XLogger.new(STDOUT)
       if ENV.key?('INSTANA_GEM_TEST') || ENV.key?('INSTANA_GEM_DEV')
         @logger.level = Logger::DEBUG
       else

data/lib/instana/logger.rb

@@ -0,0 +1,58 @@
+require "logger"
+
+module Instana
+  class XLogger < Logger
+    LEVELS = [:agent, :agent_comm].freeze
+    STAMP = "Instana: ".freeze
+
+    def initialize(*args)
+      if ENV['INSTANA_GEM_DEV']
+        self.debug_level=:agent
+      end
+      super(*args)
+    end
+
+    def debug_level=(levels)
+      LEVELS.each do |l|
+        instance_variable_set("@level_#{l}", false)
+      end
+
+      levels = [ levels ] unless levels.is_a?(Array)
+      levels.each do |l|
+        next unless LEVELS.include?(l)
+        instance_variable_set("@level_#{l}", true)
+      end
+    end
+
+    def agent(msg)
+      return unless @level_agent
+      self.debug(msg)
+    end
+
+    def agent_comm(msg)
+      return unless @level_agent_comm
+      self.debug(msg)
+    end
+
+    def error(msg)
+      super(STAMP + msg)
+    end
+
+    def warn(msg)
+      super(STAMP + msg)
+    end
+
+    def info(msg)
+      super(STAMP + msg)
+    end
+
+    def debug(msg)
+      super(STAMP + msg)
+    end
+
+    def unkown(msg)
+      super(STAMP + msg)
+    end
+  end
+end
+

data/lib/instana/tracing/processor.rb

@@ -30,7 +30,7 @@ module Instana
       return if @queue.empty?
 
       size = @queue.size
-      if size > 10
+      if size > 100
         Instana.logger.debug "Trace queue is #{size}"
       end
 

data/lib/instana/version.rb

@@ -1,3 +1,3 @@
 module Instana
-  VERSION = "0.10.1"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2016-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,6 +117,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- Configuration.md
 - Gemfile
 - README.md
 - Rakefile
@@ -136,6 +137,7 @@ files:
 - lib/instana/instrumentation.rb
 - lib/instana/instrumentation/net-http.rb
 - lib/instana/instrumentation/rack.rb
+- lib/instana/logger.rb
 - lib/instana/rack.rb
 - lib/instana/setup.rb
 - lib/instana/thread_local.rb