elastic-apm 3.5.0 → 3.10.0

data/lib/elastic_apm/sql/signature.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/sql/tokenizer'

data/lib/elastic_apm/sql/tokenizer.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 'strscan'

data/lib/elastic_apm/sql/tokens.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/sql_summarizer.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/util/lru_cache'

data/lib/elastic_apm/stacktrace.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/stacktrace/frame.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/naively_hashable'

data/lib/elastic_apm/stacktrace_builder.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/stacktrace/frame'
@@ -12,7 +29,12 @@ module ElasticAPM
     RUBY_VERS_REGEX = %r{ruby(/gems)?[-/](\d+\.)+\d}.freeze
     JRUBY_ORG_REGEX = %r{org/jruby}.freeze
 
-    GEMS_PATH = defined?(Bundler) ? Bundler.bundle_path.to_s : Gem.dir
+    GEMS_PATH =
+      if defined?(Bundler) && Bundler.default_bundle_dir
+        Bundler.bundle_path.to_s
+      else
+        Gem.dir
+      end
 
     def initialize(config)
       @config = config

data/lib/elastic_apm/subscriber.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 'active_support/notifications'

data/lib/elastic_apm/trace_context.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/trace_context/tracestate'
@@ -25,15 +42,30 @@ module ElasticAPM
       :version, :trace_id, :id, :parent_id, :ensure_parent_id, :recorded?
 
     class << self
-      def parse(legacy_header = nil, env: nil)
-        if !legacy_header && !env
-          raise ArgumentError, 'TraceContext expects either env: or single ' \
-            'argument header string'
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def parse(legacy_header = nil, env: nil, metadata: nil)
+        unless legacy_header || env || metadata
+          raise ArgumentError, 'TraceContext expects env:, metadata: ' \
+            'or single argument header string'
         end
 
-        return legacy_parse_from_header(legacy_header) if legacy_header
+        if legacy_header
+          legacy_parse_from_header(legacy_header)
+        elsif env
+          trace_context_from_env(env)
+        elsif metadata
+          trace_context_from_metadata(metadata)
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      private
 
-        return unless (header = get_traceparent_header(env))
+      def trace_context_from_env(env)
+        return unless (
+          header =
+            env['HTTP_ELASTIC_APM_TRACEPARENT'] || env['HTTP_TRACEPARENT']
+        )
 
         parent = TraceContext::Traceparent.parse(header)
 
@@ -45,16 +77,24 @@ module ElasticAPM
         new(traceparent: parent, tracestate: state)
       end
 
-      private
+      def trace_context_from_metadata(metadata)
+        return unless (header = metadata['elastic-apm-traceparent'] ||
+          metadata['traceparent'])
+
+        parent = TraceContext::Traceparent.parse(header)
+
+        state =
+          if (header = metadata['tracestate'])
+            TraceContext::Tracestate.parse(header)
+          end
+
+        new(traceparent: parent, tracestate: state)
+      end
 
       def legacy_parse_from_header(header)
         parent = Traceparent.parse(header)
         new(traceparent: parent)
       end
-
-      def get_traceparent_header(env)
-        env['HTTP_ELASTIC_APM_TRACEPARENT'] || env['HTTP_TRACEPARENT']
-      end
     end
 
     def child

data/lib/elastic_apm/trace_context/traceparent.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/trace_context/tracestate.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/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
@@ -25,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)
@@ -44,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
@@ -81,7 +109,7 @@ module ElasticAPM
     def inc_started_spans!
       MUTEX.synchronize do
         @started_spans += 1
-        if @started_spans > config.transaction_max_spans
+        if @started_spans > transaction_max_spans
           @dropped_spans += 1
           return false
         end
@@ -96,7 +124,7 @@ module ElasticAPM
     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