elastic-apm 3.3.0 → 3.8.0

data/lib/elastic_apm/grpc.rb

@@ -0,0 +1,99 @@
+# 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
+  # @api private
+  class GRPC
+    # @api private
+    class ClientInterceptor < ::GRPC::ClientInterceptor
+      TYPE = 'external'
+      SUBTYPE = 'grpc'
+
+      # rubocop:disable Lint/UnusedMethodArgument
+      def request_response(request:, call:, method:, metadata:)
+        return yield unless (transaction = ElasticAPM.current_transaction)
+        if (trace_context = transaction.trace_context)
+          trace_context.apply_headers { |k, v| metadata[k.downcase] = v }
+        end
+
+        ElasticAPM.with_span(
+          method, TYPE,
+          subtype: SUBTYPE,
+          context: span_context(call)
+        ) do
+          yield
+        end
+      end
+      # rubocop:enable Lint/UnusedMethodArgument
+
+      private
+
+      def span_context(call)
+        peer = call.instance_variable_get(:@wrapped)&.peer
+        return unless peer
+
+        split_peer = URI.split(peer)
+        destination = ElasticAPM::Span::Context::Destination.new(
+          type: TYPE,
+          name: SUBTYPE,
+          resource: peer,
+          address: split_peer[0],
+          port: split_peer[6]
+        )
+        ElasticAPM::Span::Context.new(destination: destination)
+      end
+    end
+
+    # @api private
+    class ServerInterceptor < ::GRPC::ClientInterceptor
+      TYPE = 'request'
+
+      # rubocop:disable Lint/UnusedMethodArgument
+      def request_response(request:, call:, method:)
+        transaction = start_transaction(call)
+        yield
+        transaction.done 'success'
+      rescue ::Exception => e
+        ElasticAPM.report(e, handled: false)
+        transaction.done 'error' if transaction
+        raise
+      ensure
+        ElasticAPM.end_transaction
+      end
+      # rubocop:enable Lint/UnusedMethodArgument
+
+      private
+
+      def start_transaction(call)
+        ElasticAPM.start_transaction(
+          'grpc',
+          'request',
+          trace_context: trace_context(call)
+        )
+      end
+
+      def trace_context(call)
+        TraceContext.parse(metadata: call.metadata)
+      rescue TraceContext::InvalidTraceparentHeader
+        warn "Couldn't parse invalid trace context header: #{call.metadata}"
+        nil
+      end
+    end
+  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
@@ -136,6 +161,7 @@ module ElasticAPM
     end
 
     # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
     # rubocop:disable Metrics/ParameterLists
     def start_span(
       name,
@@ -144,19 +170,25 @@ module ElasticAPM
       action: nil,
       backtrace: nil,
       context: nil,
-      trace_context: nil
+      trace_context: nil,
+      parent: nil,
+      sync: nil
     )
-      return unless (transaction = current_transaction)
-      return unless transaction.sampled?
 
-      transaction.inc_started_spans!
-
-      if transaction.max_spans_reached?
-        transaction.inc_dropped_spans!
-        return
-      end
+      transaction =
+        case parent
+        when Span
+          parent.transaction
+        when Transaction
+          parent
+        else
+          current_transaction
+        end
+      return unless transaction
+      return unless transaction.sampled?
+      return unless transaction.inc_started_spans!
 
-      parent = current_span || transaction
+      parent ||= (current_span || current_transaction)
 
       span = Span.new(
         name: name,
@@ -167,10 +199,11 @@ module ElasticAPM
         trace_context: trace_context,
         type: type,
         context: context,
-        stacktrace_builder: stacktrace_builder
+        stacktrace_builder: stacktrace_builder,
+        sync: sync
       )
 
-      if backtrace && transaction.config.span_frames_min_duration?
+      if backtrace && transaction.span_frames_min_duration
         span.original_backtrace = backtrace
       end
 
@@ -180,6 +213,7 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/ParameterLists
     # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
 
     def end_span
       return unless (span = current_spans.pop)
@@ -225,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,
@@ -243,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',
@@ -264,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

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

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|