hoss-agent 1.0.1

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'

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: hoss-agent
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Cameron Cooper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- cameron@hoss.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE/Bug_report.md"
+- ".github/ISSUE_TEMPLATE/Feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".gitignore"
+- ".rspec"
+- Dockerfile
+- Gemfile
+- LICENSE
+- hoss-agent.gemspec
+- lib/hoss-agent.rb
+- lib/hoss.rb
+- lib/hoss/agent.rb
+- lib/hoss/central_config.rb
+- lib/hoss/central_config/cache_control.rb
+- lib/hoss/child_durations.rb
+- lib/hoss/config.rb
+- lib/hoss/config/bytes.rb
+- lib/hoss/config/duration.rb
+- lib/hoss/config/options.rb
+- lib/hoss/config/regexp_list.rb
+- lib/hoss/config/wildcard_pattern_list.rb
+- lib/hoss/context.rb
+- lib/hoss/context/request.rb
+- lib/hoss/context/request/socket.rb
+- lib/hoss/context/request/url.rb
+- lib/hoss/context/response.rb
+- lib/hoss/context/user.rb
+- lib/hoss/context_builder.rb
+- lib/hoss/deprecations.rb
+- lib/hoss/error.rb
+- lib/hoss/error/exception.rb
+- lib/hoss/error/log.rb
+- lib/hoss/error_builder.rb
+- lib/hoss/event.rb
+- lib/hoss/instrumenter.rb
+- lib/hoss/internal_error.rb
+- lib/hoss/logging.rb
+- lib/hoss/metadata.rb
+- lib/hoss/metadata/process_info.rb
+- lib/hoss/metadata/service_info.rb
+- lib/hoss/metadata/system_info.rb
+- lib/hoss/metadata/system_info/container_info.rb
+- lib/hoss/naively_hashable.rb
+- lib/hoss/rails.rb
+- lib/hoss/railtie.rb
+- lib/hoss/report.rb
+- lib/hoss/sinatra.rb
+- lib/hoss/spies.rb
+- lib/hoss/spies/faraday.rb
+- lib/hoss/spies/http.rb
+- lib/hoss/spies/net_http.rb
+- lib/hoss/stacktrace.rb
+- lib/hoss/stacktrace/frame.rb
+- lib/hoss/stacktrace_builder.rb
+- lib/hoss/transport/base.rb
+- lib/hoss/transport/connection.rb
+- lib/hoss/transport/connection/http.rb
+- lib/hoss/transport/connection/proxy_pipe.rb
+- lib/hoss/transport/filters.rb
+- lib/hoss/transport/filters/hash_sanitizer.rb
+- lib/hoss/transport/filters/secrets_filter.rb
+- lib/hoss/transport/headers.rb
+- lib/hoss/transport/serializers.rb
+- lib/hoss/transport/serializers/context_serializer.rb
+- lib/hoss/transport/serializers/error_serializer.rb
+- lib/hoss/transport/serializers/event_serializer.rb
+- lib/hoss/transport/serializers/metadata_serializer.rb
+- lib/hoss/transport/serializers/report_serializer.rb
+- lib/hoss/transport/user_agent.rb
+- lib/hoss/transport/worker.rb
+- lib/hoss/util.rb
+- lib/hoss/util/inflector.rb
+- lib/hoss/util/lru_cache.rb
+- lib/hoss/util/throttle.rb
+- lib/hoss/version.rb
+homepage: https://hoss.com/
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/hossapp/ruby-agent
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: The official Hoss SDK for Ruby
+test_files: []