otel_beacon 0.1.0

data/lib/otel_beacon.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require "active_support"
+require "active_support/core_ext/module/attribute_accessors"
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/otel_beacon/rails")
+loader.ignore("#{__dir__}/otel_beacon/integrations")
+loader.setup
+
+module OtelBeacon
+  extend self
+
+  mattr_accessor :logger, default: nil
+  mattr_accessor :service_name, default: ENV.fetch("OTEL_SERVICE_NAME") { ENV.fetch("SERVICE_NAME", "ruby_app") }
+  mattr_accessor :service_version, default: ENV.fetch("APP_VERSION", "0.0.0")
+  mattr_accessor :environment, default: ENV.fetch("RAILS_ENV") { ENV.fetch("RACK_ENV", "development") }
+  mattr_accessor :enabled, default: true
+  mattr_accessor :capture_exceptions, default: true
+  mattr_accessor :capture_logs, default: true
+  mattr_accessor :sanitize_fields, default: %w[password token secret key auth credential api_key access_token]
+  mattr_accessor :max_breadcrumbs, default: 50
+  mattr_accessor :max_stacktrace_lines, default: 20
+  mattr_accessor :before_capture, default: nil
+  mattr_accessor :before_breadcrumb, default: nil
+  mattr_accessor :current_user_method, default: :current_user
+  mattr_accessor :user_attributes, default: { id: :id, email: :email, username: %i[username name] }
+  mattr_accessor :on_thread_error, default: nil
+
+  def enabled? = enabled
+  def capture_exceptions? = capture_exceptions
+  def capture_logs? = capture_logs
+
+  def instrument(channel, **options, &block)
+    ActiveSupport::Notifications.instrument("#{channel}.otel_beacon", **options, &block)
+  end
+
+  def config
+    self
+  end
+
+  def sanitize_pattern
+    @sanitize_pattern ||= Regexp.new(sanitize_fields.join("|"), Regexp::IGNORECASE)
+  end
+
+  def reset_sanitize_pattern!
+    @sanitize_pattern = nil
+  end
+
+  def extract_user_attributes(user)
+    return {} unless user
+
+    result = {}
+    user_attributes.each do |key, methods|
+      methods = [ methods ] unless methods.is_a?(Array)
+      value = methods.lazy.filter_map { |m| safe_send(user, m) }.first
+      result[key] = value if value
+    end
+    result
+  end
+
+  def resolve_current_user(context = nil)
+    return nil unless current_user_method
+
+    case current_user_method
+    when Proc
+      current_user_method.call(context)
+    when String
+      resolve_string_method(current_user_method)
+    when Symbol
+      resolve_symbol_method(current_user_method, context)
+    end
+  rescue StandardError
+    nil
+  end
+
+  def reset_context!
+    Client.reset_context!
+  end
+
+  def set_user(...)
+    Client.set_user(...)
+  end
+
+  def set_tags(...)
+    Client.set_tags(...)
+  end
+
+  def set_extra(...)
+    Client.set_extra(...)
+  end
+
+  def set_context(...)
+    Client.set_context(...)
+  end
+
+  def set_fingerprint(...)
+    Client.set_fingerprint(...)
+  end
+
+  def with_scope(&block)
+    Client.with_scope(&block)
+  end
+
+  def add_breadcrumb(...)
+    Client.add_breadcrumb(...)
+  end
+
+  def in_span(...)
+    Client.in_span(...)
+  end
+
+  def capture_message(...)
+    Client.capture_message(...)
+  end
+
+  def capture_exception(...)
+    Client.capture_exception(...)
+  end
+
+  def record_event(...)
+    Client.record_event(...)
+  end
+
+  def set_runtime_context
+    RuntimeContext.set_defaults
+  end
+
+  def flush_context_to_span
+    Client.flush_context_to_span
+  end
+
+  class Error < StandardError; end
+
+  private
+
+  def safe_send(obj, method)
+    return nil unless obj.respond_to?(method)
+
+    obj.public_send(method)
+  rescue StandardError
+    nil
+  end
+
+  def resolve_string_method(method_string)
+    parts = method_string.split(".")
+    obj = Object.const_get(parts.first)
+    parts[1..].reduce(obj) { |o, m| o.public_send(m) }
+  rescue StandardError
+    nil
+  end
+
+  def resolve_symbol_method(method_name, context)
+    return nil unless context
+    return nil unless context.respond_to?(method_name, true)
+
+    context.send(method_name)
+  end
+end
+
+if defined?(Rails::Railtie)
+  require_relative "otel_beacon/rails/controller_methods"
+  require_relative "otel_beacon/rails/job_methods"
+  require_relative "otel_beacon/rails/mailer_methods"
+  require_relative "otel_beacon/rails/railtie"
+end
+
+loader.eager_load if defined?(Rails) && Rails.env.production?

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: otel_beacon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- BoringCache
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-api
+  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: opentelemetry-sdk
+  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: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+description: Add Sentry-like developer experience (breadcrumbs, user context, tags,
+  fingerprinting) to any OpenTelemetry backend
+email:
+- oss@boringcache.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- UPGRADING.md
+- lib/otel_beacon.rb
+- lib/otel_beacon/breadcrumb.rb
+- lib/otel_beacon/client.rb
+- lib/otel_beacon/context.rb
+- lib/otel_beacon/integrations/sidekiq.rb
+- lib/otel_beacon/log_subscriber.rb
+- lib/otel_beacon/rails/controller_methods.rb
+- lib/otel_beacon/rails/job_methods.rb
+- lib/otel_beacon/rails/logger.rb
+- lib/otel_beacon/rails/mailer_methods.rb
+- lib/otel_beacon/rails/railtie.rb
+- lib/otel_beacon/runtime_context.rb
+- lib/otel_beacon/sanitizer.rb
+- lib/otel_beacon/scope.rb
+- lib/otel_beacon/version.rb
+homepage: https://github.com/boringcache/otel_beacon
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/boringcache/otel_beacon
+  source_code_uri: https://github.com/boringcache/otel_beacon
+  changelog_uri: https://github.com/boringcache/otel_beacon/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Sentry-style error tracking and context for OpenTelemetry
+test_files: []