instana 1.11.4 → 1.12.0

data/lib/instana/test.rb

@@ -7,14 +7,15 @@ module Instana
       def setup_environment
         # Set defaults if not set
         ENV['MEMCACHED_HOST']     ||= '127.0.0.1:11211'
-        ENV['TRAVIS_PSQL_HOST']   ||= "127.0.0.1"
-        ENV['TRAVIS_PSQL_USER']   ||= "postgres"
+        ENV['POSTGRES_HOST']      ||= "127.0.0.1"
+        ENV['POSTGRES_USER']      ||= "stan"
+        ENV['POSTGRES_PASSWORD']  ||= "stanlikesdata"
         ENV['TRAVIS_MYSQL_HOST']  ||= "127.0.0.1"
         ENV['TRAVIS_MYSQL_USER']  ||= "root"
 
         if !ENV.key?('DATABASE_URL')
           if ENV['DB_FLAVOR'] == 'postgresql'
-            ENV['DATABASE_URL'] = "postgresql://#{ENV['TRAVIS_PSQL_USER']}:#{ENV['TRAVIS_PSQL_PASS']}@#{ENV['TRAVIS_PSQL_HOST']}:5432/travis_ci_test"
+            ENV['DATABASE_URL'] = "postgresql://#{ENV['POSTGRES_USER']}:#{ENV['POSTGRES_PASSWORD']}@#{ENV['POSTGRES_HOST']}:5432/#{ENV['POSTGRES_USER']}"
           elsif ENV['DB_FLAVOR'] == 'mysql'
             ENV['DATABASE_URL'] = "mysql://#{ENV['TRAVIS_MYSQL_USER']}:#{ENV['TRAVIS_MYSQL_PASS']}@#{ENV['TRAVIS_MYSQL_HOST']}:3306/travis_ci_test"
           else

data/lib/instana/tracer.rb

@@ -26,7 +26,7 @@ module Instana
     # Will start a new trace or continue an on-going one (such as
     # from incoming remote requests with context headers).
     #
-    # @param name [String] the name of the span to start
+    # @param name [String, Symbol] the name of the span to start
     # @param kvs [Hash] list of key values to be reported in the span
     # @param incoming_context [Hash] specifies the incoming context.  At a
     #   minimum, it should specify :trace_id and :span_id from the following:
@@ -52,7 +52,7 @@ module Instana
     #   @db.select(1)
     # end
     #
-    # @param name [String] the name of the span to start
+    # @param name [String, Symbol] the name of the span to start
     # @param kvs [Hash] list of key values to be reported in this new span
     #
     def trace(name, kvs = {}, &block)
@@ -72,7 +72,7 @@ module Instana
     # Will start a new trace or continue an on-going one (such as
     # from incoming remote requests with context headers).
     #
-    # @param name [String] the name of the span to start
+    # @param name [String, Symbol] the name of the span to start
     # @param kvs [Hash] list of key values to be reported in the span
     # @param incoming_context [SpanContext or Hash] specifies the incoming context.  At a
     #   minimum, it should specify :trace_id and :span_id from the following:
@@ -107,7 +107,7 @@ module Instana
     # Will establish a new span as a child of the current span
     # in an existing trace
     #
-    # @param name [String] the name of the span to create
+    # @param name [String, Symbol] the name of the span to create
     # @param kvs [Hash] list of key values to be reported in the span
     #
     def log_entry(name, kvs = nil, start_time = ::Instana::Util.now_in_ms, child_of = nil)
@@ -145,7 +145,7 @@ module Instana
     # @note `name` isn't really required but helps keep sanity that
     # we're closing out the span that we really want to close out.
     #
-    # @param name [String] the name of the span to exit (close out)
+    # @param name [String, Symbol] the name of the span to exit (close out)
     # @param kvs [Hash] list of key values to be reported in the span
     #
     def log_exit(name, kvs = {})
@@ -263,6 +263,27 @@ module Instana
       new_span
     end
 
+    # Start a new span which is the child of the current span
+    #
+    # @param operation_name [String] The name of the operation represented by the span
+    # @param child_of [Span] A span to be used as the ChildOf reference
+    # @param start_time [Time] the start time of the span
+    # @param tags [Hash] Starting tags for the span
+    #
+    # @return [Span]
+    #
+    def start_active_span(operation_name, child_of: self.current_span, start_time: ::Instana::Util.now_in_ms, tags: nil)
+      self.current_span = start_span(operation_name, child_of: child_of, start_time: start_time, tags: tags)
+    end
+
+    # Returns the currently active span
+    #
+    # @return [Span]
+    #
+    def active_span
+      self.current_span
+    end
+
     # Inject a span into the given carrier
     #
     # @param span_context [SpanContext]

data/lib/instana/tracing/span.rb

@@ -303,6 +303,15 @@ module Instana
     # a String, Numeric, or Boolean it will be encoded with to_s
     #
     def set_tag(key, value)
+      if ![Symbol, String].include?(key.class)
+        key = key.to_s
+      end
+
+      # If <value> is not a Symbol, String, Array, Hash or Numeric - convert to string
+      if ![Symbol, String, Array, TrueClass, FalseClass, Hash].include?(value.class) && !value.is_a?(Numeric)
+        value = value.to_s
+      end
+
       if custom?
         @data[:data][:sdk][:custom] ||= {}
         @data[:data][:sdk][:custom][:tags] ||= {}

data/lib/instana/version.rb

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

data/test/apps/cuba.rb

@@ -7,6 +7,10 @@ Cuba.define do
     on "hello" do
       res.write "Hello Instana!"
     end
+    
+    on "greet/:name" do |name|
+      res.write "Hello, #{name}"
+    end
 
     on root do
       res.redirect '/hello'

data/test/apps/roda.rb

@@ -6,5 +6,8 @@ class InstanaRodaApp < Roda
     r.get "hello" do
       "Hello Roda + Instana"
     end
+    r.get "greet", String do |name|
+      "Hello, #{name}!"
+    end
   end
 end

data/test/apps/sinatra.rb

@@ -2,4 +2,8 @@ class InstanaSinatraApp < ::Sinatra::Base
   get '/' do
     "Hello Sinatra!"
   end
+  
+  get '/greet/:name' do
+    "Hello, #{params[:name]}!"
+  end
 end

data/test/frameworks/cuba_test.rb

@@ -1,4 +1,3 @@
-
 if defined?(::Cuba)
   require 'test_helper'
   require File.expand_path(File.dirname(__FILE__) + '/../apps/cuba')
@@ -40,5 +39,19 @@ if defined?(::Cuba)
       assert first_span[:data][:http].key?(:host)
       assert_equal "example.org", first_span[:data][:http][:host]
     end
+
+    def test_path_template
+      clear_all!
+
+      r = get '/greet/instana'
+      assert last_response.ok?
+
+      spans = ::Instana.processor.queued_spans
+      assert_equal 1, spans.count
+
+      first_span = spans.first
+      assert_equal :rack, first_span[:n]
+      assert_equal '/greet/{name}', first_span[:data][:http][:path_tpl]
+    end
   end
 end

data/test/frameworks/rack_test.rb

@@ -5,16 +5,22 @@ require "instana/rack"
 
 class RackTest < Minitest::Test
   include Rack::Test::Methods
+  
+  class PathTemplateApp
+    def call(env)
+      env['INSTANA_HTTP_PATH_TEMPLATE'] = 'sample_template'
+      [200, {}, ['Ok']]
+    end
+  end
 
   def app
-    @app = Rack::Builder.new {
+    @app = Rack::Builder.new do
       use Rack::CommonLogger
       use Rack::ShowExceptions
       use Instana::Rack
-      map "/mrlobster" do
-        run Rack::Lobster.new
-      end
-    }
+      map("/mrlobster") { run Rack::Lobster.new }
+      map("/path_tpl") { run PathTemplateApp.new }
+    end
   end
 
   def test_basic_get
@@ -29,23 +35,33 @@ class RackTest < Minitest::Test
     # Span validation
     assert_equal 1, spans.count
 
-    first_span = spans.first
-    assert_equal :rack, first_span[:n]
-    assert first_span.key?(:data)
-    assert first_span[:data].key?(:http)
-    assert_equal "GET", first_span[:data][:http][:method]
-    assert_equal "/mrlobster", first_span[:data][:http][:url]
-    assert_equal 200, first_span[:data][:http][:status]
-    assert_equal 'example.org', first_span[:data][:http][:host]
-    assert first_span.key?(:f)
-    assert first_span[:f].key?(:e)
-    assert first_span[:f].key?(:h)
-    assert_equal ::Instana.agent.agent_uuid, first_span[:f][:h]
+    rack_span = spans.first
+    assert_equal :rack, rack_span[:n]
+
+    assert last_response.headers.key?("X-Instana-T")
+    assert last_response.headers["X-Instana-T"] == ::Instana::Util.id_to_header(rack_span[:t])
+    assert last_response.headers.key?("X-Instana-S")
+    assert last_response.headers["X-Instana-S"] == ::Instana::Util.id_to_header(rack_span[:s])
+    assert last_response.headers.key?("X-Instana-L")
+    assert last_response.headers["X-Instana-L"] == '1'
+    assert last_response.headers.key?("Server-Timing")
+    assert last_response.headers["Server-Timing"] == "intid;desc=#{::Instana::Util.id_to_header(rack_span[:t])}"
+
+    assert rack_span.key?(:data)
+    assert rack_span[:data].key?(:http)
+    assert_equal "GET", rack_span[:data][:http][:method]
+    assert_equal "/mrlobster", rack_span[:data][:http][:url]
+    assert_equal 200, rack_span[:data][:http][:status]
+    assert_equal 'example.org', rack_span[:data][:http][:host]
+    assert rack_span.key?(:f)
+    assert rack_span[:f].key?(:e)
+    assert rack_span[:f].key?(:h)
+    assert_equal ::Instana.agent.agent_uuid, rack_span[:f][:h]
 
     # Backtrace fingerprint validation
-    assert first_span.key?(:stack)
-    assert_equal 2, first_span[:stack].count
-    refute_nil first_span[:stack].first[:c].match(/instana\/instrumentation\/rack.rb/)
+    assert rack_span.key?(:stack)
+    assert_equal 2, rack_span[:stack].count
+    refute_nil rack_span[:stack].first[:c].match(/instana\/instrumentation\/rack.rb/)
 
     # Restore to default
     ::Instana.config[:collect_backtraces] = false
@@ -63,8 +79,8 @@ class RackTest < Minitest::Test
     # Span validation
     assert_equal 1, spans.count
 
-    first_span = spans.first
-    assert_equal 'WalterBishop', first_span[:data][:service]
+    rack_span = spans.first
+    assert_equal 'WalterBishop', rack_span[:data][:service]
 
     ENV.delete('INSTANA_SERVICE_NAME')
   end
@@ -78,17 +94,27 @@ class RackTest < Minitest::Test
 
     # Span validation
     assert_equal 1, spans.count
-    first_span = spans.first
-    assert_equal :rack, first_span[:n]
-    assert first_span.key?(:data)
-    assert first_span[:data].key?(:http)
-    assert_equal "POST", first_span[:data][:http][:method]
-    assert_equal "/mrlobster", first_span[:data][:http][:url]
-    assert_equal 200, first_span[:data][:http][:status]
-    assert first_span.key?(:f)
-    assert first_span[:f].key?(:e)
-    assert first_span[:f].key?(:h)
-    assert_equal ::Instana.agent.agent_uuid, first_span[:f][:h]
+    rack_span = spans.first
+    assert_equal :rack, rack_span[:n]
+
+    assert last_response.headers.key?("X-Instana-T")
+    assert last_response.headers["X-Instana-T"] == ::Instana::Util.id_to_header(rack_span[:t])
+    assert last_response.headers.key?("X-Instana-S")
+    assert last_response.headers["X-Instana-S"] == ::Instana::Util.id_to_header(rack_span[:s])
+    assert last_response.headers.key?("X-Instana-L")
+    assert last_response.headers["X-Instana-L"] == '1'
+    assert last_response.headers.key?("Server-Timing")
+    assert last_response.headers["Server-Timing"] == "intid;desc=#{::Instana::Util.id_to_header(rack_span[:t])}"
+
+    assert rack_span.key?(:data)
+    assert rack_span[:data].key?(:http)
+    assert_equal "POST", rack_span[:data][:http][:method]
+    assert_equal "/mrlobster", rack_span[:data][:http][:url]
+    assert_equal 200, rack_span[:data][:http][:status]
+    assert rack_span.key?(:f)
+    assert rack_span[:f].key?(:e)
+    assert rack_span[:f].key?(:h)
+    assert_equal ::Instana.agent.agent_uuid, rack_span[:f][:h]
   end
 
   def test_basic_put
@@ -100,17 +126,27 @@ class RackTest < Minitest::Test
 
     # Span validation
     assert_equal 1, spans.count
-    first_span = spans.first
-    assert_equal :rack, first_span[:n]
-    assert first_span.key?(:data)
-    assert first_span[:data].key?(:http)
-    assert_equal "PUT", first_span[:data][:http][:method]
-    assert_equal "/mrlobster", first_span[:data][:http][:url]
-    assert_equal 200, first_span[:data][:http][:status]
-    assert first_span.key?(:f)
-    assert first_span[:f].key?(:e)
-    assert first_span[:f].key?(:h)
-    assert_equal ::Instana.agent.agent_uuid, first_span[:f][:h]
+    rack_span = spans.first
+    assert_equal :rack, rack_span[:n]
+
+    assert last_response.headers.key?("X-Instana-T")
+    assert last_response.headers["X-Instana-T"] == ::Instana::Util.id_to_header(rack_span[:t])
+    assert last_response.headers.key?("X-Instana-S")
+    assert last_response.headers["X-Instana-S"] == ::Instana::Util.id_to_header(rack_span[:s])
+    assert last_response.headers.key?("X-Instana-L")
+    assert last_response.headers["X-Instana-L"] == '1'
+    assert last_response.headers.key?("Server-Timing")
+    assert last_response.headers["Server-Timing"] == "intid;desc=#{::Instana::Util.id_to_header(rack_span[:t])}"
+
+    assert rack_span.key?(:data)
+    assert rack_span[:data].key?(:http)
+    assert_equal "PUT", rack_span[:data][:http][:method]
+    assert_equal "/mrlobster", rack_span[:data][:http][:url]
+    assert_equal 200, rack_span[:data][:http][:status]
+    assert rack_span.key?(:f)
+    assert rack_span[:f].key?(:e)
+    assert rack_span[:f].key?(:h)
+    assert_equal ::Instana.agent.agent_uuid, rack_span[:f][:h]
   end
 
   def test_context_continuation
@@ -125,23 +161,33 @@ class RackTest < Minitest::Test
 
     # Span validation
     assert_equal 1, spans.count
-    first_span = spans.first
-    assert_equal :rack, first_span[:n]
-    assert first_span.key?(:data)
-    assert first_span[:data].key?(:http)
-    assert_equal "GET", first_span[:data][:http][:method]
-    assert_equal "/mrlobster", first_span[:data][:http][:url]
-    assert_equal 200, first_span[:data][:http][:status]
-    assert first_span.key?(:f)
-    assert first_span[:f].key?(:e)
-    assert first_span[:f].key?(:h)
-    assert_equal ::Instana.agent.agent_uuid, first_span[:f][:h]
+    rack_span = spans.first
+    assert_equal :rack, rack_span[:n]
+
+    assert last_response.headers.key?("X-Instana-T")
+    assert last_response.headers["X-Instana-T"] == ::Instana::Util.id_to_header(rack_span[:t])
+    assert last_response.headers.key?("X-Instana-S")
+    assert last_response.headers["X-Instana-S"] == ::Instana::Util.id_to_header(rack_span[:s])
+    assert last_response.headers.key?("X-Instana-L")
+    assert last_response.headers["X-Instana-L"] == '1'
+    assert last_response.headers.key?("Server-Timing")
+    assert last_response.headers["Server-Timing"] == "intid;desc=#{::Instana::Util.id_to_header(rack_span[:t])}"
+
+    assert rack_span.key?(:data)
+    assert rack_span[:data].key?(:http)
+    assert_equal "GET", rack_span[:data][:http][:method]
+    assert_equal "/mrlobster", rack_span[:data][:http][:url]
+    assert_equal 200, rack_span[:data][:http][:status]
+    assert rack_span.key?(:f)
+    assert rack_span[:f].key?(:e)
+    assert rack_span[:f].key?(:h)
+    assert_equal ::Instana.agent.agent_uuid, rack_span[:f][:h]
 
     # Context validation
     # The first span should have the passed in trace ID
     # and specify the passed in span ID as it's parent.
-    assert_equal 1234, first_span[:t]
-    assert_equal 4321, first_span[:p]
+    assert_equal 1234, rack_span[:t]
+    assert_equal 4321, rack_span[:p]
   end
 
   def test_instana_response_headers
@@ -181,20 +227,34 @@ class RackTest < Minitest::Test
 
     # Span validation
     assert_equal 1, spans.count
-    first_span = spans.first
+    rack_span = spans.first
 
-    assert first_span[:data][:http].key?(:header)
-    assert first_span[:data][:http][:header].key?(:"X-Capture-This")
-    assert !first_span[:data][:http][:header].key?(:"X-Capture-That")
-    assert_equal "ThereYouGo", first_span[:data][:http][:header][:"X-Capture-This"]
+    assert rack_span[:data][:http].key?(:header)
+    assert rack_span[:data][:http][:header].key?(:"X-Capture-This")
+    assert !rack_span[:data][:http][:header].key?(:"X-Capture-That")
+    assert_equal "ThereYouGo", rack_span[:data][:http][:header][:"X-Capture-This"]
 
     # Backtrace fingerprint validation
-    assert first_span.key?(:stack)
-    assert_equal 2, first_span[:stack].count
-    refute_nil first_span[:stack].first[:c].match(/instana\/instrumentation\/rack.rb/)
+    assert rack_span.key?(:stack)
+    assert_equal 2, rack_span[:stack].count
+    refute_nil rack_span[:stack].first[:c].match(/instana\/instrumentation\/rack.rb/)
 
     # Restore to default
     ::Instana.config[:collect_backtraces] = false
     ::Instana.agent.extra_headers = nil
   end
+  
+  def test_capture_http_path_template
+    clear_all!
+    
+    get '/path_tpl'
+    assert last_response.ok?
+    
+    spans = ::Instana.processor.queued_spans
+    assert_equal 1, spans.length
+    
+    rack_span = spans.first
+    assert_equal :rack, rack_span[:n]
+    assert_equal 'sample_template', rack_span[:data][:http][:path_tpl]
+  end
 end

data/test/frameworks/rails/actioncontroller_test.rb

@@ -153,4 +153,16 @@ class ActionControllerTest < Minitest::Test
     assert ac_span.key?(:stack)
     assert 1, ac_span[:ec]
   end
+  
+  def test_path_template
+    clear_all!
+
+    Net::HTTP.get(URI.parse('http://localhost:3205/test/world'))
+    
+    spans = ::Instana.processor.queued_spans
+    rack_span = find_first_span_by_name(spans, :rack)
+
+    assert_equal false, rack_span.key?(:error)
+    assert_equal '/test/world(.:format)', rack_span[:data][:http][:path_tpl]
+  end
 end

data/test/frameworks/roda_test.rb

@@ -40,5 +40,19 @@ if defined?(::Roda)
       assert first_span[:data][:http].key?(:host)
       assert_equal "example.org", first_span[:data][:http][:host]
     end
+    
+    def test_path_template
+      clear_all!
+
+      r = get '/greet/instana'
+      assert last_response.ok?
+
+      spans = ::Instana.processor.queued_spans
+      assert_equal 1, spans.count
+
+      first_span = spans.first
+      assert_equal :rack, first_span[:n]
+      assert_equal '/greet/{name}', first_span[:data][:http][:path_tpl]
+    end
   end
 end