hoss-agent 1.0.11

data/lib/hoss/report.rb

@@ -0,0 +1,9 @@
+module Hoss
+  # @api private
+  class Report
+    extend Forwardable
+    attr_accessor(
+      :events
+    )
+  end
+end

data/lib/hoss/sinatra.rb

@@ -0,0 +1,53 @@
+# 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 Hoss
+  # Module for starting the Hoss agent and hooking into Sinatra.
+  module Sinatra
+    extend self
+    # Start the Hoss agent and hook into Sinatra.
+    #
+    # @param app [Sinatra::Base] A Sinatra app.
+    # @param config [Config, Hash] An instance of Config or a Hash config.
+    # @return [true, nil] true if the agent was started, nil otherwise.
+    def start(app, config = {})
+      config = Config.new(config) unless config.is_a?(Config)
+      configure_app(app, config)
+
+      Hoss.start(config)
+      Hoss.running?
+    rescue StandardError => e
+      config.logger.error format('Failed to start: %s', e.message)
+      config.logger.debug "Backtrace:\n" + e.backtrace.join("\n")
+    end
+
+    private
+
+    def configure_app(app, config)
+      config.service_name ||= format_name(app.to_s)
+      config.framework_name ||= 'Sinatra'
+      config.framework_version ||= ::Sinatra::VERSION
+      config.__root_path ||= Dir.pwd
+    end
+
+    def format_name(str)
+      str&.gsub('::', '_')
+    end
+  end
+end

data/lib/hoss/spies.rb

@@ -0,0 +1,104 @@
+# 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 'hoss/util/inflector'
+
+module Hoss
+  # @api private
+  module Spies
+    # @api private
+    class Registration
+      extend Forwardable
+
+      def initialize(const_name, require_paths, spy)
+        @const_name = const_name
+        @require_paths = Array(require_paths)
+        @spy = spy
+      end
+
+      attr_reader :const_name, :require_paths
+
+      def_delegator :@spy, :install
+    end
+
+    def self.require_hooks
+      @require_hooks ||= {}
+    end
+
+    def self.installed
+      @installed ||= {}
+    end
+
+    def self.register(*args)
+      registration = Registration.new(*args)
+
+      if safe_defined?(registration.const_name)
+        registration.install
+        installed[registration.const_name] = registration
+      else
+        register_require_hook registration
+      end
+    end
+
+    def self.register_require_hook(registration)
+      registration.require_paths.each do |path|
+        require_hooks[path] = registration
+      end
+    end
+
+    def self.hook_into(name)
+      return unless (registration = require_hooks[name])
+      return unless safe_defined?(registration.const_name)
+
+      installed[registration.const_name] = registration
+      registration.install
+
+      registration.require_paths.each do |path|
+        require_hooks.delete path
+      end
+    end
+
+    def self.safe_defined?(const_name)
+      Util::Inflector.safe_constantize(const_name)
+    end
+  end
+end
+
+unless ENV['HOSS_SKIP_REQUIRE_PATCH'] == '1'
+  # @api private
+  module Kernel
+    private
+
+    alias require_without_apm require
+
+    def require(path)
+      res = require_without_apm(path)
+
+      begin
+        Hoss::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
+    end
+  end
+end

data/lib/hoss/spies/faraday.rb

@@ -0,0 +1,117 @@
+# 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 Hoss
+  # @api private
+  module Spies
+    # @api private
+    class FaradaySpy
+      TYPE = 'ext'
+      SUBTYPE = 'faraday'
+
+      def self.without_net_http
+        return yield unless defined?(NetHTTPSpy)
+
+        Hoss::Spies::NetHTTPSpy.disable_in do
+          yield
+        end
+      end
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def install
+        ::Faraday::Connection.class_eval do
+          alias run_request_without_apm run_request
+
+          def run_request(method, url, body, headers, &block)
+            result = nil
+            error_in_request = false
+            error_in_block = false
+            begin
+              Hoss.with_event do |event|
+                Hoss::Spies::FaradaySpy.without_net_http do
+                  uri = URI(build_url(url))
+                  begin
+                    result = run_request_without_apm(method, url, body, headers) do |req|
+                      if block_given?
+                        yield req
+                        begin
+                          new_path = req.path
+                          new_query = URI.encode_www_form(req.params)
+                          if uri.path != new_path || uri.query != new_query
+                            test_uri = uri
+                            test_uri.query = nil
+                            begin
+                              test_uri.path = new_path
+                            rescue Exception => e
+                            end
+                            # The original url can be set to path if Faraday.get used
+                            if test_uri.to_s != uri.to_s
+                              uri.path = new_path
+                            end
+                            uri.query = new_query
+                          end
+                        rescue
+                          error_in_block = true
+                          raise
+                        end
+                      end
+                      begin
+                        event.request.method = method.to_s.upcase
+                        event.request.url = uri.to_s
+                        event.request.received_at = DateTime.now.strftime('%Q').to_i
+                        event.request.headers['host'] = uri.hostname
+                        req.headers.each {|n,v| event.request.headers[n] = v}
+                        event.request.url = uri.to_s
+                        event.request.body = req.body
+                      rescue
+                        error_in_block = true
+                        raise
+                      end
+                    end
+                  rescue
+                    error_in_request = true
+                    event.error = Hoss::Event::Error.new(Hoss::Event::Error::ConnectionError)
+                    event.error.received_at = DateTime.now.strftime('%Q').to_i
+                    raise
+                  end
+                  if result
+                    event.response = Hoss::Event::Response.new
+                    event.response.received_at = DateTime.now.strftime('%Q').to_i
+                    event.response.status_code = result.status.to_i
+                    result.headers.each {|n,v| event.response.headers[n] = v}
+                    event.response.body = result.body
+                  end
+                  result
+                end
+              end
+            rescue Exception => e
+              raise if error_in_request && !error_in_block
+              puts format('Hoss Error: %s %s', e.inspect, e.backtrace)
+              return result unless result.nil?
+              return run_request_without_apm(method, url, body, headers, &block)
+            end
+          end
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+    end
+
+    register 'Faraday', 'faraday', FaradaySpy.new
+  end
+end

data/lib/hoss/spies/http.rb

@@ -0,0 +1,93 @@
+# 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 Hoss
+  # @api private
+  module Spies
+    # @api private
+    class HTTPSpy
+      TYPE = 'ext'
+      SUBTYPE = 'http_rb'
+
+      def self.copy_request_body(body)
+        case body.source
+        when String
+          body.source
+        when nil
+          nil
+        else
+          ""
+        end
+      end
+
+      def install
+        ::HTTP::Client.class_eval do
+          alias perform_without_apm perform
+
+          def perform(req, options)
+            result = nil
+            error_in_request = false
+            begin
+              if req.headers['HOSS-SKIP-INSTRUMENTATION'] == 'true'
+                return perform_without_apm(req, options)
+              end
+
+              Hoss.with_event do |event|
+                event.request.headers['host'] = req.uri.host
+                req.headers.each {|n,v| event.request.headers[n] = v}
+                event.request.method = req.verb.to_s.upcase
+                event.request.url = req.uri.to_s
+                event.request.body = Hoss::Spies::HTTPSpy::copy_request_body(req.body)
+                event.request.received_at = DateTime.now.strftime('%Q').to_i
+                begin
+                  result = perform_without_apm(req, options)
+                rescue HTTP::TimeoutError => e
+                  error_in_request = true
+                  event.error = Hoss::Event::Error.new(Hoss::Event::Error::ConnectionTimeout)
+                  event.error.received_at = DateTime.now.strftime('%Q').to_i
+                  raise
+                rescue Exception => e
+                  error_in_request = true
+                  event.error = Hoss::Event::Error.new(Hoss::Event::Error::ConnectionError)
+                  event.error.received_at = DateTime.now.strftime('%Q').to_i
+                  raise
+                end
+                if result
+                  event.response = Hoss::Event::Response.new
+                  event.response.received_at = DateTime.now.strftime('%Q').to_i
+                  event.response.status_code = result.code.to_i
+                  result.headers.each {|n,v| event.response.headers[n] = v}
+                  event.response.body = result.body.to_s
+                end
+                result
+              end
+            rescue Exception => e
+              raise if error_in_request
+              puts format('Hoss Error: %s %s', e.inspect, e.backtrace)
+              return result unless result.nil?
+              return perform_without_apm(req, options)
+            end
+          end
+        end
+      end
+    end
+
+    register 'HTTP', 'http', HTTPSpy.new
+  end
+end

data/lib/hoss/spies/net_http.rb

@@ -0,0 +1,113 @@
+# 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 Hoss
+  # @api private
+  module Spies
+    # @api private
+    class NetHTTPSpy
+      KEY = :__hoss_net_http_disabled
+      # TYPE = 'ext'
+      # SUBTYPE = 'net_http'
+
+      class << self
+        def disabled=(disabled)
+          Thread.current[KEY] = disabled
+        end
+
+        def disabled?
+          Thread.current[KEY] ||= false
+        end
+
+        def disable_in
+          self.disabled = true
+
+          begin
+            yield
+          ensure
+            self.disabled = false
+          end
+        end
+      end
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def install
+        Net::HTTP.class_eval do
+          alias request_without_apm request
+
+          def request(req, body = nil, &block)
+            result = nil
+            error_in_request = false
+            begin
+              if req['HOSS-SKIP-INSTRUMENTATION'] == 'true' || Hoss::Spies::NetHTTPSpy.disabled?
+                return request_without_apm(req, body, &block)
+              end
+
+              host = req['host']&.split(':')&.first || address
+              method = req.method.to_s.upcase
+              path, query = req.path.split('?')
+
+              url = use_ssl? ? +'https://' : +'http://'
+              url << host
+              url << ":#{port}" if port
+              url << path
+              url << "?#{query}" if query
+              uri = URI(url)
+
+              Hoss.with_event do |event|
+                # Record request
+                event.request.headers['host'] = uri.hostname
+                req.each_header {|n,v| event.request.headers[n] = v}
+                event.request.method = method
+                event.request.url = uri.to_s
+                event.request.body = req.body
+                event.request.received_at = DateTime.now.strftime('%Q').to_i
+
+                begin
+                  result = request_without_apm(req, body, &block)
+                rescue
+                  error_in_request = true
+                  raise
+                end
+
+                if result
+                  event.response = Hoss::Event::Response.new
+                  event.response.received_at = DateTime.now.strftime('%Q').to_i
+                  event.response.status_code = result.code.to_i
+                  result.each_header {|n,v| event.response.headers[n] = v}
+                  event.response.body = result.body
+                end
+
+                result
+              end
+            rescue Exception => e
+              raise if error_in_request
+              puts format('Hoss Error: %s %s', e.inspect, e.backtrace)
+              return result unless result.nil?
+              return request_without_apm(req, body, &block)
+            end
+          end
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+    end
+
+    register 'Net::HTTP', 'net/http', NetHTTPSpy.new
+  end
+end