instana 1.11.5 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3a3d50ffdbca640b2c32a3f51243387eb7a15a3fe5e2810c3d93c2ea98f92be
-  data.tar.gz: f0c0665f06c3e2faa8aa0687e1f3d03e905e18cb4006dac17f50a2868f18ef53
+  metadata.gz: '09630573df5e1941fc17023b97864fd430f6135b9e0a72cd2f19225265b66d16'
+  data.tar.gz: b8dc0dda20938dc03f4ebe0887c3ccd68d03995d07e0c7233a19ff3a0780f1a7
 SHA512:
-  metadata.gz: 863436a63b5014db4137887f4f223ca8a7ed6759238e009258d2912b0f86328b705d388a61670486a5f194209d83ac23f27825fb0672f59adc0492dd6cf7ee83
-  data.tar.gz: 0e2e0ba614455fcbbddbe376a76e006686a8ef3456c020d5c545ae0d247fad033d99d31815f3ceb7b2a881d4b35388e955d255bc4770e940072c38eb66ae0925
+  metadata.gz: a9bf1d5bfd714b8d1e3e187d0dfe47f0917384fb41b45d8f01b10890c7259c985b20d5adb550d955ac51b8bca9102246e9926ce114d448b391b82e0acdcd46c4
+  data.tar.gz: 139872ad95ceeca46b97be78773d999228ff30563ff90f29e65032bd6b55f7e619fb00a9e130ad6bd06b83dd0bca3e4321428e5172795242c8a045de570bd77a

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/Rakefile

@@ -8,44 +8,33 @@ Rake::TestTask.new(:test) do |t|
 
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
-
-  if ENV.key?('BUNDLE_GEMFILE')
-    case File.basename(ENV['BUNDLE_GEMFILE']).split('.').first
-    when /rails6/
-      t.test_files = %w(test/frameworks/rails/activerecord_test.rb
-                        test/frameworks/rails/actioncontroller_test.rb
-                        test/frameworks/rails/actionview5_test.rb)
-    when /rails5/
-      t.test_files = %w(test/frameworks/rails/activerecord_test.rb
-                        test/frameworks/rails/actioncontroller_test.rb
-                        test/frameworks/rails/actionview5_test.rb)
-    when /rails42/
-      t.test_files = %w(test/frameworks/rails/activerecord_test.rb
-                        test/frameworks/rails/actioncontroller_test.rb
-                        test/frameworks/rails/actionview4_test.rb)
-    when /rails32/
-      t.test_files = %w(test/frameworks/rails/activerecord_test.rb
-                        test/frameworks/rails/actioncontroller_test.rb
-                        test/frameworks/rails/actionview3_test.rb)
-    when /libraries/
-      t.test_files = FileList['test/instrumentation/*_test.rb',
-                              'test/frameworks/cuba_test.rb',
-                              'test/frameworks/rack_test.rb',
-                              'test/frameworks/roda_test.rb',
-                              'test/frameworks/sinatra_test.rb']
-    else
-      t.test_files = FileList['test/agent/*_test.rb'] +
-                     FileList['test/tracing/*_test.rb'] +
-                     FileList['test/profiling/*_test.rb'] +
-                     FileList['test/benchmarks/bench_*.rb']
-    end
-  else
-    t.test_files = FileList['test/agent/*_test.rb'] +
-        FileList['test/tracing/*_test.rb'] +
-        FileList['test/profiling/*_test.rb'] +
-        FileList['test/benchmarks/bench_*.rb']
+
+  t.test_files = Dir[
+    'test/*_test.rb',
+    'test/{agent,tracing,profiling,benchmarks}/*_test.rb'
+  ]
+
+  case File.basename(ENV.fetch('BUNDLE_GEMFILE', '')).split('.').first
+  when /rails6/
+    t.test_files = %w(test/frameworks/rails/activerecord_test.rb
+                      test/frameworks/rails/actioncontroller_test.rb
+                      test/frameworks/rails/actionview5_test.rb)
+  when /rails5/
+    t.test_files = %w(test/frameworks/rails/activerecord_test.rb
+                      test/frameworks/rails/actioncontroller_test.rb
+                      test/frameworks/rails/actionview5_test.rb)
+  when /rails42/
+    t.test_files = %w(test/frameworks/rails/activerecord_test.rb
+                      test/frameworks/rails/actioncontroller_test.rb
+                      test/frameworks/rails/actionview4_test.rb)
+  when /rails32/
+    t.test_files = %w(test/frameworks/rails/activerecord_test.rb
+                      test/frameworks/rails/actioncontroller_test.rb
+                      test/frameworks/rails/actionview3_test.rb)
+  when /libraries/
+    t.test_files = Dir['test/{instrumentation,frameworks}/*_test.rb']
   end
+
 end
 
 task :environment do

data/lib/instana/agent.rb

@@ -25,6 +25,7 @@ module Instana
     attr_accessor :collect_thread
     attr_accessor :thread_spawn_lock
     attr_accessor :extra_headers
+    attr_reader :secret_values
 
     attr_accessor :testmode
 
@@ -83,6 +84,10 @@ module Instana
 
       # The agent may pass down custom headers for this sensor to capture
       @extra_headers = nil
+      
+      # The values considered sensitive and removed from http query parameters
+      # and database connection strings 
+      @secret_values = nil
     end
 
     # Spawns the background thread and calls start.  This method is separated
@@ -278,6 +283,7 @@ module Instana
         data = Oj.load(response.body, OJ_OPTIONS)
         @process[:report_pid] = data['pid']
         @agent_uuid = data['agentUuid']
+        @secret_values = data['secrets']
 
         if data.key?('extraHeaders')
           @extra_headers = data['extraHeaders']

data/lib/instana/base.rb

@@ -12,6 +12,7 @@ module Instana
     attr_accessor :config
     attr_accessor :logger
     attr_accessor :pid
+    attr_reader :secrets
 
     ##
     # setup
@@ -24,6 +25,7 @@ module Instana
       @tracer = ::Instana::Tracer.new
       @processor = ::Instana::Processor.new
       @collector = ::Instana::Collector.new
+      @secrets = ::Instana::Secrets.new
     end
   end
 end

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/excon.rb

@@ -7,7 +7,7 @@ if defined?(::Excon) && ::Instana.config[:excon][:enabled]
 
           payload = { :http => {} }
           path = datum[:path].split('?').first
-          payload[:http][:url] = "#{datum[:connection].instance_variable_get(:@socket_key)}#{path}"
+          payload[:http][:url] = ::Instana.secrets.remove_from_query("#{datum[:connection].instance_variable_get(:@socket_key)}#{path}")
           payload[:http][:method] = datum[:method] if datum.key?(:method)
 
           if datum[:pipeline] == true