hoss-agent 1.0.6

data/hoss-agent.gemspec

@@ -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.
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hoss/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hoss-agent'
+  spec.version       = Hoss::VERSION
+  spec.authors       = ['Cameron Cooper']
+  spec.email         = ['cameron@hoss.com']
+
+  spec.summary       = 'The official Hoss SDK for Ruby'
+  spec.homepage      = 'https://hoss.com/'
+  spec.metadata     = { 'source_code_uri' => 'https://github.com/hossapp/ruby-agent' }
+  spec.license       = 'Apache-2.0'
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.add_dependency('concurrent-ruby', '~> 1.0')
+  spec.add_dependency('http', '>= 3.0')
+
+  spec.require_paths = ['lib']
+end

data/lib/hoss-agent.rb

@@ -0,0 +1,210 @@
+# 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 'erb'
+require 'http'
+require 'json'
+require 'yaml'
+require 'zlib'
+require 'logger'
+require 'concurrent'
+require 'forwardable'
+require 'securerandom'
+
+require 'hoss/version'
+require 'hoss/internal_error'
+require 'hoss/logging'
+
+# Core
+require 'hoss/agent'
+require 'hoss/config'
+require 'hoss/context'
+require 'hoss/instrumenter'
+require 'hoss/util'
+
+require 'hoss/rails' if defined?(::Rails::Railtie)
+require 'hoss/sinatra' if defined?(::Sinatra)
+
+# Hoss
+module Hoss
+  class << self
+    ### Life cycle
+
+    # Starts the Hoss Agent
+    #
+    # @param config [Config] An instance of Config
+    # @return [Agent] The resulting [Agent]
+    def start(config = {})
+      Agent.start config
+    end
+
+    # Stops the Hoss Agent
+    def stop
+      Agent.stop
+    end
+
+    # Restarts the Hoss Agent using the same config or a new
+    # one, if it is provided.
+    # Starts the agent if it is not running.
+    # Stops and starts the agent if it is running.
+    def restart(config = nil)
+      config ||= agent&.config
+      stop if running?
+      start(config)
+    end
+
+    # @return [Boolean] Whether there's an [Agent] running
+    def running?
+      Agent.running?
+    end
+
+    # @return [Agent] Currently running [Agent] if any
+    def agent
+      Agent.instance
+    end
+
+    # Get a formatted string containing transaction, span, and trace ids.
+    # If a block is provided, the ids are yielded.
+    #
+    # @yield [String|nil, String|nil, String|nil] The transaction, span,
+    # and trace ids.
+    # @return [String] Unless block given
+    def log_ids
+      ids = []
+      ids.join(' ')
+    end
+
+    def start_event
+      agent&.start_event.tap do |event|
+      end
+    end
+
+    def end_event
+      agent&.end_event
+    end
+
+    def with_event
+      unless block_given?
+        raise ArgumentError,
+          'expected a block. Do you want `start_event\' instead?'
+      end
+
+      begin
+        event = start_event
+        yield event
+      ensure
+        end_event
+      end
+    end
+
+    def current_event
+      agent&.current_event
+    end
+
+    # rubocop:enable Metrics/ParameterLists
+
+    # Build a [Context] from a Rack `env`. The context may include information
+    # about the request, response, current user and more
+    #
+    # @param rack_env [Rack::Env] A Rack env
+    # @return [Context] The built context
+    def build_context(
+      rack_env: nil,
+      for_type: :transaction
+    )
+      agent&.build_context(rack_env: rack_env, for_type: for_type)
+    end
+
+    ### Errors
+
+    # Report and exception to APM
+    #
+    # @param exception [Exception] The exception
+    # @param context [Context] An optional [Context]
+    # @param handled [Boolean] Whether the exception was rescued
+    # @return [String] ID of the generated [Error]
+    def report(exception, context: nil, handled: true)
+      agent&.report(exception, context: context, handled: handled)
+    end
+
+    # Report a custom string error message to APM
+    #
+    # @param message [String] The message
+    # @param context [Context] An optional [Context]
+    # @return [String] ID of the generated [Error]
+    def report_message(message, context: nil, **attrs)
+      agent&.report_message(
+        message,
+        context: context,
+        backtrace: caller,
+        **attrs
+      )
+    end
+
+    ### Context
+
+    # Set a _label_ value for the current transaction
+    #
+    # @param key [String,Symbol] A key
+    # @param value [Object] A value
+    # @return [Object] The given value
+    def set_label(key, value)
+      case value
+      when TrueClass,
+           FalseClass,
+           Numeric,
+           NilClass,
+           String
+        agent&.set_label(key, value)
+      else
+        agent&.set_label(key, value.to_s)
+      end
+    end
+
+    # Provide further context for the current transaction
+    #
+    # @param custom [Hash] A hash with custom information. Can be nested.
+    # @return [Hash] The current custom context
+    def set_custom_context(custom)
+      agent&.set_custom_context(custom)
+    end
+
+    # Provide a user to the current transaction
+    #
+    # @param user [Object] An object representing a user
+    # @return [Object] Given user
+    def set_user(user)
+      agent&.set_user(user)
+    end
+
+    # Provide a filter to transform payloads before sending them off
+    #
+    # @param key [Symbol] Unique filter key
+    # @param callback [Object, Proc] A filter that responds to #call(payload)
+    # @yield [Hash] A filter. Used if provided. Otherwise using `callback`
+    # @return [Bool] true
+    def add_filter(key, callback = nil, &block)
+      if callback.nil? && !block_given?
+        raise ArgumentError, '#add_filter needs either `callback\' or a block'
+      end
+
+      agent&.add_filter(key, block || callback)
+    end
+  end
+end

data/lib/hoss.rb

@@ -0,0 +1,21 @@
+# 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
+
+# Make bundler auto-require work
+require 'hoss-agent'

data/lib/hoss/agent.rb

@@ -0,0 +1,235 @@
+# 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.api_key
+        config.logger.warn "Hoss API Key missing, not starting."
+        return
+      end
+      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