hoss-agent 1.0.1

data/lib/hoss/agent.rb

@@ -0,0 +1,231 @@
+# 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/error'
+
+require 'hoss/context_builder'
+require 'hoss/error_builder'
+require 'hoss/stacktrace_builder'
+
+require 'hoss/central_config'
+require 'hoss/transport/base'
+
+require 'hoss/spies'
+
+module Hoss
+  # @api private
+  class Agent
+    include Logging
+    extend Forwardable
+
+    LOCK = Mutex.new
+
+    # life cycle
+
+    def self.instance # rubocop:disable Style/TrivialAccessors
+      @instance
+    end
+
+    def self.start(config)
+      return @instance if @instance
+
+      config = Config.new(config) unless config.is_a?(Config)
+
+      LOCK.synchronize do
+        return @instance if @instance
+
+        unless config.enabled?
+          config.logger.debug format(
+            "%sAgent disabled with `enabled: false'",
+            Logging::PREFIX
+          )
+          return
+        end
+
+        @instance = new(config).start
+      end
+    end
+
+    def self.stop
+      LOCK.synchronize do
+        return unless @instance
+
+        @instance.stop
+        @instance = nil
+      end
+    end
+
+    def self.running?
+      !!@instance
+    end
+
+    def initialize(config)
+      @stacktrace_builder = StacktraceBuilder.new(config)
+      @context_builder = ContextBuilder.new(config)
+      @error_builder = ErrorBuilder.new(self)
+
+      @central_config = CentralConfig.new(config)
+      @transport = Transport::Base.new(config)
+      @instrumenter = Instrumenter.new(
+        config,
+        metrics: nil,
+        stacktrace_builder: stacktrace_builder
+      ) { |event| enqueue event }
+      @pid = Process.pid
+    end
+
+    attr_reader(
+      :central_config,
+      :config,
+      :context_builder,
+      :error_builder,
+      :instrumenter,
+      :stacktrace_builder,
+      :transport
+    )
+
+    def_delegator :@central_config, :config
+
+    def start
+      unless config.disable_start_message?
+        config.logger.info format(
+          '[%s] Starting agent, reporting to %s',
+          VERSION, config.api_host
+        )
+      end
+
+      central_config.start
+      transport.start
+      instrumenter.start
+      # metrics.start
+
+      config.enabled_instrumentations.each do |lib|
+        debug "Requiring spy: #{lib}"
+        require "hoss/spies/#{lib}"
+      end
+
+      self
+    end
+
+    def stop
+      debug 'Stopping agent'
+
+      central_config.stop
+      instrumenter.stop
+      transport.stop
+
+      self
+    end
+
+    at_exit do
+      stop
+    end
+
+    # transport
+
+    def enqueue(obj)
+      transport.submit obj
+    end
+
+    def current_event
+      instrumenter.current_event
+    end
+
+    def start_event
+      detect_forking!
+      instrumenter.start_event
+    end
+
+    def end_event
+      instrumenter.end_event
+    end
+
+    def set_label(key, value)
+      instrumenter.set_label(key, value)
+    end
+
+    def set_custom_context(context)
+      instrumenter.set_custom_context(context)
+    end
+
+    def set_user(user)
+      instrumenter.set_user(user)
+    end
+
+    def build_context(rack_env:, for_type:)
+      @context_builder.build(rack_env: rack_env, for_type: for_type)
+    end
+
+    # errors
+
+    def report(exception, context: nil, handled: true)
+      return unless config.recording?
+      detect_forking!
+      return if config.filter_exception_types.include?(exception.class.to_s)
+
+      error = @error_builder.build_exception(
+        exception,
+        context: context,
+        handled: handled
+      )
+      enqueue error
+      error.id
+    end
+
+    def report_message(message, context: nil, backtrace: nil, **attrs)
+      return unless config.recording?
+      detect_forking!
+
+      error = @error_builder.build_log(
+        message,
+        context: context,
+        backtrace: backtrace,
+        **attrs
+      )
+      enqueue error
+      error.id
+    end
+
+    # filters
+
+    def add_filter(key, callback)
+      transport.add_filter(key, callback)
+    end
+
+    # misc
+
+    def inspect
+      super.split.first + '>'
+    end
+
+    def detect_forking!
+      return if @pid == Process.pid
+
+      config.logger.debug "Detected forking,
+        restarting threads in process [PID:#{Process.pid}]"
+
+      central_config.handle_forking!
+      transport.handle_forking!
+      instrumenter.handle_forking!
+      metrics.handle_forking!
+
+      @pid = Process.pid
+    end
+  end
+end

data/lib/hoss/central_config/cache_control.rb

@@ -0,0 +1,51 @@
+# 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 CentralConfig
+    # @api private
+    class CacheControl
+      def initialize(value)
+        @header = value
+        parse!(value)
+      end
+
+      attr_reader(
+        :must_revalidate,
+        :no_cache,
+        :no_store,
+        :no_transform,
+        :public,
+        :private,
+        :proxy_revalidate,
+        :max_age,
+        :s_maxage
+      )
+
+      private
+
+      def parse!(value)
+        value.split(',').each do |token|
+          k, v = token.split('=').map(&:strip)
+          instance_variable_set(:"@#{k.tr('-', '_')}", v ? v.to_i : true)
+        end
+      end
+    end
+  end
+end

data/lib/hoss/central_config.rb

@@ -0,0 +1,184 @@
+# 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/central_config/cache_control'
+
+module Hoss
+  # @api private
+  class CentralConfig
+    include Logging
+
+    # @api private
+    class ResponseError < InternalError
+      def initialize(response)
+        @response = response
+      end
+
+      attr_reader :response
+    end
+    class ClientError < ResponseError; end
+    class ServerError < ResponseError; end
+
+    def initialize(config)
+      @config = config
+      @modified_options = {}
+      @authorization = "Bearer #{@config.api_key}"
+      @http = Transport::Connection::Http.new(config)
+      @etag = 1
+    end
+
+    attr_reader :config
+    attr_reader :scheduled_task, :promise # for specs
+
+    def start
+      return unless config.central_config?
+
+      debug 'Starting CentralConfig'
+
+      fetch_and_apply_config
+    end
+
+    def stop
+      debug 'Stopping CentralConfig'
+
+      @scheduled_task&.cancel
+    end
+
+    def fetch_and_apply_config
+      @promise =
+        Concurrent::Promise
+        .execute(&method(:fetch_config))
+        .on_success(&method(:handle_success))
+        .rescue(&method(:handle_error))
+    end
+
+    def fetch_config
+      resp = perform_request
+      case resp.status
+      when 200..299
+        resp
+      when 300..399
+        resp
+      when 400..499
+        resp
+        # raise ClientError, resp
+      when 500..599
+        resp
+        # raise ServerError, resp
+      end
+    end
+
+    def assign(update)
+      # For each updated option, store the original value,
+      # unless already stored
+      update.each_key do |key|
+        @modified_options[key] ||= config.get(key.to_sym)&.value
+      end
+
+      # If the new update doesn't set a previously modified option,
+      # revert it to the original
+      @modified_options.each_key do |key|
+        next if update.key?(key)
+        update[key] = @modified_options.delete(key)
+      end
+      @config.replace_options(update)
+    end
+
+    def handle_forking!
+      stop
+      start
+    end
+
+    private
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def handle_success(resp)
+      if (etag = resp.headers['Etag'])
+        @etag = etag
+      end
+
+      if resp.status == 304
+        info 'Received 304 Not Modified'
+      else
+        if resp.body && !resp.body.empty?
+          update = JSON.parse(resp.body.to_s)
+          assign(update['data']) unless update.nil? or update['data'].nil?
+        end
+
+        if update && update.any?
+          info 'Updated config'
+          debug 'Modified: %s', update.inspect
+          debug 'Modified original options: %s', @modified_options.inspect
+        end
+      end
+
+      schedule_next_fetch(resp)
+
+      true
+    rescue Exception => e
+      error 'Failed to apply remote config, %s', e.inspect
+      debug e.backtrace.join('\n')
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+    def handle_error(error)
+      puts error.backtrace
+      # For tests, WebMock failures don't have real responses
+      response = error.response if error.respond_to?(:response)
+
+      debug(
+        'Failed fetching config: %s, trying again in %d seconds',
+        response&.body, @config.remote_config_fetch_interval
+      )
+
+      assign({})
+
+      schedule_next_fetch(response)
+    end
+
+    def perform_request
+      body = '{"query":"query AgentConfig {\n  agentConfig {\n    accountApiConfiguration {\n      uuid\n      hostBlacklist\n      sanitizedHeaders\n      sanitizedQueryParams\n      sanitizedBodyFields {\n        type\n        value\n      }\n      bodyCapture\n    }\n    apis {\n      uuid\n      name\n      rootDomain\n      hosts\n      configuration(mergeWithAccountConfiguration: true) {\n        uuid\n        sanitizedHeaders\n        sanitizedQueryParams\n        bodyCapture\n        sanitizedBodyFields {\n          type\n          value\n        }\n      }\n    }\n    accountRestrictions {\n      ingressDisabled\n    }\n  }\n}","operationName":"AgentConfig"}'
+      @http.post(api_host, body: body, headers: headers)
+    end
+
+    def api_host
+      @api_host ||=
+        config.api_host +
+        '/api/graphql'
+    end
+
+    def headers
+      { 'Etag': @etag, 'Authorization': @authorization, 'HOSS-SKIP-INSTRUMENTATION': true }
+    end
+
+    def schedule_next_fetch(resp = nil)
+      headers = resp&.headers
+      seconds =
+        if headers && headers['Cache-Control']
+          CacheControl.new(headers['Cache-Control']).max_age
+        else
+          @config.remote_config_fetch_interval
+        end
+
+      @scheduled_task =
+        Concurrent::ScheduledTask
+        .execute(seconds, &method(:fetch_and_apply_config))
+    end
+  end
+end

data/lib/hoss/child_durations.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
+
+module Hoss
+  # @api private
+  module ChildDurations
+    # @api private
+    module Methods
+      def child_durations
+        @child_durations ||= Durations.new
+      end
+
+      def child_started
+        child_durations.start
+      end
+
+      def child_stopped
+        child_durations.stop
+      end
+    end
+
+    # @api private
+    class Durations
+      def initialize
+        @nesting_level = 0
+        @start = nil
+        @duration = 0
+        @mutex = Mutex.new
+      end
+
+      attr_reader :duration
+
+      def start
+        @mutex.synchronize do
+          @nesting_level += 1
+          @start = Util.micros if @nesting_level == 1
+        end
+      end
+
+      def stop
+        @mutex.synchronize do
+          @nesting_level -= 1
+          @duration = (Util.micros - @start) if @nesting_level == 0
+        end
+      end
+    end
+  end
+end

data/lib/hoss/config/bytes.rb

@@ -0,0 +1,42 @@
+# 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 Config
+    # @api private
+    class Bytes
+      MULTIPLIERS = {
+        'kb' => 1024,
+        'mb' => 1024 * 1_000,
+        'gb' => 1024 * 100_000
+      }.freeze
+      REGEX = /^(\d+)(b|kb|mb|gb)?$/i.freeze
+
+      def initialize(default_unit: 'kb')
+        @default_unit = default_unit
+      end
+
+      def call(value)
+        _, amount, unit = REGEX.match(String(value)).to_a
+        unit ||= @default_unit
+        MULTIPLIERS.fetch(unit.downcase, 1) * amount.to_i
+      end
+    end
+  end
+end

data/lib/hoss/config/duration.rb

@@ -0,0 +1,40 @@
+# 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 Config
+    # @api private
+    class Duration
+      MULTIPLIERS = { 'ms' => 0.001, 'm' => 60 }.freeze
+      REGEX = /^(-)?(\d+)(m|ms|s)?$/i.freeze
+
+      def initialize(default_unit: 's')
+        @default_unit = default_unit
+      end
+
+      def call(str)
+        _, negative, amount, unit = REGEX.match(String(str)).to_a
+        unit ||= @default_unit
+        seconds = MULTIPLIERS.fetch(unit.downcase, 1) * amount.to_i
+        seconds = 0 - seconds if negative
+        seconds
+      end
+    end
+  end
+end