instana 1.11.4 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b2f239d9d7286752e2650375e8096e9525db098a7e5b09486e36dbd89758eb1
-  data.tar.gz: 14ebd785f5ef8333360214ad9731583976f96c62980b6d0b7927338d25a0ca90
+  metadata.gz: 7f4a95f79f6ce7a30fe5f54797a8a47637dd659345043155c13eec90a8fe221c
+  data.tar.gz: 8206b32f50dd0f80386854ec216414cb976f3045ba113e5a86f161cba87a4736
 SHA512:
-  metadata.gz: f2e560309027517414f4358421b5e9f0579254e9479cbe263c7fdd89440d924ef416a90ef2b7ff25eb7cbb3bffb3f630338d590363451de877eb9d9c70a46c32
-  data.tar.gz: 0e8612accc07577a4951fddde76e77789714b67ee2e749b167f18ae39f3b8e4947e65fa3f4d35cd7a9af350e9ce65fcec0119f8494760b5f8be855c792cbe229
+  metadata.gz: 9eada422ab4a40b7566fa1ae44614efc0ca2874ba0018fecd494ec01e31d1fa66c3a5ba18f86d6ded8089cbad85b196a21b57eaa79a17372ae954385c9ddfd7e
+  data.tar.gz: ffa1dd9e0eac0d0041945d1ddd10ecfcb813c82dcfa5aa241302838c02af17a015457af0344654bb77cc6ffb245958c8ab712c9eab450fbb627fa185ab591075

data/.circleci/config.yml

@@ -0,0 +1,168 @@
+version: 2.1
+
+# More about orbs: https://circleci.com/docs/2.0/using-orbs/
+orbs:
+  ruby: circleci/ruby@1.1.2
+
+commands:
+  prelim-deps:
+    steps:
+      - run:
+          name: Preliminary Dependencies
+          command: |
+            gem update --system
+            gem --version
+            gem install bundler
+            bundler --version
+            bundle config set path './vendor/bundle'
+
+  run-tests:
+    steps:
+      - run:
+          name: Run the Tests
+          command: |
+            bundle exec rake test
+
+  save-stan-cache:
+    parameters:
+      gemfile:
+        default: "Gemfile"
+        type: string
+    steps:
+      - save_cache:
+          key: gem-cache-v1-{{ arch }}-{{ .Branch }}-{{ checksum "<<parameters.gemfile>>" }}
+          paths:
+            - vendor/bundle
+
+  restore-stan-cache:
+    parameters:
+      gemfile:
+        default: "Gemfile"
+        type: string
+    steps:
+      - restore_cache:
+          keys:
+            - gem-cache-v1-{{ arch }}-{{ .Branch }}-{{ checksum "<<parameters.gemfile>>" }}
+            - gem-cache-v1-{{ arch }}-{{ .Branch }}
+            - gem-cache-v1
+
+  bundle-install:
+    parameters:
+      gemfile:
+        default: "Gemfile"
+        type: string
+    steps:
+      - restore-stan-cache:
+          gemfile: <<parameters.gemfile>>
+      - run:
+          name: Bundle Installation
+          command: |
+            bundle install
+      - save-stan-cache:
+          gemfile: <<parameters.gemfile>>
+
+jobs:
+  ruby26:
+    parallelism: 3
+    docker:
+      - image: circleci/ruby:2.6.3-stretch-node
+    executor: ruby/default
+    environment:
+      BUNDLE_JOBS: "3"
+      BUNDLE_RETRY: "3"
+
+    steps:
+      - checkout
+      - prelim-deps
+      - bundle-install
+      - run-tests
+
+  rails50:
+    parallelism: 3
+    docker:
+      - image: circleci/ruby:2.6.3-stretch-node
+      - image: mariadb
+        environment:
+          MYSQL_DATABASE: 'travis_ci_test'
+          MYSQL_USER: 'root'
+          MYSQL_PASSWORD: ''
+          MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
+          MYSQL_ROOT_PASSWORD: ''
+          MYSQL_ROOT_HOST: '%'
+    executor: ruby/default
+    environment:
+      BUNDLE_JOBS: "3"
+      BUNDLE_RETRY: "3"
+      BUNDLE_GEMFILE: "./gemfiles/rails50.gemfile"
+
+    steps:
+      - checkout
+      - prelim-deps
+      - bundle-install:
+          gemfile: "./gemfiles/rails50.gemfile"
+      - run-tests
+
+  rails60:
+    parallelism: 3
+    docker:
+      - image: circleci/ruby:2.6.3-stretch-node
+      - image: mariadb
+        environment:
+          MYSQL_DATABASE: 'travis_ci_test'
+          MYSQL_USER: 'root'
+          MYSQL_PASSWORD: ''
+          MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
+          MYSQL_ROOT_PASSWORD: ''
+          MYSQL_ROOT_HOST: '%'
+    executor: ruby/default
+    environment:
+      BUNDLE_JOBS: "3"
+      BUNDLE_RETRY: "3"
+      BUNDLE_GEMFILE: "./gemfiles/rails60.gemfile"
+
+    steps:
+      - checkout
+      - prelim-deps
+      - bundle-install:
+          gemfile: "./gemfiles/rails60.gemfile"
+      - run-tests
+
+  libraries:
+    parallelism: 3
+    docker:
+      - image: circleci/ruby:2.6.3-stretch-node
+      - image: mariadb
+        environment:
+          MYSQL_DATABASE: 'travis_ci_test'
+          MYSQL_USER: 'root'
+          MYSQL_PASSWORD: ''
+          MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
+          MYSQL_ROOT_PASSWORD: ''
+          MYSQL_ROOT_HOST: '%'
+      - image: memcached
+      - image: postgres
+        environment:
+          POSTGRES_USER: 'stan'
+          POSTGRES_PASSWORD: 'stanlikesdata'
+      - image: redis
+    executor: ruby/default
+    environment:
+      BUNDLE_JOBS: "3"
+      BUNDLE_RETRY: "3"
+      BUNDLE_GEMFILE: "./gemfiles/libraries.gemfile"
+
+    steps:
+      - checkout
+      - prelim-deps
+      - bundle-install:
+          gemfile: "./gemfiles/libraries.gemfile"
+      - run-tests
+
+workflows:
+  version: 2
+  whole-enchilada-MRI26:
+    jobs:
+      - ruby26
+      - rails50
+      - rails60
+      - libraries

data/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-<img src="http://www.instana.com/wp-content/uploads/2016/11/Instana-Infrastructure-Map-1-1024x551.png"/>
+<img src="https://disznc.s3.amazonaws.com/Ruby-Dashboard-2020-02-10-at-2.31.36-PM.png"/>
 </div>
 
 # Instana

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

@@ -8,8 +8,9 @@ module Instana
       @app = app
     end
 
-    def call(env)
-      kvs = { :http => {} }
+    def collect_kvs(env)
+      kvs = {}
+      kvs[:http] = {}
       kvs[:http][:method] = env['REQUEST_METHOD']
       kvs[:http][:url] = ::CGI.unescape(env['PATH_INFO'])
 
@@ -37,15 +38,27 @@ module Instana
           end
         }
       end
+      return kvs
+    end
 
+    def call(env)
       # Check incoming context
       incoming_context = {}
       if env.key?('HTTP_X_INSTANA_T')
         incoming_context[:trace_id]  = ::Instana::Util.header_to_id(env['HTTP_X_INSTANA_T'])
         incoming_context[:span_id]   = ::Instana::Util.header_to_id(env['HTTP_X_INSTANA_S']) if env.key?('HTTP_X_INSTANA_S')
         incoming_context[:level]     = env['HTTP_X_INSTANA_L'] if env.key?('HTTP_X_INSTANA_L')
+
+        # Honor X-Instana-L
+        if incoming_context[:level] and incoming_context[:level].length > 0
+          if incoming_context[:level][0] == "0"
+            return @app.call(env)
+          end
+        end
       end
 
+      kvs = collect_kvs(env)
+
       ::Instana.tracer.log_start_or_continue(:rack, {}, incoming_context)
 
       status, headers, response = @app.call(env)
@@ -63,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
@@ -78,8 +96,10 @@ module Instana
         # Set reponse headers; encode as hex string
         headers['X-Instana-T'] = ::Instana::Util.id_to_header(trace_id)
         headers['X-Instana-S'] = ::Instana::Util.id_to_header(span_id)
+        headers['X-Instana-L'] = '1'
+        headers['Server-Timing'] = "intid;desc=#{::Instana::Util.id_to_header(trace_id)}"
+        ::Instana.tracer.log_end(:rack, kvs)
       end
-      ::Instana.tracer.log_end(:rack, kvs)
     end
   end
 end

data/lib/instana/instrumentation/redis.rb

@@ -1,47 +1,32 @@
-module Instana
-  module Instrumentation
-    class Redis
-      def self.get_host(client)
-        client.host
-      end
-
-      def self.get_port(client)
-        client.port
-      end
-
-      def self.pipeline_command(pipeline)
-        pipeline.is_a?(::Redis::Pipeline::Multi) ? 'MULTI' : 'PIPELINE'
-      end
-    end
-  end
-end
-
 if defined?(::Redis) && ::Instana.config[:redis][:enabled]
   ::Redis::Client.class_eval do
     def call_with_instana(*args, &block)
       kv_payload = { redis: {} }
+      dnt_spans = [:redis, :'resque-client', :'sidekiq-client']
 
-      if !Instana.tracer.tracing?
+      if !Instana.tracer.tracing? || dnt_spans.include?(::Instana.tracer.current_span.name)
         return call_without_instana(*args, &block)
       end
 
-      host = ::Instana::Instrumentation::Redis.get_host(self)
-      port = ::Instana::Instrumentation::Redis.get_port(self)
-      kv_payload[:redis] = {
-        connection: "#{host}:#{port}",
-        db: db,
-        command: args[0][0].to_s.upcase
-      }
-      ::Instana.tracer.log_entry(:redis, kv_payload)
+      begin
+        ::Instana.tracer.log_entry(:redis)
+
+        begin
+          kv_payload[:redis][:connection] = "#{self.host}:#{self.port}"
+          kv_payload[:redis][:db] = db.to_s
+          kv_payload[:redis][:command] = args[0][0].to_s.upcase
+        rescue
+          nil
+        end
 
-      call_without_instana(*args, &block)
-    rescue => e
-      kv_payload[:redis][:error] = true
-      ::Instana.tracer.log_info(kv_payload)
-      ::Instana.tracer.log_error(e)
-      raise
-    ensure
-      ::Instana.tracer.log_exit(:redis, {})
+        call_without_instana(*args, &block)
+      rescue => e
+        ::Instana.tracer.log_info({ redis: {error: true} })
+        ::Instana.tracer.log_error(e)
+        raise
+      ensure
+        ::Instana.tracer.log_exit(:redis, kv_payload)
+      end
     end
 
     ::Instana.logger.debug "Instrumenting Redis"
@@ -51,29 +36,32 @@ if defined?(::Redis) && ::Instana.config[:redis][:enabled]
 
     def call_pipeline_with_instana(*args, &block)
       kv_payload = { redis: {} }
+      dnt_spans = [:redis, :'resque-client', :'sidekiq-client']
 
-      if !Instana.tracer.tracing?
+      if !Instana.tracer.tracing? || dnt_spans.include?(::Instana.tracer.current_span.name)
         return call_pipeline_without_instana(*args, &block)
       end
 
-      pipeline = args.first
-      host = ::Instana::Instrumentation::Redis.get_host(self)
-      port = ::Instana::Instrumentation::Redis.get_port(self)
-      kv_payload[:redis] = {
-        connection: "#{host}:#{port}",
-        db: db,
-        command: ::Instana::Instrumentation::Redis.pipeline_command(pipeline)
-      }
-      ::Instana.tracer.log_entry(:redis, kv_payload)
+      begin
+        ::Instana.tracer.log_entry(:redis)
+
+        pipeline = args.first
+        begin
+          kv_payload[:redis][:connection] = "#{self.host}:#{self.port}"
+          kv_payload[:redis][:db] = db.to_s
+          kv_payload[:redis][:command] = pipeline.is_a?(::Redis::Pipeline::Multi) ? 'MULTI' : 'PIPELINE'
+        rescue
+          nil
+        end
 
-      call_pipeline_without_instana(*args, &block)
-    rescue => e
-      kv_payload[:redis][:error] = true
-      ::Instana.tracer.log_info(kv_payload)
-      ::Instana.tracer.log_error(e)
-      raise
-    ensure
-      ::Instana.tracer.log_exit(:redis, {})
+        call_pipeline_without_instana(*args, &block)
+      rescue => e
+        ::Instana.tracer.log_info({ redis: {error: true} })
+        ::Instana.tracer.log_error(e)
+        raise
+      ensure
+        ::Instana.tracer.log_exit(:redis, kv_payload)
+      end
     end
 
     alias call_pipeline_without_instana call_pipeline