hoss-agent 1.0.11

data/lib/hoss/stacktrace.rb

@@ -0,0 +1,33 @@
+# 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 Stacktrace
+    attr_accessor :frames
+
+    def length
+      frames.length
+    end
+
+    def to_a
+      frames.map(&:to_h)
+    end
+  end
+end

data/lib/hoss/stacktrace/frame.rb

@@ -0,0 +1,66 @@
+# 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/naively_hashable'
+
+module Hoss
+  class Stacktrace
+    # @api private
+    class Frame
+      include NaivelyHashable
+
+      attr_accessor(
+        :abs_path,
+        :filename,
+        :function,
+        :vars,
+        :pre_context,
+        :context_line,
+        :post_context,
+        :library_frame,
+        :lineno,
+        :module,
+        :colno
+      )
+      def build_context(context_line_count)
+        return unless abs_path && context_line_count > 0
+
+        padding = (context_line_count - 1) / 2
+        from = lineno - padding - 1
+        from = 0 if from < 0
+        to = lineno + padding - 1
+        file_lines = read_lines(abs_path, from..to)
+
+        return unless file_lines
+
+        self.context_line = file_lines[padding]
+        self.pre_context  = file_lines.first(padding)
+        self.post_context = file_lines.last(padding)
+      end
+
+      private
+
+      def read_lines(path, range)
+        File.readlines(path)[range]
+      rescue Errno::ENOENT
+        nil
+      end
+    end
+  end
+end

data/lib/hoss/stacktrace_builder.rb

@@ -0,0 +1,124 @@
+# 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/frame'
+require 'hoss/util/lru_cache'
+
+module Hoss
+  # @api private
+  class StacktraceBuilder
+    JAVA_FORMAT = /^(.+)\.([^\.]+)\(([^\:]+)\:(\d+)\)$/.freeze
+    RUBY_FORMAT = /^(.+?):(\d+)(?::in `(.+?)')?$/.freeze
+
+    RUBY_VERS_REGEX = %r{ruby(/gems)?[-/](\d+\.)+\d}.freeze
+    JRUBY_ORG_REGEX = %r{org/jruby}.freeze
+
+    GEMS_PATH =
+      if defined?(Bundler) && Bundler.default_bundle_dir
+        Bundler.bundle_path.to_s
+      else
+        Gem.dir
+      end
+
+    def initialize(config)
+      @config = config
+      @cache = Util::LruCache.new(2048, &method(:build_frame))
+    end
+
+    attr_reader :config
+
+    def build(backtrace, type:)
+      Stacktrace.new.tap do |s|
+        s.frames = backtrace[0...config.stack_trace_limit].map do |line|
+          @cache[[line, type]]
+        end
+      end
+    end
+
+    private
+
+    def build_frame(cache, keys)
+      line, type = keys
+      abs_path, lineno, function, _module_name = parse_line(line)
+
+      frame = Stacktrace::Frame.new
+      frame.abs_path = abs_path
+      frame.filename = strip_load_path(abs_path)
+      frame.function = function
+      frame.lineno = lineno.to_i
+      frame.library_frame = library_frame?(config, abs_path)
+
+      line_count =
+        context_lines_for(config, type, library_frame: frame.library_frame)
+      frame.build_context line_count
+
+      cache[[line, type]] = frame
+    end
+
+    def parse_line(line)
+      ruby_match = line.match(RUBY_FORMAT)
+
+      if ruby_match
+        _, file, number, method = ruby_match.to_a
+        file.sub!(/\.class$/, '.rb')
+        module_name = nil
+      else
+        java_match = line.match(JAVA_FORMAT)
+        _, module_name, method, file, number = java_match.to_a
+      end
+
+      [file, number, method, module_name]
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def library_frame?(config, abs_path)
+      return false unless abs_path
+
+      return true if abs_path.start_with?(GEMS_PATH)
+
+      if abs_path.start_with?(config.__root_path)
+        return true if abs_path.start_with?(config.__root_path + '/vendor')
+        return false
+      end
+
+      return true if abs_path.match(RUBY_VERS_REGEX)
+      return true if abs_path.match(JRUBY_ORG_REGEX)
+
+      false
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+
+    def strip_load_path(path)
+      return nil if path.nil?
+
+      prefix =
+        $LOAD_PATH
+        .map(&:to_s)
+        .select { |s| path.start_with?(s) }
+        .max_by(&:length)
+
+      prefix ? path[prefix.chomp(File::SEPARATOR).length + 1..-1] : path
+    end
+
+    def context_lines_for(config, type, library_frame:)
+      key = "source_lines_#{type}_#{library_frame ? 'library' : 'app'}_frames"
+      config.send(key.to_sym)
+    end
+  end
+end

data/lib/hoss/transport/base.rb

@@ -0,0 +1,191 @@
+# 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/metadata'
+require 'hoss/transport/user_agent'
+require 'hoss/transport/headers'
+require 'hoss/transport/connection'
+require 'hoss/transport/worker'
+require 'hoss/transport/serializers'
+require 'hoss/transport/filters'
+require 'hoss/transport/connection/http'
+
+require 'hoss/util/throttle'
+
+module Hoss
+  module Transport
+    # @api private
+    class Base
+      include Logging
+
+      WATCHER_EXECUTION_INTERVAL = 5
+      WATCHER_TIMEOUT_INTERVAL = 4
+      WORKER_JOIN_TIMEOUT = 5
+
+      def initialize(config)
+        @config = config
+        @queue = SizedQueue.new(config.max_queue_size)
+
+        @serializers = Serializers.new(config)
+        @filters = Filters.new(config)
+
+        @stopped = Concurrent::AtomicBoolean.new
+        @workers = Array.new(config.pool_size)
+
+        @worker_mutex = Mutex.new
+      end
+
+      attr_reader :config, :queue, :filters, :workers, :watcher, :stopped
+
+      def start
+        debug '%s: Starting Transport', pid_str
+        # Set @stopped to false first, in case transport is restarted;
+        # ensure_worker_count requires @stopped to be false
+        # ~estolfo
+        @stopped.make_false unless @stopped.false?
+
+        ensure_worker_count
+        create_watcher
+      end
+
+      def stop
+        debug '%s: Stopping Transport', pid_str
+
+        @stopped.make_true
+
+        stop_watcher
+        stop_workers
+      end
+
+      def submit(resource)
+        if @stopped.true?
+          warn '%s: Transport stopping, no new events accepted', pid_str
+          debug 'Dropping: %s', resource.inspect
+          return false
+        end
+
+        queue.push(resource, true)
+
+        true
+      rescue ThreadError
+        throttled_queue_full_warning
+        nil
+      rescue Exception => e
+        error '%s: Failed adding to the transport queue: %p', pid_str, e.inspect
+        nil
+      end
+
+      def add_filter(key, callback)
+        @filters.add(key, callback)
+      end
+
+      def handle_forking!
+        # We can't just stop and start again because the StopMessage
+        # will then be the first message processed when the transport is
+        # restarted.
+        stop_watcher
+        ensure_worker_count
+        create_watcher
+      end
+
+      private
+
+      def pid_str
+        format('[PID:%s]', Process.pid)
+      end
+
+      def create_watcher
+        @watcher = Concurrent::TimerTask.execute(
+          execution_interval: WATCHER_EXECUTION_INTERVAL,
+          timeout_interval: WATCHER_TIMEOUT_INTERVAL
+        ) { ensure_worker_count }
+      end
+
+      def ensure_worker_count
+        @worker_mutex.synchronize do
+          return if all_workers_alive?
+          return if stopped.true?
+
+          @workers.map! do |thread|
+            next thread if thread&.alive?
+
+            boot_worker
+          end
+        end
+      end
+
+      def all_workers_alive?
+        !!workers.all? { |t| t&.alive? }
+      end
+
+      def boot_worker
+        debug '%s: Booting worker...', pid_str
+
+        Thread.new do
+          Worker.new(
+            config, queue,
+            serializers: @serializers,
+            filters: @filters
+          ).work_forever
+        end
+      end
+
+      def stop_workers
+        debug '%s: Stopping workers', pid_str
+
+        send_stop_messages
+
+        @worker_mutex.synchronize do
+          workers.each do |thread|
+            next if thread.nil?
+            next if thread.join(WORKER_JOIN_TIMEOUT)
+
+            debug(
+              '%s: Worker did not stop in %ds, killing...',
+              pid_str, WORKER_JOIN_TIMEOUT
+            )
+            thread.kill
+          end
+
+          # Maintain the @worker array size for when transport is restarted
+          @workers.fill(nil)
+        end
+      end
+
+      def send_stop_messages
+        config.pool_size.times { queue.push(Worker::StopMessage.new, true) }
+      rescue ThreadError
+        warn 'Cannot push stop messages to worker queue as it is full'
+      end
+
+      def stop_watcher
+        watcher&.shutdown
+      end
+
+      def throttled_queue_full_warning
+        (@queue_full_log ||= Util::Throttle.new(5) do
+          warn(
+            '%s: Queue is full (%i items), skipping…',
+            pid_str, config.max_queue_size
+          )
+        end).call
+      end
+    end
+  end
+end

data/lib/hoss/transport/connection.rb

@@ -0,0 +1,55 @@
+# 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 Transport
+    # @api private
+    class Connection
+      include Logging
+
+      def initialize(config)
+        @config = config
+        @metadata = JSON.fast_generate(
+          Serializers::MetadataSerializer.new(config).build(
+            Metadata.new(config)
+          )
+        )
+        @url = @config.ingress_host
+        @mutex = Mutex.new
+      end
+
+      attr_reader :http
+      def write(str)
+        debug "Sending report"
+        uri = URI(@url)
+        req = Net::HTTP::Post.new(
+          uri,
+          'Authorization' => "Bearer #{@config.api_key}", #"Basic " + Base64.encode64("#{@config.api_key}:"),
+          'Content-Type' => 'application/json',
+          'HOSS-SKIP-INSTRUMENTATION' => 'true',
+        )
+        req.body = str
+        res = Net::HTTP.start(uri.hostname, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+          http.request(req)
+        end
+        raise unless res.code == "200"
+      end
+    end
+  end
+end