instana 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4f4776893611a534108c425fee351857893c440
-  data.tar.gz: c432c9c4ac294429d3a2e1c7db6f9d995c7f8e27
+  metadata.gz: 44d2db00220595e42136a421be4f1d9d149fb958
+  data.tar.gz: 0e52f23d95fbfdf296c4632da28319d170298ca9
 SHA512:
-  metadata.gz: 469f5a906f2936196c3af073c7d07b13191414690b3646ac1a216b10deaee0f609d8767b22a4ead6eb32a2d4ef828943b73000de30dca305d7150ad08e9f2e17
-  data.tar.gz: f9e47e7a26878761d9353a25ae6de9a82b1d6ed19cf143a7e4feb684e47e0ec2139deaee5a7f3e9a780685021539afb27861534c6569f06170062bdb328b7b24
+  metadata.gz: 1e753d5fbd1c60c52afaa5a8219ee5c4e980dff40c22d27ccfc719ffc4068c72dae09e8a7fe5e072b30aa63e6a4fd5b240af054444df2a7f4a6a1a7b333aed05
+  data.tar.gz: 768f34f163485454e6371ab0ce2b39e44020a19ff44a9efe5a107b9efe282574f9cdcd6c62893a473fd86e323cb94438f2a751e06063e45cadc0c286c3ccf1a8

data/Configuration.md

@@ -1,6 +1,24 @@
 # Configuration
 
-## Enabling/Disabling Components
+## Global Enable/Disable
+
+The entire gem can be disabled at runtime with:
+
+```Ruby
+::Instana.config[:enabled] = false # default: true
+```
+
+Other global enable/disable options are:
+
+```Ruby
+# Enable/Disable metrics collection and reporting
+Instana.config[:metrics][:enabled] # default true
+
+# Enable/Disable tracing
+Instana.config[:tracing][:enabled] # default true
+```
+
+## Enabling/Disabling Individual Components
 
 Individual components can be enabled and disabled with a local config.
 

data/lib/instana/collector.rb

@@ -45,6 +45,8 @@ module Instana
     # @return Boolean true on success
     #
     def collect_and_report
+      return unless ::Instana.config[:metrics][:enabled]
+
       payload = {}
       with_snapshot = false
 

data/lib/instana/config.rb

@@ -3,13 +3,24 @@ module Instana
 
     def initialize
       @config = {}
+
       @config[:agent_host] = '127.0.0.1'
       @config[:agent_port] = 42699
-      @config[:metrics] = {}
+
+      # Global on/off switch for prebuilt environments
+      # Setting this to false will disable this gem
+      # from doing anything.
+      @config[:enabled] = true
+
+      # Enable/disable metrics globally or individually (default: all enabled)
+      @config[:metrics] = { :enabled => true }
       @config[:metrics][:gc]     = { :enabled => true }
       @config[:metrics][:memory] = { :enabled => true }
       @config[:metrics][:thread] = { :enabled => true }
 
+      # Enable/disable tracing (default: enabled)
+      @config[:tracing] = { :enabled => true }
+
       if ENV.key?('INSTANA_GEM_DEV')
         @config[:collector] = { :enabled => true, :interval => 3 }
       else
@@ -36,6 +47,13 @@ module Instana
 
     def []=(key, value)
       @config[key.to_sym] = value
+
+      if key == :enabled
+        # Configuring global enable/disable flag, then set the
+        # appropriate children flags.
+        @config[:metrics][:enabled] = value
+        @config[:tracing][:enabled] = value
+      end
     end
   end
 end

data/lib/instana/logger.rb

@@ -6,6 +6,7 @@ module Instana
     STAMP = "Instana: ".freeze
 
     def initialize(*args)
+      super(*args)
       if ENV.key?('INSTANA_GEM_TEST')
         self.level = Logger::DEBUG
       elsif ENV.key?('INSTANA_GEM_DEV')
@@ -14,7 +15,6 @@ module Instana
       else
         self.level = Logger::WARN
       end
-      super(*args)
     end
 
     # Sets the debug level for this logger.  The debug level is broken up into various

data/lib/instana/tracer.rb

@@ -72,7 +72,7 @@ module Instana
     #     :level specifies data collection level (optional)
     #
     def log_start_or_continue(name, kvs = {}, incoming_context = {})
-      return unless ::Instana.agent.ready?
+      return if !::Instana.agent.ready? || !::Instana.config[:tracing][:enabled]
       ::Instana.logger.debug "#{__method__} passed a block.  Use `start_or_continue` instead!" if block_given?
       self.current_trace = ::Instana::Trace.new(name, kvs, incoming_context)
     end
@@ -191,7 +191,11 @@ module Instana
         self.current_trace.add_async_info(kvs, span)
       else
         trace = ::Instana.processor.staged_trace(span.context.trace_id)
-        trace.add_async_info(kvs, span)
+        if trace
+          trace.add_async_info(kvs, span)
+        else
+          ::Instana.logger.debug "#{__method__}: Couldn't find staged trace. #{span.inspect}"
+        end
       end
     end
 
@@ -210,7 +214,11 @@ module Instana
         self.current_trace.add_async_error(e, span)
       else
         trace = ::Instana.processor.staged_trace(span.context.trace_id)
-        trace.add_async_error(e, span)
+        if trace
+          trace.add_async_error(e, span)
+        else
+          ::Instana.logger.debug "#{__method__}: Couldn't find staged trace. #{span.inspect}"
+        end
       end
     end
 
@@ -235,7 +243,7 @@ module Instana
         if trace
           trace.end_async_span(kvs, span)
         else
-          ::Instana.logger.debug "log_async_exit: Couldn't find staged trace. #{span.inspect}"
+          ::Instana.logger.debug "#{__method__}: Couldn't find staged trace. #{span.inspect}"
         end
       end
     end

data/lib/instana/version.rb

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

data/test/config_test.rb

@@ -10,8 +10,28 @@ class ConfigTest < Minitest::Test
     assert_equal '127.0.0.1', ::Instana.config[:agent_host]
     assert_equal 42699, ::Instana.config[:agent_port]
 
+    assert ::Instana.config[:enabled]
+    assert ::Instana.config[:tracing][:enabled]
+    assert ::Instana.config[:metrics][:enabled]
+
     ::Instana.config[:metrics].each do |k, v|
       assert_equal true, ::Instana.config[:metrics][k].key?(:enabled)
     end
   end
+
+  def test_that_global_affects_children
+    # Disabling the gem should explicitly disable
+    # metrics and tracing flags
+    ::Instana.config[:enabled] = false
+
+    assert_equal false, ::Instana.config[:tracing][:enabled]
+    assert_equal false, ::Instana.config[:metrics][:enabled]
+
+    # Enabling the gem should explicitly enable
+    # metrics and tracing flags
+    ::Instana.config[:enabled] = true
+
+    assert_equal ::Instana.config[:tracing][:enabled]
+    assert_equal ::Instana.config[:metrics][:enabled]
+  end
 end

data/test/tracing/tracer_test.rb

@@ -6,6 +6,20 @@ class TracerTest < Minitest::Test
     assert ::Instana.tracer.is_a?(::Instana::Tracer)
   end
 
+  def test_obey_tracing_config
+    clear_all!
+
+    ::Instana.config[:tracing][:enabled] = false
+    assert_equal false, ::Instana.tracer.tracing?
+
+    ::Instana.tracer.start_or_continue_trace(:rack, {:one => 1}) do
+      assert_equal false, ::Instana.tracer.tracing?
+    end
+
+    ::Instana.config[:tracing][:enabled] = true
+  end
+
+
   def test_basic_trace_block
     clear_all!
 
@@ -13,7 +27,7 @@ class TracerTest < Minitest::Test
 
     ::Instana.tracer.start_or_continue_trace(:rack, {:one => 1}) do
       assert_equal true, ::Instana.tracer.tracing?
-      sleep 0.5
+      sleep 0.3
     end
 
     traces = ::Instana.processor.queued_traces

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-25 00:00:00.000000000 Z
+date: 2017-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler