elastic-apm 3.6.0 → 3.10.1

data/lib/elastic_apm/grpc.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
@@ -54,7 +71,7 @@ module ElasticAPM
         transaction.done 'success'
       rescue ::Exception => e
         ElasticAPM.report(e, handled: false)
-        transaction.done 'error'
+        transaction.done 'error' if transaction
         raise
       ensure
         ElasticAPM.end_transaction
@@ -74,7 +91,7 @@ module ElasticAPM
       def trace_context(call)
         TraceContext.parse(metadata: call.metadata)
       rescue TraceContext::InvalidTraceparentHeader
-        warn "Couldn't parse invalid trace context header: #{header.inspect}"
+        warn "Couldn't parse invalid trace context header: #{call.metadata}"
         nil
       end
     end

data/lib/elastic_apm/instrumenter.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'
@@ -52,6 +69,9 @@ module ElasticAPM
 
     def start
       debug 'Starting instrumenter'
+      # We call register! on @subscriber in case the
+      # instrumenter was stopped and started again
+      @subscriber&.register!
     end
 
     def stop
@@ -63,6 +83,11 @@ module ElasticAPM
       @subscriber&.unregister!
     end
 
+    def handle_forking!
+      stop
+      start
+    end
+
     def subscriber=(subscriber)
       debug 'Registering subscriber'
       @subscriber = subscriber
@@ -178,7 +203,7 @@ module ElasticAPM
         sync: sync
       )
 
-      if backtrace && transaction.config.span_frames_min_duration?
+      if backtrace && transaction.span_frames_min_duration
         span.original_backtrace = backtrace
       end
 
@@ -234,7 +259,7 @@ module ElasticAPM
     end
 
     def update_transaction_metrics(transaction)
-      return unless transaction.config.collect_metrics?
+      return unless transaction.collect_metrics
 
       tags = {
         'transaction.name': transaction.name,
@@ -252,7 +277,7 @@ module ElasticAPM
       ).inc!
 
       return unless transaction.sampled?
-      return unless transaction.config.breakdown_metrics?
+      return unless transaction.breakdown_metrics
 
       @metrics.get(:breakdown).counter(
         :'transaction.breakdown.count',
@@ -273,7 +298,7 @@ module ElasticAPM
     end
 
     def update_span_metrics(span)
-      return unless span.transaction.config.breakdown_metrics?
+      return unless span.transaction.breakdown_metrics
 
       tags = {
         'span.type': span.type,

data/lib/elastic_apm/internal_error.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/logging.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/metadata.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/metadata/process_info.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/metadata/service_info.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
@@ -13,14 +30,17 @@ module ElasticAPM
 
         attr_reader :name, :version
       end
+
       class Agent < Versioned; end
       class Framework < Versioned; end
       class Language < Versioned; end
       class Runtime < Versioned; end
+
       def initialize(config)
         @config = config
 
         @name = @config.service_name
+        @node_name = @config.service_node_name
         @environment = @config.environment
         @agent = Agent.new(name: 'ruby', version: VERSION)
         @framework = Framework.new(
@@ -32,8 +52,8 @@ module ElasticAPM
         @version = @config.service_version || Util.git_sha
       end
 
-      attr_reader :name, :environment, :agent, :framework, :language, :runtime,
-        :version
+      attr_reader :name, :node_name, :environment, :agent, :framework, :language,
+        :runtime, :version
 
       private
 

data/lib/elastic_apm/metadata/system_info.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
@@ -7,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
 
@@ -18,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

@@ -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
@@ -64,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
@@ -101,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/metrics.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,7 +48,9 @@ module ElasticAPM
 
         debug 'Starting metrics'
 
-        @sets = {
+        # Only set the @sets once, in case we stop
+        # and start again.
+        @sets ||= {
           system: CpuMemSet,
           vm: VMSet,
           breakdown: BreakdownSet,
@@ -73,11 +92,24 @@ module ElasticAPM
         !!@running
       end
 
+      def handle_forking!
+        # Note that ideally we would be able to check if the @timer_task died
+        # and restart it. You can't simply check @timer_task.running? because
+        # it will only return the state of the TimerTask, not whether the
+        # internal thread used to manage the execution interval has died.
+        # This is a limitation of the Concurrent::TimerTask object.
+        # Therefore, our only option when forked is to stop and start.
+        # ~estolfo
+        stop
+        start
+      end
+
       def get(key)
         sets.fetch(key)
       end
 
       def collect_and_send
+        return unless @config.recording?
         metricsets = collect
         metricsets.compact!
         metricsets.each do |m|

data/lib/elastic_apm/metrics/breakdown_set.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