elastic-apm 3.3.0 → 3.8.0

data/lib/elastic_apm/trace_context/tracestate.rb

@@ -0,0 +1,43 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+module ElasticAPM
+  class TraceContext
+    # @api private
+    class Tracestate
+      def initialize(values = [])
+        @values = values
+      end
+
+      attr_accessor :values
+
+      def self.parse(header)
+        # HTTP allows multiple headers with the same name, eg. multiple
+        # Set-Cookie headers per response.
+        # Rack handles this by joining the headers under the same key, separated
+        # by newlines, see https://www.rubydoc.info/github/rack/rack/file/SPEC
+        new(String(header).split("\n"))
+      end
+
+      def to_header
+        values.join(',')
+      end
+    end
+  end
+end

data/lib/elastic_apm/transaction.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module ElasticAPM
@@ -10,6 +27,7 @@ module ElasticAPM
       :trace_id, :parent_id, :id, :ensure_parent_id
 
     DEFAULT_TYPE = 'custom'
+    MUTEX = Mutex.new
 
     # rubocop:disable Metrics/ParameterLists
     def initialize(
@@ -24,11 +42,20 @@ module ElasticAPM
       @type = type || DEFAULT_TYPE
       @config = config
 
+      # Cache these values in case they are changed during the
+      # transaction's lifetime via the remote config
+      @span_frames_min_duration = config.span_frames_min_duration
+      @collect_metrics = config.collect_metrics?
+      @breakdown_metrics = config.breakdown_metrics?
+      @framework_name = config.framework_name
+      @transaction_max_spans = config.transaction_max_spans
+      @default_labels = config.default_labels
+
       @sampled = sampled
 
       @context = context || Context.new # TODO: Lazy generate this?
-      if config.default_labels
-        Util.reverse_merge!(@context.labels, config.default_labels)
+      if @default_labels
+        Util.reverse_merge!(@context.labels, @default_labels)
       end
 
       @trace_context = trace_context || TraceContext.new(recorded: sampled)
@@ -43,7 +70,9 @@ module ElasticAPM
     attr_accessor :name, :type, :result
 
     attr_reader :context, :duration, :started_spans, :dropped_spans,
-      :timestamp, :trace_context, :notifications, :self_time, :config
+      :timestamp, :trace_context, :notifications, :self_time,
+      :span_frames_min_duration, :collect_metrics, :breakdown_metrics,
+      :framework_name, :transaction_max_spans
 
     def sampled?
       @sampled
@@ -78,25 +107,24 @@ module ElasticAPM
     # spans
 
     def inc_started_spans!
-      @started_spans += 1
-    end
-
-    def inc_dropped_spans!
-      @dropped_spans += 1
-    end
-
-    def max_spans_reached?
-      started_spans > config.transaction_max_spans
+      MUTEX.synchronize do
+        @started_spans += 1
+        if @started_spans > transaction_max_spans
+          @dropped_spans += 1
+          return false
+        end
+      end
+      true
     end
 
     # context
 
-    def add_response(*args)
-      context.response = Context::Response.new(*args)
+    def add_response(status = nil, **args)
+      context.response = Context::Response.new(status, **args)
     end
 
     def set_user(user)
-      context.user = Context::User.infer(config, user)
+      context.user = Context::User.infer(@config, user)
     end
 
     def inspect

data/lib/elastic_apm/transport/base.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 require 'elastic_apm/metadata'
@@ -31,7 +48,6 @@ module ElasticAPM
         @stopped = Concurrent::AtomicBoolean.new
         @workers = Array.new(config.pool_size)
 
-        @watcher_mutex = Mutex.new
         @worker_mutex = Mutex.new
       end
 
@@ -39,11 +55,13 @@ module ElasticAPM
 
       def start
         debug '%s: Starting Transport', pid_str
+        # Set @stopped to false first, in case transport is restarted;
+        # ensure_worker_count requires @stopped to be false
+        # ~estolfo
+        @stopped.make_false unless @stopped.false?
 
-        ensure_watcher_running
         ensure_worker_count
-
-        @stopped.make_false unless @stopped.false?
+        create_watcher
       end
 
       def stop
@@ -62,7 +80,6 @@ module ElasticAPM
           return false
         end
 
-        ensure_watcher_running
         queue.push(resource, true)
 
         true
@@ -78,25 +95,26 @@ module ElasticAPM
         @filters.add(key, callback)
       end
 
+      def handle_forking!
+        # We can't just stop and start again because the StopMessage
+        # will then be the first message processed when the transport is
+        # restarted.
+        stop_watcher
+        ensure_worker_count
+        create_watcher
+      end
+
       private
 
       def pid_str
         format('[PID:%s]', Process.pid)
       end
 
-      def ensure_watcher_running
-        # pid has changed == we've forked
-        return if @pid == Process.pid
-
-        @watcher_mutex.synchronize do
-          return if @pid == Process.pid
-          @pid = Process.pid
-
-          @watcher = Concurrent::TimerTask.execute(
-            execution_interval: WATCHER_EXECUTION_INTERVAL,
-            timeout_interval: WATCHER_TIMEOUT_INTERVAL
-          ) { ensure_worker_count }
-        end
+      def create_watcher
+        @watcher = Concurrent::TimerTask.execute(
+          execution_interval: WATCHER_EXECUTION_INTERVAL,
+          timeout_interval: WATCHER_TIMEOUT_INTERVAL
+        ) { ensure_worker_count }
       end
 
       def ensure_worker_count
@@ -145,7 +163,8 @@ module ElasticAPM
             thread.kill
           end
 
-          @workers.clear
+          # Maintain the @worker array size for when transport is restarted
+          @workers.fill(nil)
         end
       end
 
@@ -156,10 +175,7 @@ module ElasticAPM
       end
 
       def stop_watcher
-        @watcher_mutex.synchronize do
-          return if watcher.nil? || @pid != Process.pid
-          watcher.shutdown
-        end
+        watcher&.shutdown
       end
 
       def throttled_queue_full_warning

data/lib/elastic_apm/transport/connection.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module ElasticAPM

data/lib/elastic_apm/transport/connection/http.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 require 'elastic_apm/transport/connection/proxy_pipe'

data/lib/elastic_apm/transport/connection/proxy_pipe.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module ElasticAPM
@@ -31,6 +48,11 @@ module ElasticAPM
 
             return unless compress
             enable_compression!
+            ObjectSpace.define_finalizer(self, self.class.finalize(@io))
+          end
+
+          def self.finalize(io)
+            proc { io.close }
           end
 
           attr_reader :io
@@ -62,8 +84,8 @@ module ElasticAPM
           end
         end
 
-        def self.pipe(*args)
-          pipe = new(*args)
+        def self.pipe(**args)
+          pipe = new(**args)
           [pipe.read, pipe.write]
         end
       end

data/lib/elastic_apm/transport/filters.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 require 'elastic_apm/transport/filters/secrets_filter'

data/lib/elastic_apm/transport/filters/hash_sanitizer.rb

@@ -0,0 +1,77 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+module ElasticAPM
+  module Transport
+    module Filters
+      class HashSanitizer
+        FILTERED = '[FILTERED]'
+
+        KEY_FILTERS = [
+          /passw(or)?d/i,
+          /auth/i,
+          /^pw$/,
+          /secret/i,
+          /token/i,
+          /api[-._]?key/i,
+          /session[-._]?id/i,
+          /(set[-_])?cookie/i
+        ].freeze
+
+        VALUE_FILTERS = [
+          # (probably) credit card number
+          /^\d{4}[- ]?\d{4}[- ]?\d{4}[- ]?\d{4}$/
+        ].freeze
+
+        attr_accessor :key_filters
+
+        def initialize
+          @key_filters = KEY_FILTERS
+        end
+
+        def strip_from!(obj, key_filters = KEY_FILTERS)
+          return unless obj&.is_a?(Hash)
+
+          obj.each do |k, v|
+            if filter_key?(k)
+              next obj[k] = FILTERED
+            end
+
+            case v
+            when Hash
+              strip_from!(v)
+            when String
+              if filter_value?(v)
+                obj[k] = FILTERED
+              end
+            end
+          end
+        end
+
+        def filter_key?(key)
+          @key_filters.any? { |regex| regex.match(key) }
+        end
+
+        def filter_value?(value)
+          VALUE_FILTERS.any? { |regex| regex.match(value) }
+        end
+      end
+    end
+  end
+end

data/lib/elastic_apm/transport/filters/secrets_filter.rb

@@ -1,71 +1,47 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
+require 'elastic_apm/transport/filters/hash_sanitizer'
+
 module ElasticAPM
   module Transport
     module Filters
       # @api private
       class SecretsFilter
-        FILTERED = '[FILTERED]'
-
-        KEY_FILTERS = [
-          /passw(or)?d/i,
-          /auth/i,
-          /^pw$/,
-          /secret/i,
-          /token/i,
-          /api[-._]?key/i,
-          /session[-._]?id/i,
-          /(set[-_])?cookie/i
-        ].freeze
-
-        VALUE_FILTERS = [
-          # (probably) credit card number
-          /^\d{4}[- ]?\d{4}[- ]?\d{4}[- ]?\d{4}$/
-        ].freeze
-
         def initialize(config)
           @config = config
-          @key_filters = KEY_FILTERS + config.custom_key_filters
+          @sanitizer = HashSanitizer.new
+          @sanitizer.key_filters += config.custom_key_filters +
+                                     config.sanitize_field_names
         end
 
         def call(payload)
-          strip_from! payload.dig(:transaction, :context, :request, :headers)
-          strip_from! payload.dig(:transaction, :context, :request, :env)
-          strip_from! payload.dig(:transaction, :context, :request, :cookies)
-          strip_from! payload.dig(:transaction, :context, :response, :headers)
-          strip_from! payload.dig(:error, :context, :request, :headers)
-          strip_from! payload.dig(:error, :context, :response, :headers)
-          strip_from! payload.dig(:transaction, :context, :request, :body)
+          @sanitizer.strip_from! payload.dig(:transaction, :context, :request, :headers)
+          @sanitizer.strip_from! payload.dig(:transaction, :context, :request, :env)
+          @sanitizer.strip_from! payload.dig(:transaction, :context, :request, :cookies)
+          @sanitizer.strip_from! payload.dig(:transaction, :context, :response, :headers)
+          @sanitizer.strip_from! payload.dig(:error, :context, :request, :headers)
+          @sanitizer.strip_from! payload.dig(:error, :context, :response, :headers)
+          @sanitizer.strip_from! payload.dig(:transaction, :context, :request, :body)
 
           payload
         end
-
-        def strip_from!(obj)
-          return unless obj&.is_a?(Hash)
-
-          obj.each do |k, v|
-            if filter_key?(k)
-              next obj[k] = FILTERED
-            end
-
-            case v
-            when Hash
-              strip_from!(v)
-            when String
-              if filter_value?(v)
-                obj[k] = FILTERED
-              end
-            end
-          end
-        end
-
-        def filter_key?(key)
-          @key_filters.any? { |regex| key.match regex }
-        end
-
-        def filter_value?(value)
-          VALUE_FILTERS.any? { |regex| value.match regex }
-        end
       end
     end
   end