elastic-apm 3.3.0 → 3.8.0

data/lib/elastic_apm/span/context/db.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 Span
+    class Context
+      # @api private
+      class Db
+        def initialize(
+          instance: nil,
+          statement: nil,
+          type: nil,
+          user: nil,
+          rows_affected: nil
+        )
+          @instance = instance
+          @statement = statement
+          @type = type
+          @user = user
+          @rows_affected = rows_affected
+        end
+
+        attr_accessor :instance, :statement, :type, :user, :rows_affected
+      end
+    end
+  end
+end

data/lib/elastic_apm/span/context/destination.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
+  class Span
+    class Context
+      # @api private
+      class Destination
+        def initialize(
+          name: nil,
+          resource: nil,
+          type: nil,
+          address: nil,
+          port: nil
+        )
+          @name = name
+          @resource = resource
+          @type = type
+          @address = address
+          @port = port
+        end
+
+        attr_reader(
+          :name,
+          :resource,
+          :type,
+          :address,
+          :port
+        )
+
+        def self.from_uri(uri_or_str, type: 'external', port: nil)
+          uri = normalize(uri_or_str)
+
+          new(
+            name: only_scheme_and_host(uri),
+            resource: "#{uri.host}:#{uri.port}",
+            type: type,
+            address: uri.hostname,
+            port: port || uri.port
+          )
+        end
+
+        def self.only_scheme_and_host(uri_or_str)
+          uri = normalize(uri_or_str)
+          uri.path = ''
+          uri.password = uri.query = uri.fragment = nil
+          uri.to_s
+        end
+
+        class << self
+          private
+
+          def normalize(uri_or_str)
+            return uri_or_str.dup if uri_or_str.is_a?(URI)
+            URI(uri_or_str)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elastic_apm/span/context/http.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 Span
+    class Context
+      # @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(uri_or_str)
+          uri = uri_or_str.is_a?(URI) ? uri_or_str.dup : URI(uri_or_str)
+          uri.password = nil
+          uri.to_s
+        end
+      end
+    end
+  end
+end

data/lib/elastic_apm/span_helpers.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/spies.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/inflector'
@@ -63,23 +80,25 @@ module ElasticAPM
   end
 end
 
-# @api private
-module Kernel
-  private
+unless ENV['ELASTIC_APM_SKIP_REQUIRE_PATCH'] == '1'
+  # @api private
+  module Kernel
+    private
 
-  alias require_without_apm require
+    alias require_without_apm require
 
-  def require(path)
-    res = require_without_apm(path)
+    def require(path)
+      res = require_without_apm(path)
 
-    begin
-      ElasticAPM::Spies.hook_into(path)
-    rescue ::Exception => e
-      puts "Failed hooking into '#{path}'. Please report this at " \
-        'github.com/elastic/apm-agent-ruby'
-      puts e.backtrace.join("\n")
-    end
+      begin
+        ElasticAPM::Spies.hook_into(path)
+      rescue ::Exception => e
+        puts "Failed hooking into '#{path}'. Please report this at " \
+          'github.com/elastic/apm-agent-ruby'
+        puts e.backtrace.join("\n")
+      end
 
-    res
+      res
+    end
   end
 end

data/lib/elastic_apm/spies/action_dispatch.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/spies/delayed_job.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/spies/elasticsearch.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
@@ -6,19 +23,46 @@ module ElasticAPM
     # @api private
     class ElasticsearchSpy
       NAME_FORMAT = '%s %s'
-      TYPE = 'db.elasticsearch'
+      TYPE = 'db'
+      SUBTYPE = 'elasticsearch'
+
+      def self.sanitizer
+        @sanitizer ||= ElasticAPM::Transport::Filters::HashSanitizer.new
+      end
+
       def install
         ::Elasticsearch::Transport::Client.class_eval do
           alias perform_request_without_apm perform_request
 
           def perform_request(method, path, *args, &block)
             name = format(NAME_FORMAT, method, path)
-            statement = args[0].is_a?(String) ? args[0] : args[0].to_json
-            context = Span::Context.new(db: { statement: statement })
+            statement = []
 
-            ElasticAPM.with_span name, TYPE, context: context do
-              perform_request_without_apm(method, path, *args, &block)
+            statement << { params: args&.[](0) }
+
+            if ElasticAPM.agent.config.capture_elasticsearch_queries
+              unless args[1].nil? || args[1].empty?
+                statement << {
+                  body: ElasticAPM::Spies::ElasticsearchSpy.sanitizer.strip_from!(args[1])
+                }
+              end
             end
+
+            context = Span::Context.new(
+              db: { statement: statement.reduce({}, :merge).to_json },
+              destination: {
+                name: SUBTYPE,
+                resource: SUBTYPE,
+                type: TYPE
+              }
+            )
+
+            ElasticAPM.with_span(
+              name,
+              TYPE,
+              subtype: SUBTYPE,
+              context: context
+            ) { perform_request_without_apm(method, path, *args, &block) }
           end
         end
       end

data/lib/elastic_apm/spies/faraday.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
@@ -16,7 +33,6 @@ module ElasticAPM
         end
       end
 
-      # rubocop:disable Metrics/PerceivedComplexity
       # rubocop:disable Metrics/CyclomaticComplexity
       def install
         ::Faraday::Connection.class_eval do
@@ -27,40 +43,59 @@ module ElasticAPM
               return run_request_without_apm(method, url, body, headers, &block)
             end
 
-            host = if url_prefix.is_a?(URI) && url_prefix.host
-                     url_prefix.host
-                   elsif url.nil?
-                     tmp_request = build_request(method) do |req|
-                       yield(req) if block_given?
-                     end
-                     URI(tmp_request.path).host
-                   else
-                     URI(url).host
-                   end
+            uri = URI(build_url(url))
+
+            # If url is set inside block it isn't available until yield,
+            # so we temporarily build the request to yield. This could be a
+            # problem if the block has side effects as it will be yielded twice
+            # ~mikker
+            unless uri.host
+              tmp_request = build_request(method) do |req|
+                yield(req) if block_given?
+              end
+              uri = URI(tmp_request.path)
+            end
+
+            host = uri.host
 
-            name = "#{method.upcase} #{host}"
+            upcased_method = method.to_s.upcase
+
+            destination = ElasticAPM::Span::Context::Destination.from_uri(uri)
+
+            context =
+              ElasticAPM::Span::Context.new(
+                http: { url: uri, method: upcased_method },
+                destination: destination
+              )
 
             ElasticAPM.with_span(
-              name,
+              "#{upcased_method} #{host}",
               TYPE,
               subtype: SUBTYPE,
-              action: method.to_s
+              action: upcased_method,
+              context: context
             ) do |span|
               ElasticAPM::Spies::FaradaySpy.without_net_http do
                 trace_context = span&.trace_context || transaction.trace_context
 
-                run_request_without_apm(method, url, body, headers) do |req|
-                  req['Elastic-Apm-Traceparent'] = trace_context.to_header
+                result =
+                  run_request_without_apm(method, url, body, headers) do |req|
+                    trace_context.apply_headers { |k, v| req[k] = v }
 
-                  yield req if block_given?
+                    yield req if block_given?
+                  end
+
+                if (http = span&.context&.http)
+                  http.status_code = result.status.to_s
                 end
+
+                result
               end
             end
           end
         end
       end
       # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/PerceivedComplexity
     end
 
     register 'Faraday', 'faraday', FaradaySpy.new