hoss-agent 1.0.1

data/lib/hoss/context/response.rb

@@ -0,0 +1,47 @@
+# 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
+  class Context
+    # @api private
+    class Response
+      def initialize(
+        status_code,
+        headers: {},
+        headers_sent: true,
+        finished: true
+      )
+        @status_code = status_code
+        @headers_sent = headers_sent
+        @finished = finished
+
+        self.headers = headers
+      end
+
+      attr_accessor :status_code, :headers_sent, :finished
+      attr_reader :headers
+
+      def headers=(headers)
+        @headers = headers&.each_with_object({}) do |(k, v), hsh|
+          hsh[k] = v.to_s
+        end
+      end
+    end
+  end
+end

data/lib/hoss/context/user.rb

@@ -0,0 +1,59 @@
+# 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
+  class Context
+    # @api private
+    class User
+      def initialize(id: nil, email: nil, username: nil)
+        @id = id
+        @email = email
+        @username = username
+      end
+
+      def self.infer(config, record)
+        return unless record
+
+        new(
+          id: safe_get(record, config.current_user_id_method)&.to_s,
+          email: safe_get(record, config.current_user_email_method),
+          username: safe_get(record, config.current_user_username_method)
+        )
+      end
+
+      attr_accessor :id, :email, :username
+
+      def empty?
+        !id && !email && !username
+      end
+
+      def any?
+        !empty?
+      end
+
+      class << self
+        private
+
+        def safe_get(record, method_name)
+          record.respond_to?(method_name) ? record.send(method_name) : nil
+        end
+      end
+    end
+  end
+end

data/lib/hoss/context.rb

@@ -0,0 +1,64 @@
+# 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/context/request'
+require 'hoss/context/request/socket'
+require 'hoss/context/request/url'
+require 'hoss/context/response'
+require 'hoss/context/user'
+
+module Hoss
+  # @api private
+  class Context
+    def initialize(custom: {}, labels: {}, user: nil, service: nil)
+      @custom = custom
+      @labels = labels
+      @user = user || User.new
+      @service = service
+    end
+
+    Service = Struct.new(:framework)
+    Framework = Struct.new(:name, :version)
+
+    attr_accessor :request
+    attr_accessor :response
+    attr_accessor :user
+    attr_reader :custom
+    attr_reader :labels
+    attr_reader :service
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def empty?
+      return false if labels.any?
+      return false if custom.any?
+      return false if user.any?
+      return false if service
+      return false if request || response
+
+      true
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+
+    def set_service(framework_name: nil, framework_version: nil)
+      @service = Service.new(
+        Framework.new(framework_name, framework_version)
+      )
+    end
+  end
+end

data/lib/hoss/context_builder.rb

@@ -0,0 +1,112 @@
+# 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
+  class ContextBuilder
+    MAX_BODY_LENGTH = 2048
+    SKIPPED = '[SKIPPED]'
+
+    def initialize(config)
+      @config = config
+    end
+
+    attr_reader :config
+
+    def build(rack_env:, for_type:)
+      Context.new.tap do |context|
+        apply_to_request(context, rack_env: rack_env, for_type: for_type)
+      end
+    end
+
+    private
+
+    def apply_to_request(context, rack_env:, for_type:)
+      req = rails_req?(rack_env) ? rack_env : Rack::Request.new(rack_env)
+
+      context.request = Context::Request.new unless context.request
+      request = context.request
+
+      request.socket = Context::Request::Socket.new(req)
+      request.http_version = build_http_version rack_env
+      request.method = req.request_method
+      request.url = Context::Request::Url.new(req)
+
+      request.body = should_capture_body?(for_type) ? get_body(req) : SKIPPED
+
+      headers, env = get_headers_and_env(rack_env)
+      request.headers = headers if config.capture_headers?
+      request.env = env if config.capture_env?
+
+      request.cookies = req.cookies.dup
+
+      context
+    end
+
+    def should_capture_body?(for_type)
+      option = config.capture_body
+
+      return true if option == 'all'
+      return true if option == 'transactions' && for_type == :transaction
+      return true if option == 'errors' && for_type == :error
+
+      false
+    end
+
+    def get_body(req)
+      case req.media_type
+      when 'application/x-www-form-urlencoded', 'multipart/form-data'
+        req.POST.dup
+      else
+        body = req.body.read
+        req.body.rewind
+        body.byteslice(0, MAX_BODY_LENGTH).force_encoding('utf-8')
+      end
+    end
+
+    def rails_req?(env)
+      defined?(ActionDispatch::Request) && env.is_a?(ActionDispatch::Request)
+    end
+
+    def get_headers_and_env(rack_env)
+      # In Rails < 5 ActionDispatch::Request inherits from Hash
+      headers =
+        rack_env.respond_to?(:headers) ? rack_env.headers : rack_env
+
+      headers.each_with_object([{}, {}]) do |(key, value), (http, env)|
+        next unless key == key.upcase
+
+        if key.start_with?('HTTP_')
+          http[camel_key(key)] = value
+        else
+          env[key] = value
+        end
+      end
+    end
+
+    def camel_key(key)
+      key.gsub(/^HTTP_/, '').split('_').map(&:capitalize).join('-')
+    end
+
+    def build_http_version(rack_env)
+      return unless (http_version = rack_env['HTTP_VERSION'])
+      http_version.gsub(%r{HTTP/}, '')
+    end
+  end
+end

data/lib/hoss/deprecations.rb

@@ -0,0 +1,39 @@
+# 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 Deprecations
+    def deprecate(name, replacement = nil)
+      alias_name = "#{name.to_s.chomp('=')}__deprecated_"
+      alias_name += '=' if name.to_s.end_with?('=')
+
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        alias :"#{alias_name}" :"#{name}"
+
+        def #{name}(*args, &block)
+          warn "[HOSS] [DEPRECATED] `#{name}' is being removed. " \
+               "#{replacement && "See `#{replacement}'."}" \
+               "\nCalled from \#{caller.first}"
+          send("#{alias_name}", *args, &block)
+        end
+      RUBY
+    end
+  end
+end

data/lib/hoss/error/exception.rb

@@ -0,0 +1,70 @@
+# 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
+  class Error
+    # @api private
+    class Exception
+      MOD_SPLIT = '::'
+
+      def initialize(attrs = nil)
+        return unless attrs
+
+        attrs.each do |key, val|
+          send(:"#{key}=", val)
+        end
+      end
+
+      def self.from_exception(exception, **attrs)
+        new({
+          message: exception.message.to_s,
+          type: exception.class.to_s,
+          module: format_module(exception),
+          cause: exception.cause && Exception.from_exception(exception.cause)
+        }.merge(attrs))
+      end
+
+      attr_accessor(
+        :attributes,
+        :code,
+        :handled,
+        :message,
+        :module,
+        :stacktrace,
+        :type,
+        :cause
+      )
+
+      def inspect
+        '<Hoss::Error::Exception' \
+          " type:#{type}" \
+          " message:#{message}" \
+          '>'
+      end
+
+      class << self
+        private
+
+        def format_module(exception)
+          exception.class.to_s.split(MOD_SPLIT)[0...-1].join(MOD_SPLIT)
+        end
+      end
+    end
+  end
+end

data/lib/hoss/error/log.rb

@@ -0,0 +1,41 @@
+# 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
+  class Error
+    # @api private
+    class Log
+      def initialize(message, attrs = {})
+        @message = message
+
+        attrs.each do |key, val|
+          send(:"#{key}=", val)
+        end
+      end
+
+      attr_accessor(
+        :level,
+        :logger_name,
+        :message,
+        :param_message,
+        :stacktrace
+      )
+    end
+  end
+end

data/lib/hoss/error.rb

@@ -0,0 +1,49 @@
+# 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/stacktrace'
+require 'hoss/context'
+require 'hoss/error/exception'
+require 'hoss/error/log'
+
+module Hoss
+  # @api private
+  class Error
+    def initialize(culprit: nil, context: nil)
+      @id = SecureRandom.hex(16)
+      @culprit = culprit
+      @timestamp = Util.micros
+      @context = context
+    end
+
+    attr_accessor :id, :culprit, :exception, :log, :transaction_id,
+      :transaction, :context, :parent_id, :trace_id
+    attr_reader :timestamp
+
+    def inspect
+      "<Hoss::Error id:#{id}" \
+        " culprit:#{culprit}" \
+        " timestamp:#{timestamp}" \
+        " transaction_id:#{transaction_id}" \
+        " trace_id:#{trace_id}" \
+        " exception:#{exception.inspect}" \
+        '>'
+    end
+  end
+end

data/lib/hoss/error_builder.rb

@@ -0,0 +1,90 @@
+# 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
+  class ErrorBuilder
+    def initialize(agent)
+      @agent = agent
+    end
+
+    def build_exception(exception, context: nil, handled: true)
+      error = Error.new context: context || Context.new
+      error.exception =
+        Error::Exception.from_exception(exception, handled: handled)
+
+      Util.reverse_merge!(error.context.labels, @agent.config.default_labels)
+
+      if exception.backtrace
+        add_stacktrace error, :exception, exception.backtrace
+      end
+
+      add_current_transaction_fields error, Hoss.current_transaction
+
+      error
+    end
+
+    def build_log(message, context: nil, backtrace: nil, **attrs)
+      error = Error.new context: context || Context.new
+      error.log = Error::Log.new(message, **attrs)
+
+      if backtrace
+        add_stacktrace error, :log, backtrace
+      end
+
+      add_current_transaction_fields error, Hoss.current_transaction
+
+      error
+    end
+
+    private
+
+    def add_stacktrace(error, kind, backtrace)
+      stacktrace =
+        @agent.stacktrace_builder.build(backtrace, type: :error)
+      return unless stacktrace
+
+      case kind
+      when :exception
+        error.exception.stacktrace = stacktrace
+      when :log
+        error.log.stacktrace = stacktrace
+      end
+
+      error.culprit = stacktrace.frames.first&.function
+    end
+
+    def add_current_transaction_fields(error, transaction)
+      return unless transaction
+
+      error.transaction_id = transaction.id
+      error.transaction = {
+        sampled: transaction.sampled?,
+        type: transaction.type
+      }
+      error.trace_id = transaction.trace_id
+      error.parent_id = Hoss.current_span&.id || transaction.id
+
+      return unless transaction.context
+
+      Util.reverse_merge!(error.context.labels, transaction.context.labels)
+      Util.reverse_merge!(error.context.custom, transaction.context.custom)
+    end
+  end
+end

data/lib/hoss/event.rb

@@ -0,0 +1,131 @@
+# 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/span/context'
+
+module Hoss
+  # @api private
+  class Event
+    extend Forwardable
+    include ChildDurations::Methods
+
+    DEFAULT_TYPE = 'custom'
+
+    class Request
+      extend Forwardable
+      def initialize
+        @headers = {}
+      end
+      attr_accessor(
+        :method,
+        :url,
+        :headers,
+        :body,
+        :received_at
+      )
+    end
+
+    class Response
+      extend Forwardable
+      def initialize
+        @headers = {}
+      end
+      attr_accessor(
+        :status_code,
+        :headers,
+        :body,
+        :received_at
+      )
+    end
+
+    class Error
+      extend Forwardable
+      ConnectionTimeout = 'CONNECTION_TIMEOUT'
+      RequestTimeout = 'REQUEST_TIMEOUT'
+      ConnectionError = 'CONNECTION_ERROR'
+      def initialize(type)
+        @type = type
+      end
+      attr_accessor(
+        :type,
+        :received_at
+      )
+    end
+
+    # rubocop:disable Metrics/ParameterLists
+    def initialize
+      @id = SecureRandom.uuid
+      @request = Request.new
+      # @response = Response.new
+      @filtered = false
+      @retries = 0
+    end
+    # rubocop:enable Metrics/ParameterLists
+
+    attr_accessor(
+      :request,
+      :response,
+      :error,
+      :filtered,
+      :retries,
+    )
+
+    attr_reader(
+      :id
+    )
+
+    # life cycle
+
+    def start(clock_start = Util.monotonic_micros)
+      @timestamp = Util.micros
+      @clock_start = clock_start
+      self
+    end
+
+    def stop(clock_end = Util.monotonic_micros)
+      @duration ||= (clock_end - @clock_start)
+      @self_time = @duration - child_durations.duration
+      self
+    end
+
+    def done(clock_end: Util.monotonic_micros)
+      stop clock_end
+      self
+    end
+
+    def stopped?
+      !!duration
+    end
+
+    def started?
+      !!timestamp
+    end
+
+    def running?
+      started? && !stopped?
+    end
+
+    # relations
+
+    def inspect
+      "<Hoss::Event id:#{id.inspect}" \
+        '>'
+    end
+  end
+end