hoss-agent 1.0.1

data/lib/hoss/config/options.rb

@@ -0,0 +1,154 @@
+# 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
+    module Options
+      # @api private
+      class Option
+        def initialize(
+          key,
+          value: nil,
+          type: :string,
+          default: nil,
+          converter: nil
+        )
+          @key = key
+          @type = type
+          @default = default
+          @converter = converter
+
+          set(value || default)
+        end
+
+        attr_reader :key, :value, :default, :type
+
+        def set(value)
+          @value = normalize(value)
+        end
+
+        def env_key
+          "HOSS_#{key.upcase}"
+        end
+
+        private
+
+        # rubocop:disable Metrics/CyclomaticComplexity
+        def normalize(val)
+          return if val.nil?
+
+          if @converter
+            return @converter.call(val)
+          end
+
+          case type
+          when :string then val.to_s
+          when :int then val.to_i
+          when :float then val.to_f
+          when :bool then normalize_bool(val)
+          when :list then normalize_list(val)
+          when :dict then normalize_dict(val)
+          when :url then normalize_url(val)
+          else
+            # raise "Unknown options type '#{type.inspect}'"
+            val
+          end
+        end
+        # rubocop:enable Metrics/CyclomaticComplexity
+
+        def normalize_bool(val)
+          return val unless val.is_a?(String)
+          !%w[0 false].include?(val.strip.downcase)
+        end
+
+        def normalize_list(val)
+          return Array(val) unless val.is_a?(String)
+          val.split(/[ ,]/)
+        end
+
+        def normalize_dict(val)
+          return val unless val.is_a?(String)
+          Hash[val.split(/[&,]/).map { |kv| kv.split('=') }]
+        end
+
+        def normalize_url(val)
+          val = val.to_s
+          val.end_with?('/') ? val.chomp('/') : val
+        end
+      end
+
+      # @api private
+      module ClassMethods
+        def schema
+          @schema ||= {}
+        end
+
+        def option(key, **args)
+          schema[key] = args
+        end
+      end
+
+      # @api private
+      module InstanceMethods
+        def load_schema
+          Hash[self.class.schema.map do |key, args|
+            [key, Option.new(key, **args)]
+          end]
+        end
+
+        def method_missing(name, *value)
+          name_str = name.to_s
+
+          if name_str.end_with?('=')
+            key = name_str[0...-1].to_sym
+            set(key, value.first)
+
+          elsif name_str.end_with?('?')
+            key = name_str[0...-1].to_sym
+            options.key?(key) ? options[key].value : super
+
+          elsif options.key?(name)
+            options.fetch(name).value
+
+          else
+            super
+          end
+        end
+
+        def [](key)
+          options[key]
+        end
+        alias :get :[]
+
+        def set(key, value)
+          options.fetch(key.to_sym).set(value)
+        rescue KeyError
+          warn format("Unknown option '%s'", key)
+          nil
+        end
+      end
+
+      def self.extended(kls)
+        kls.instance_eval { extend ClassMethods }
+        kls.class_eval { include InstanceMethods }
+      end
+    end
+  end
+end

data/lib/hoss/config/regexp_list.rb

@@ -0,0 +1,30 @@
+# 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 RegexpList
+      def call(value)
+        value = value.is_a?(String) ? value.split(',') : Array(value)
+        value.map(&Regexp.method(:new))
+      end
+    end
+  end
+end

data/lib/hoss/config/wildcard_pattern_list.rb

@@ -0,0 +1,54 @@
+# 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 WildcardPatternList
+      # @api private
+      class WildcardPattern
+        def initialize(str)
+          @pattern = convert(str)
+        end
+
+        def match?(other)
+          !!@pattern.match(other)
+        end
+
+        alias :match :match?
+
+        private
+
+        def convert(str)
+          parts =
+            str.chars.each_with_object([]) do |char, arr|
+              arr << (char == '*' ? '.*' : Regexp.escape(char))
+            end
+
+          Regexp.new('\A' + parts.join + '\Z', Regexp::IGNORECASE)
+        end
+      end
+
+      def call(value)
+        value = value.is_a?(String) ? value.split(',') : Array(value)
+        value.map(&WildcardPattern.method(:new))
+      end
+    end
+  end
+end

data/lib/hoss/config.rb

@@ -0,0 +1,304 @@
+# 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/config/options'
+require 'hoss/config/duration'
+require 'hoss/config/bytes'
+require 'hoss/config/regexp_list'
+require 'hoss/config/wildcard_pattern_list'
+
+module Hoss
+  # @api private
+  class Config
+    extend Options
+
+    DEPRECATED_OPTIONS = %i[].freeze
+
+    # rubocop:disable Metrics/LineLength, Layout/ExtraSpacing
+    option :config_file,                       type: :string, default: 'config/hoss.yml'
+    option :api_host,                          type: :url,    default: ENV['HOSS_API_HOST'] || 'https://app.hoss.com'
+    option :api_key,                           type: :string
+    option :ingress_host,                      type: :string, default: ENV['HOSS_INGRESS_HOST'] || 'https://ingress.hoss.com/v1'
+    option :max_queue_size,                    type: :int,    default: 3000
+    option :batch_size,                        type: :int,    default: ENV['HOSS_BATCH_SIZE'] || 512000
+    option :max_event_retries,                 type: :int,    default: 100
+    option :remote_config_fetch_interval,      type: :int,    default: 300
+    option :agentConfig,                       type: :dict
+
+
+    option :central_config,                    type: :bool,   default: true
+    option :capture_body,                      type: :string, default: 'off'
+    option :capture_headers,                   type: :bool,   default: true
+    option :capture_env,                       type: :bool,   default: true
+    option :current_user_email_method,         type: :string, default: 'email'
+    option :current_user_id_method,            type: :string, default: 'id'
+    option :current_user_username_method,      type: :string, default: 'username'
+    option :custom_key_filters,                type: :list,   default: [],      converter: RegexpList.new
+    option :default_labels,                    type: :dict,   default: {}
+    option :disable_start_message,             type: :bool,   default: false
+    option :disable_instrumentations,          type: :list,   default: %w[]
+    option :enabled,                           type: :bool,   default: true
+    option :environment,                       type: :string, default: ENV['RAILS_ENV'] || ENV['RACK_ENV']
+    option :framework_name,                    type: :string
+    option :framework_version,                 type: :string
+    option :filter_exception_types,            type: :list,   default: []
+    option :global_labels,                     type: :dict
+    option :hostname,                          type: :string
+    option :http_compression,                  type: :bool,   default: true
+    option :instrument,                        type: :bool,   default: true
+    option :log_level,                         type: :int,    default: Logger::DEBUG
+    option :log_path,                          type: :string, default: '-'
+    option :pool_size,                         type: :int,    default: 1
+    option :proxy_address,                     type: :string
+    option :proxy_headers,                     type: :dict
+    option :proxy_password,                    type: :string
+    option :proxy_port,                        type: :int
+    option :proxy_username,                    type: :string
+    option :recording,                         type: :bool,   default: true
+    option :sanitize_field_names,              type: :list,   default: [],      converter: WildcardPatternList.new
+    option :server_ca_cert,                    type: :string
+    option :service_name,                      type: :string
+    option :service_node_name,                 type: :string
+    option :service_version,                   type: :string
+    option :span_frames_min_duration,          type: :float,  default: '5ms',   converter: Duration.new(default_unit: 'ms')
+    option :stack_trace_limit,                 type: :int,    default: 999_999
+    option :verify_server_cert,                type: :bool,   default: true
+
+    # rubocop:enable Metrics/LineLength, Layout/ExtraSpacing
+    def initialize(options = {})
+      @options = load_schema
+
+      if options.is_a? String
+        assign(api_key: options)
+      else
+        assign(options)
+      end
+
+      # Pick out config_file specifically as we need it now to load it,
+      # but still need the other env vars to have precedence
+      env = load_env
+      if (env_config_file = env.delete(:config_file))
+        self.config_file = env_config_file
+      end
+
+      assign(load_config_file)
+      assign(env)
+
+      warn '[HOSS] No API Key provided' unless self.api_key
+
+      yield self if block_given?
+
+      self.logger ||= build_logger
+
+      @__view_paths ||= []
+      @__root_path ||= Dir.pwd
+    end
+
+    attr_accessor :__view_paths, :__root_path
+    attr_accessor :logger
+
+    attr_reader :options
+
+    def assign(update)
+      return unless update
+      update.each { |key, value| send(:"#{key}=", value) }
+    end
+
+    def available_instrumentations
+      %w[
+        http
+        net_http
+        faraday
+      ]
+    end
+
+    def enabled_instrumentations
+      available_instrumentations - disable_instrumentations
+    end
+
+    def method_missing(name, *args)
+      return super unless DEPRECATED_OPTIONS.include?(name)
+      warn "The option `#{name}' has been removed."
+    end
+
+    def replace_options(new_options)
+      return if new_options.nil? || new_options.empty?
+      options_copy = @options.dup
+      new_options.each do |key, value|
+        options_copy.fetch(key.to_sym).set(value)
+      end
+      @options = options_copy
+    end
+
+    def app=(app)
+      case app_type?(app)
+      when :sinatra
+        set_sinatra(app)
+      when :rails
+        set_rails(app)
+      else
+        self.service_name = 'ruby'
+      end
+    end
+
+    def use_ssl?
+      api_host.start_with?('https')
+    end
+
+    def span_frames_min_duration?
+      span_frames_min_duration != 0
+    end
+
+    def span_frames_min_duration=(value)
+      super
+      @span_frames_min_duration_us = nil
+    end
+
+    def span_frames_min_duration_us
+      @span_frames_min_duration_us ||= span_frames_min_duration * 1_000_000
+    end
+
+    def ssl_context
+      return unless use_ssl?
+
+      @ssl_context ||=
+        OpenSSL::SSL::SSLContext.new.tap do |context|
+          if server_ca_cert
+            context.ca_file = server_ca_cert
+          else
+            context.cert_store =
+              OpenSSL::X509::Store.new.tap(&:set_default_paths)
+          end
+
+          context.verify_mode =
+            if verify_server_cert
+              OpenSSL::SSL::VERIFY_PEER
+            else
+              OpenSSL::SSL::VERIFY_NONE
+            end
+        end
+    end
+
+    def inspect
+      super.split.first + '>'
+    end
+
+    # Deprecations
+
+    def default_tags=(value)
+      warn '[DEPRECATED] The option default_tags has been renamed to ' \
+        'default_labels.'
+      self.default_labels = value
+    end
+
+    def custom_key_filters=(value)
+      unless value == self.class.schema[:custom_key_filters][:default]
+        warn '[DEPRECATED] The option custom_key_filters is being removed. ' \
+          'See sanitize_field_names for an alternative.'
+      end
+
+      set(:custom_key_filters, value)
+    end
+
+    def disabled_instrumentations
+      disable_instrumentations
+    end
+
+    def active
+      enabled
+    end
+    alias active? active
+
+    def disabled_instrumentations=(value)
+      warn '[DEPRECATED] The option disabled_instrumentations has been ' \
+        'renamed to disable_instrumentations to align with other agents.'
+      self.disable_instrumentations = value
+    end
+
+    def active=(value)
+      warn '[DEPRECATED] The option active has been renamed to enabled ' \
+        'to align with other agents and with the remote config.'
+      self.enabled = value
+    end
+
+    private
+
+    def load_config_file
+      filename = File.join(@__root_path || Dir.pwd, config_file)
+      return unless File.exist?(filename)
+      read = File.read(filename)
+      evaled = ERB.new(read).result
+      YAML.safe_load(evaled)
+    end
+
+    def load_env
+      @options.values.each_with_object({}) do |option, opts|
+        next unless (value = ENV[option.env_key])
+        opts[option.key] = value
+      end
+    end
+
+    def build_logger
+      Logger.new(log_path == '-' ? STDOUT : log_path).tap do |logger|
+        logger.level = log_level
+      end
+    end
+
+    def app_type?(app)
+      if defined?(::Rails::Application) && app.is_a?(::Rails::Application)
+        return :rails
+      end
+
+      if app.is_a?(Class) && app.superclass.to_s == 'Sinatra::Base'
+        return :sinatra
+      end
+
+      nil
+    end
+
+    def set_sinatra(app)
+      self.service_name = format_name(service_name || app.to_s)
+      self.framework_name = framework_name || 'Sinatra'
+      self.framework_version = framework_version || ::Sinatra::VERSION
+      self.__root_path = Dir.pwd
+    end
+
+    def set_rails(app)
+      self.service_name ||= format_name(service_name || rails_app_name(app))
+      self.framework_name ||= 'Ruby on Rails'
+      self.framework_version ||= ::Rails::VERSION::STRING
+      self.logger ||= ::Rails.logger
+
+      self.__root_path = ::Rails.root.to_s
+      self.__view_paths = app.config.paths['app/views'].existent
+    end
+
+    def rails_app_name(app)
+      if ::Rails::VERSION::MAJOR >= 6
+        app.class.module_parent_name
+      else
+        app.class.parent_name
+      end
+    end
+
+    def format_name(str)
+      str&.gsub('::', '_')
+    end
+  end
+end

data/lib/hoss/context/request/socket.rb

@@ -0,0 +1,36 @@
+# 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 Context
+    # @api private
+    class Request
+      # @api private
+      class Socket
+        def initialize(req)
+          @remote_addr = req.env['REMOTE_ADDR']
+          @encrypted = req.scheme == 'https'
+        end
+
+        attr_reader :remote_addr, :encrypted
+      end
+    end
+  end
+end

data/lib/hoss/context/request/url.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
+  # @api private
+  class Context
+    # @api private
+    class Request
+      # @api private
+      class Url
+        SKIPPED_PORTS = {
+          'http' => 80,
+          'https' => 443
+        }.freeze
+
+        def initialize(req)
+          @protocol = req.scheme
+          @hostname = req.host
+          @port = req.port.to_s
+          @pathname = req.path
+          @search = req.query_string
+          @hash = nil
+          @full = build_full_url req
+        end
+
+        attr_reader :protocol, :hostname, :port, :pathname, :search, :hash,
+          :full
+
+        private
+
+        def build_full_url(req)
+          url = "#{req.scheme}://#{req.host}"
+
+          if req.port != SKIPPED_PORTS[req.scheme]
+            url += ":#{req.port}"
+          end
+
+          url + req.fullpath
+        end
+      end
+    end
+  end
+end

data/lib/hoss/context/request.rb

@@ -0,0 +1,28 @@
+# 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 Request
+      attr_accessor :body, :cookies, :env, :headers, :http_version, :method,
+        :socket, :url
+    end
+  end
+end