instana 1.11.8 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03473a7a2f7e8a5306869674ff671f1d5b66804e41bd1f687c512a33c0b07f3c
-  data.tar.gz: aaf1ada0116589a5d33e1f74558a6c32801971e5f5f4e512be56ff6524ab447b
+  metadata.gz: 7f4a95f79f6ce7a30fe5f54797a8a47637dd659345043155c13eec90a8fe221c
+  data.tar.gz: 8206b32f50dd0f80386854ec216414cb976f3045ba113e5a86f161cba87a4736
 SHA512:
-  metadata.gz: 6993a2dcb47b648445c97fea1017bcc9392f889270613078fd32fb2881365d88260ae0082e23eed6f32f9d111f67021dc9f2485f5cb4777b6317b7541352d40d
-  data.tar.gz: 5c8c34a422def00edda43e613899a59b99bae6c1cf1323d79c135703b1c6ab5d565ece30f8b8f0497e0ea79a7cf1585912c17ddf5e8c363cb33f792e6f7a6903
+  metadata.gz: 9eada422ab4a40b7566fa1ae44614efc0ca2874ba0018fecd494ec01e31d1fa66c3a5ba18f86d6ded8089cbad85b196a21b57eaa79a17372ae954385c9ddfd7e
+  data.tar.gz: ffa1dd9e0eac0d0041945d1ddd10ecfcb813c82dcfa5aa241302838c02af17a015457af0344654bb77cc6ffb245958c8ab712c9eab450fbb627fa185ab591075

data/lib/instana/frameworks/cuba.rb

@@ -1,6 +1,39 @@
 require "instana/rack"
 
+module Instana
+  module CubaPathTemplateExtractor
+    REPLACE_TARGET = /:(?<term>[^\/]+)/i
+    
+    def self.prepended(base)
+      ::Instana.logger.debug "#{base} prepended #{self}"
+    end
+    
+    def on(*args, &blk) 
+      wrapper = lambda do |*caputres|
+        env['INSTANA_PATH_TEMPLATE_FRAGMENTS'] << args
+          .select { |a| a.is_a?(String) }
+          .join('/')
+      
+        blk.call(*captures)
+      end
+      
+      super(*args, &wrapper)
+    end
+    
+    def call!(env)
+      env['INSTANA_PATH_TEMPLATE_FRAGMENTS'] = []
+      response = super(env)
+      env['INSTANA_HTTP_PATH_TEMPLATE'] = env['INSTANA_PATH_TEMPLATE_FRAGMENTS']
+        .join('/')
+        .gsub(REPLACE_TARGET, '{\k<term>}')
+      response
+    end
+  end
+end
+
+
 if defined?(::Cuba)
   ::Instana.logger.debug "Instrumenting Cuba"
   Cuba.use ::Instana::Rack
+  Cuba.prepend ::Instana::CubaPathTemplateExtractor
 end

data/lib/instana/frameworks/instrumentation/action_controller.rb

@@ -64,6 +64,15 @@ module Instana
         end
         name
       end
+      
+      def matched_path_template
+        Rails.application.routes.router.recognize(request) do |route, _, _|
+          path = route.path
+          return path.spec.to_s
+        end
+        
+        nil
+      end
     end
 
     # Used in ActionPack versions 5 and beyond, this module provides
@@ -83,6 +92,7 @@ module Instana
         ::Instana.tracer.log_entry(:actioncontroller, kv_payload)
 
         super(*args)
+        request.env['INSTANA_HTTP_PATH_TEMPLATE'] = matched_path_template
       rescue Exception => e
         ::Instana.tracer.log_error(e) unless has_rails_handler?(e)
         raise
@@ -135,6 +145,7 @@ module Instana
         ::Instana.tracer.log_entry(:actioncontroller, kv_payload)
 
         process_action_without_instana(*args)
+        request.env['INSTANA_HTTP_PATH_TEMPLATE'] = matched_path_template
       rescue Exception => e
         ::Instana.tracer.log_error(e) unless has_rails_handler?(e)
         raise

data/lib/instana/frameworks/roda.rb

@@ -1,6 +1,47 @@
 require "instana/rack"
 
+module Instana
+  module RodaPathTemplateExtractor
+    module RequestMethods
+      TERM = defined?(::Roda) ? ::Roda::RodaPlugins::Base::RequestMethods::TERM : Object
+      
+      def if_match(args, &blk)
+        path = @remaining_path
+        captures = @captures.clear
+  
+        if match_all(args)
+          (env['INSTANA_PATH_TEMPLATE_FRAGMENTS'] ||= []).concat(named_args(args, blk))
+          block_result(blk.(*captures))
+          env['INSTANA_HTTP_PATH_TEMPLATE'] = env['INSTANA_PATH_TEMPLATE_FRAGMENTS']
+            .join('/')
+            .prepend('/')
+          throw :halt, response.finish
+        else
+          @remaining_path = path
+          false
+        end
+      end
+      
+      def named_args(args, blk)  
+        parameters = blk.parameters      
+        args.map do |a| 
+          case a
+          when String
+            a
+          when TERM
+            nil
+          else
+            _, name = parameters.pop
+            "{#{name}}"
+          end
+        end.compact
+      end  
+    end
+  end
+end
+
 if defined?(::Roda)
   ::Instana.logger.debug "Instrumenting Roda"
   Roda.use ::Instana::Rack
+  Roda.plugin ::Instana::RodaPathTemplateExtractor
 end

data/lib/instana/frameworks/sinatra.rb

@@ -3,7 +3,24 @@ require "instana/rack"
 # This instrumentation will insert Rack into Sinatra _and_ Padrino since
 # the latter is based on Sinatra
 
+module Instana
+  module SinatraPathTemplateExtractor
+    def self.extended(base)
+      ::Instana.logger.debug "#{base} extended #{self}"
+      base.store_path_template
+    end
+    
+    def store_path_template
+      after do
+        @env["INSTANA_HTTP_PATH_TEMPLATE"] = @env["sinatra.route"]
+          .sub("#{@request.request_method} ", '')
+      end
+    end
+  end
+end
+
 if defined?(::Sinatra)
   ::Instana.logger.debug "Instrumenting Sinatra"
   ::Sinatra::Base.use ::Instana::Rack
+  ::Sinatra::Base.register ::Instana::SinatraPathTemplateExtractor
 end

data/lib/instana/instrumentation/rack.rb

@@ -76,6 +76,11 @@ module Instana
           ::Instana.tracer.log_error(nil)
         end
 
+        # If the framework instrumentation provides a path template,
+        # pass it into the span here.
+        # See: https://www.instana.com/docs/tracing/custom-best-practices/#path-templates-visual-grouping-of-http-endpoints
+        kvs[:http][:path_tpl] = env['INSTANA_HTTP_PATH_TEMPLATE'] if env['INSTANA_HTTP_PATH_TEMPLATE']
+
         # Save the IDs before the trace ends so we can place
         # them in the response headers in the ensure block
         trace_id = ::Instana.tracer.current_span.trace_id

data/lib/instana/version.rb

@@ -1,4 +1,4 @@
 module Instana
-  VERSION = "1.11.8"
+  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
@@ -237,4 +243,18 @@ class RackTest < Minitest::Test
     ::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

data/test/frameworks/sinatra_test.rb

@@ -48,5 +48,19 @@ if defined?(::Sinatra)
       assert rack_span[:data][:http].key?(:host)
       assert_equal "example.org", rack_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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.11.8
+  version: 1.12.0
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-23 00:00:00.000000000 Z
+date: 2021-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -306,7 +306,7 @@ metadata:
   documentation_uri: https://docs.instana.io/ecosystem/ruby/
   homepage_uri: https://www.instana.com/
   source_code_uri: https://github.com/instana/ruby-sensor
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -321,8 +321,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Ruby Distributed Tracing & Metrics Sensor for Instana
 test_files: