elastic-apm 3.3.0 → 3.8.0

data/lib/elastic_apm/opentracing.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'
@@ -22,7 +39,7 @@ module ElasticAPM
         @span_context
       end
 
-      def set_label(key, val)
+      def set_tag(key, val)
         if elastic_span.is_a?(Transaction)
           case key.to_s
           when 'type'
@@ -37,6 +54,8 @@ module ElasticAPM
         else
           elastic_span.context.labels[key] = val
         end
+
+        self
       end
 
       def set_baggage_item(_key, _value)
@@ -61,18 +80,12 @@ module ElasticAPM
           ElasticAPM.report_message message
         end
       end
-
       # rubocop:enable Lint/UnusedMethodArgument
-      def finish(clock_end: Util.monotonic_micros, end_time: nil)
-        return unless (agent = ElasticAPM.agent)
 
-        if end_time
-          warn '[ElasticAPM] DEPRECATED: Setting a custom end time as a ' \
-            '`Time` is deprecated. Use `clock_end:` and monotonic time instead.'
-          clock_end = end_time
-        end
+      def finish(end_time: Time.now)
+        return unless (agent = ElasticAPM.agent)
 
-        elastic_span.done clock_end: clock_end
+        elastic_span.done clock_end: Util.micros(end_time)
 
         case elastic_span
         when ElasticAPM::Transaction
@@ -97,6 +110,8 @@ module ElasticAPM
 
     # @api private
     class SpanContext
+      extend Forwardable
+
       def initialize(trace_context:, baggage: nil)
         if baggage
           ElasticAPM.agent.config.logger.warn(
@@ -108,10 +123,27 @@ module ElasticAPM
       end
 
       attr_accessor :trace_context
+      def_delegators :trace_context, :trace_id, :id, :parent_id
+
+      def self.from_header(header)
+        return unless header
+
+        trace_context = ElasticAPM::TraceContext.parse(header)
+        return unless trace_context
+
+        trace_context.traceparent.id = trace_context.parent_id
+        trace_context.traceparent.parent_id = nil
+
+        from_trace_context(trace_context)
+      end
 
       def self.from_trace_context(trace_context)
         new(trace_context: trace_context)
       end
+
+      def child
+        self.class.from_trace_context(trace_context.child)
+      end
     end
 
     # @api private
@@ -193,7 +225,7 @@ module ElasticAPM
         child_of: nil,
         references: nil,
         start_time: Time.now,
-        labels: {},
+        tags: {},
         ignore_active_scope: false,
         finish_on_close: true,
         **
@@ -203,14 +235,14 @@ module ElasticAPM
           child_of: child_of,
           references: references,
           start_time: start_time,
-          labels: labels,
+          tags: tags,
           ignore_active_scope: ignore_active_scope
         )
         scope = scope_manager.activate(span, finish_on_close: finish_on_close)
 
         if block_given?
           begin
-            yield scope
+            return yield scope
           ensure
             scope.close
           end
@@ -226,7 +258,7 @@ module ElasticAPM
         child_of: nil,
         references: nil,
         start_time: Time.now,
-        labels: {},
+        tags: {},
         ignore_active_scope: false,
         **
       )
@@ -263,7 +295,7 @@ module ElasticAPM
         span_context ||=
           SpanContext.from_trace_context(elastic_span.trace_context)
 
-        labels.each do |key, value|
+        tags.each do |key, value|
           elastic_span.context.labels[key] = value
         end
 
@@ -276,8 +308,9 @@ module ElasticAPM
 
       def inject(span_context, format, carrier)
         case format
-        when ::OpenTracing::FORMAT_RACK
-          carrier['elastic-apm-traceparent'] = span_context.to_header
+        when ::OpenTracing::FORMAT_RACK, ::OpenTracing::FORMAT_TEXT_MAP
+          carrier['elastic-apm-traceparent'] =
+            span_context.traceparent.to_header
         else
           warn 'Only injection via HTTP headers and Rack is available'
         end
@@ -286,10 +319,16 @@ module ElasticAPM
       def extract(format, carrier)
         case format
         when ::OpenTracing::FORMAT_RACK
-          ElasticAPM::TraceContext
-            .parse(carrier['HTTP_ELASTIC_APM_TRACEPARENT'])
+          SpanContext.from_header(
+            carrier['HTTP_ELASTIC_APM_TRACEPARENT']
+          )
+        when ::OpenTracing::FORMAT_TEXT_MAP
+          SpanContext.from_header(
+            carrier['elastic-apm-traceparent']
+          )
         else
-          warn 'Only extraction from HTTP headers via Rack is available'
+          warn 'Only extraction from HTTP headers via Rack or in ' \
+            'text map format are available'
           nil
         end
       rescue ElasticAPM::TraceContext::InvalidTraceparentHeader
@@ -303,9 +342,12 @@ module ElasticAPM
         references:,
         ignore_active_scope:
       )
-        context_from_child_of(child_of) ||
-          context_from_references(references) ||
-          context_from_active_scope(ignore_active_scope)
+        context = context_from_child_of(child_of) ||
+                  context_from_references(references) ||
+                  context_from_active_scope(ignore_active_scope)
+        return context.child if context&.respond_to?(:child)
+
+        context
       end
 
       def context_from_child_of(child_of)
@@ -326,7 +368,7 @@ module ElasticAPM
       def context_from_active_scope(ignore_active_scope)
         if ignore_active_scope
           ElasticAPM.agent&.config&.logger&.warn(
-            'ignore_active_scope might lead to unexpeced results'
+            'ignore_active_scope might lead to unexpected results'
           )
           return
         end

data/lib/elastic_apm/rails.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/railtie'
@@ -9,7 +26,6 @@ module ElasticAPM
   # It is recommended to use the Railtie instead.
   module Rails
     extend self
-    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     # Start the ElasticAPM agent and hook into Rails.
     # Note that the agent won't be started if the Rails console is being used.
     #
@@ -31,13 +47,6 @@ module ElasticAPM
         attach_subscriber(agent)
       end
 
-      if ElasticAPM.running? &&
-         !ElasticAPM.agent.config.disabled_instrumentations.include?(
-           'action_dispatch'
-         )
-        require 'elastic_apm/spies/action_dispatch'
-      end
-
       ElasticAPM.running?
     rescue StandardError => e
       if config.disable_start_message?
@@ -48,12 +57,11 @@ module ElasticAPM
         puts "Backtrace:\n" + e.backtrace.join("\n")
       end
     end
-    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     private
 
     def should_skip?(_config)
-      if ::Rails.const_defined? 'Rails::Console'
+      if ::Rails.const_defined?('Console', false)
         return 'Rails console'
       end
 

data/lib/elastic_apm/railtie.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
 
     Config.schema.each do |key, args|
       next unless args.length > 1
-      config.elastic_apm[key] = args.last[:default]
+      config.elastic_apm[key] = args[:default]
     end
 
     initializer 'elastic_apm.initialize' do |app|

data/lib/elastic_apm/resque.rb

@@ -0,0 +1,29 @@
+# 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
+  # Defines a before_first_fork hook for starting the ElasticAPM agent
+  # with Resque.
+  module Resque
+    ::Resque.before_first_fork do
+      ::Resque.logger.debug('Starting ElasticAPM agent')
+      ElasticAPM.start
+    end
+  end
+end

data/lib/elastic_apm/sinatra.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/span.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/span/context'
@@ -20,7 +37,8 @@ module ElasticAPM
       subtype: nil,
       action: nil,
       context: nil,
-      stacktrace_builder: nil
+      stacktrace_builder: nil,
+      sync: nil
     )
       @name = name
 
@@ -36,7 +54,7 @@ module ElasticAPM
       @parent = parent
       @trace_context = trace_context || parent.trace_context.child
 
-      @context = context || Span::Context.new
+      @context = context || Span::Context.new(sync: sync)
       @stacktrace_builder = stacktrace_builder
     end
     # rubocop:enable Metrics/ParameterLists

data/lib/elastic_apm/span/context.rb

@@ -1,56 +1,55 @@
+# 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 Span
     # @api private
     class Context
-      def initialize(db: nil, http: nil, labels: {})
-        @sync = true
-        @db = db && Db.new(db)
-        @http = http && Http.new(http)
+      def initialize(
+        db: nil,
+        destination: nil,
+        http: nil,
+        labels: {},
+        sync: nil
+      )
+        @sync = sync
+        @db = db && Db.new(**db)
+        @http = http && Http.new(**http)
+        @destination =
+          case destination
+          when Destination then destination
+          when Hash then Destination.new(**destination)
+          end
         @labels = labels
       end
 
-      attr_accessor :sync, :db, :http, :labels
-
-      # @api private
-      class Db
-        def initialize(instance: nil, statement: nil, type: nil, user: nil)
-          @instance = instance
-          @statement = statement
-          @type = type
-          @user = user
-        end
-
-        attr_accessor :instance, :statement, :type, :user
-      end
-
-      # @api private
-      class Http
-        def initialize(url: nil, status_code: nil, method: nil)
-          @url = sanitize_url(url)
-          @status_code = status_code
-          @method = method
-        end
-
-        attr_accessor :url, :status_code, :method
-
-        private
-
-        def sanitize_url(url)
-          uri = URI(url)
-
-          return url unless uri.userinfo
-
-          format(
-            '%s://%s@%s%s',
-            uri.scheme,
-            uri.user,
-            uri.hostname,
-            uri.path
-          )
-        end
-      end
+      attr_reader(
+        :db,
+        :destination,
+        :http,
+        :labels,
+        :sync
+      )
     end
   end
 end
+
+require 'elastic_apm/span/context/db'
+require 'elastic_apm/span/context/http'
+require 'elastic_apm/span/context/destination'