elastic-apm 3.9.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb0d3e0244586e4fe0b9c89beacd267272c0d6b8467457fcce9fde228b22742e
-  data.tar.gz: e3279992b31d2826b6e53c8c66802c1641d30a8b8134671298280b370fa2f8e1
+  metadata.gz: e9c3bd29131a80fd061ecda5285eaf367f1e5643a5d6bd27b753fb566fa51799
+  data.tar.gz: 51b05bac2568d0c55f83444cef9f297400078a7cbcb0fef6c6ef4ce9cfdfe2fa
 SHA512:
-  metadata.gz: a81c23c3e427e727484854c89072c17704c11fbccca518169ae75a7aa8a45bc04966226044cebcd9c1d36fe7c986053e74e1c1b0456cc6cb23bcd0207204ef9d
-  data.tar.gz: de7d4efea50ee03db830ac3570cadc40277fd67ce630c4388f942cfbca005a8b0af72f81b0712eb38972aa7d38c01971fe4697888a75f55ffeba51b98fc51b6b
+  metadata.gz: db6319dbfcbe5f2429c72aebb8132bc9d1a35b4ec28aa15ecd1bb06fff4a326ad41f4753a3fb54f6f85635d9429d434f4f30b2ea23013cf7e775cb6f2d3a8a23
+  data.tar.gz: 32f64b02b56d214a019279b84bdaa3b04f6d72fac06d664326d0939c16c0b50a05b3654ae87a68a057c17c576679cbc726dd890cde2ac1068dd7a0fbbb05b030

data/CHANGELOG.asciidoc

@@ -35,9 +35,28 @@ endif::[]
 [[release-notes-3.x]]
 === Ruby Agent version 3.x
 
+[[release-notes-3.10.0]]
+==== 3.10.0 (2020-08-26)
+
+[float]
+===== Added
+
+- Config option `transaction_ignore_urls` to replace `ignore_url_patterns` {pull}844[#844]
+- Prepend `(?-i)` to patterns to make them case-sensitive {pull}846[#846]
+
+[float]
+===== Fixed
+
+- Reverted {pull}839[#839]
+- Improved Kubernetes pod ID detection {pull}859[#859]
+
 [[release-notes-3.9.0]]
 ==== 3.9.0 (2020-08-04)
 
+[float]
+===== Fixed
+- Scrub request body of illegal UTF-8 characters {pull}832[#832]
+
 [float]
 ===== Added
 

data/Gemfile

@@ -42,6 +42,7 @@ gem 'faraday', require: nil
 gem 'graphql', require: nil
 gem 'google-protobuf', '< 3.12' if !defined?(JRUBY_VERSION) && RUBY_VERSION < '2.5'
 gem 'grpc' if !defined?(JRUBY_VERSION)
+gem 'json'
 gem 'json-schema', require: nil
 gem 'mongo', require: nil
 gem 'opentracing', require: nil

data/lib/elastic_apm/config.rb

@@ -87,6 +87,7 @@ module ElasticAPM
     option :source_lines_span_library_frames,  type: :int,    default: 0
     option :span_frames_min_duration,          type: :float,  default: '5ms',   converter: Duration.new(default_unit: 'ms')
     option :stack_trace_limit,                 type: :int,    default: 999_999
+    option :transaction_ignore_urls,           type: :list,   default: [],      converter: WildcardPatternList.new
     option :transaction_max_spans,             type: :int,    default: 500
     option :transaction_sample_rate,           type: :float,  default: 1.0
     option :use_elastic_traceparent_header,    type: :bool,   default: true
@@ -234,6 +235,13 @@ module ElasticAPM
       self.default_labels = value
     end
 
+    def ignore_url_patterns=(value)
+      warn '[DEPRECATED] The option ignore_url_patterns is being removed. ' \
+        'Consider using transaction_ignore_urls instead.'
+
+      set(:ignore_url_patterns, value)
+    end
+
     def custom_key_filters=(value)
       unless value == self.class.schema[:custom_key_filters][:default]
         warn '[DEPRECATED] The option custom_key_filters is being removed. ' \
@@ -318,7 +326,7 @@ module ElasticAPM
       self.logger ||= ::Rails.logger
 
       self.__root_path = ::Rails.root.to_s
-      self.__view_paths = ::ActionController::Base.view_paths.map(&:to_s)
+      self.__view_paths = app.config.paths['app/views'].existent + [::Rails.root.to_s]
     end
 
     def rails_app_name(app)

data/lib/elastic_apm/config/wildcard_pattern_list.rb

@@ -36,12 +36,22 @@ module ElasticAPM
         private
 
         def convert(str)
+          case_sensitive = false
+
+          if str.start_with?('(?-i)')
+            str = str.gsub(/^\(\?-\i\)/, '')
+            case_sensitive = true
+          end
+
           parts =
             str.chars.each_with_object([]) do |char, arr|
               arr << (char == '*' ? '.*' : Regexp.escape(char))
             end
 
-          Regexp.new('\A' + parts.join + '\Z', Regexp::IGNORECASE)
+          Regexp.new(
+            '\A' + parts.join + '\Z',
+            case_sensitive ? nil : Regexp::IGNORECASE
+          )
         end
       end
 

data/lib/elastic_apm/context_builder.rb

@@ -76,7 +76,7 @@ module ElasticAPM
       else
         body = req.body.read
         req.body.rewind
-        body.byteslice(0, MAX_BODY_LENGTH).force_encoding('utf-8')
+        body.byteslice(0, MAX_BODY_LENGTH).force_encoding('utf-8').scrub
       end
     end
 

data/lib/elastic_apm/metadata/system_info.rb

@@ -24,7 +24,7 @@ module ElasticAPM
       def initialize(config)
         @config = config
 
-        @hostname = @config.hostname || `hostname`.chomp
+        @hostname = @config.hostname || self.class.system_hostname
         @architecture = gem_platform.cpu
         @platform = gem_platform.os
 
@@ -35,11 +35,13 @@ module ElasticAPM
 
       attr_reader :hostname, :architecture, :platform, :container, :kubernetes
 
-      private
-
       def gem_platform
         @gem_platform ||= Gem::Platform.local
       end
+
+      def self.system_hostname
+        @system_hostname ||= `hostname`.chomp
+      end
     end
   end
 end

data/lib/elastic_apm/metadata/system_info/container_info.rb

@@ -81,8 +81,14 @@ module ElasticAPM
             ENV.fetch('KUBERNETES_POD_UID', kubernetes_pod_uid)
         end
 
-        CONTAINER_ID_REGEX = /^[0-9A-Fa-f]{64}$/.freeze
-        KUBEPODS_REGEX = %r{(?:^/kubepods/[^/]+/pod([^/]+)$)|(?:^/kubepods\.slice/kubepods-[^/]+\.slice/kubepods-[^/]+-pod([^/]+)\.slice$)}.freeze # rubocop:disable Metrics/LineLength
+        CONTAINER_ID_REGEXES = [
+          %r{^[[:xdigit:]]{64}$},
+          %r{^[[:xdigit:]]{8}-[[:xdigit:]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{4,}$}
+        ]
+        KUBEPODS_REGEXES = [
+          %r{(?:^/kubepods[^\s]*/pod([^/]+)$)},
+          %r{(?:^/kubepods\.slice/kubepods-[^/]+\.slice/kubepods-[^/]+-pod([^/]+)\.slice$)}
+        ]
         SYSTEMD_SCOPE_SUFFIX = '.scope'
 
         # rubocop:disable Metrics/PerceivedComplexity
@@ -118,18 +124,36 @@ module ElasticAPM
               end
             end
 
-            if (kubepods_match = KUBEPODS_REGEX.match(directory))
+            if (kubepods_match = match_kubepods(directory))
               pod_id = kubepods_match[1] || kubepods_match[2]
 
               self.container_id = container_id
               self.kubernetes_pod_uid = pod_id
-            elsif CONTAINER_ID_REGEX.match(container_id)
+            elsif match_container(container_id)
               self.container_id = container_id
             end
           end
         end
         # rubocop:enable Metrics/PerceivedComplexity
         # rubocop:enable Metrics/CyclomaticComplexity
+
+        def match_kubepods(directory)
+          KUBEPODS_REGEXES.each do |r|
+            next unless (match = r.match(directory))
+            return match
+          end
+
+          nil
+        end
+
+        def match_container(container_id)
+          CONTAINER_ID_REGEXES.each do |r|
+            next unless (match = r.match(container_id))
+            return match
+          end
+
+          nil
+        end
       end
     end
   end

data/lib/elastic_apm/middleware.rb

@@ -59,9 +59,15 @@ module ElasticAPM
     end
 
     def path_ignored?(env)
-      config.ignore_url_patterns.any? do |r|
-        env['PATH_INFO'].match r
+      return true if config.ignore_url_patterns.any? do |r|
+        r.match(env['PATH_INFO'])
       end
+
+      return true if config.transaction_ignore_urls.any? do |r|
+        r.match(env['PATH_INFO'])
+      end
+
+      false
     end
 
     def start_transaction(env)

data/lib/elastic_apm/span.rb

@@ -97,11 +97,12 @@ module ElasticAPM
 
     def done(clock_end: Util.monotonic_micros)
       stop clock_end
+      self
+    end
 
+    def prepare_for_serialization!
       build_stacktrace! if should_build_stacktrace?
       self.original_backtrace = nil # release original
-
-      self
     end
 
     def stopped?

data/lib/elastic_apm/transport/worker.rb

@@ -77,6 +77,10 @@ module ElasticAPM
       private
 
       def serialize_and_filter(resource)
+        if resource.respond_to?(:prepare_for_serialization!)
+          resource.prepare_for_serialization!
+        end
+
         serialized = serializers.serialize(resource)
 
         # if a filter returns nil, it means skip the event

data/lib/elastic_apm/version.rb

@@ -18,5 +18,5 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  VERSION = '3.9.0'
+  VERSION = '3.10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 3.9.0
+  version: 3.10.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby