errorgap 0.7.0 → 0.9.0

data/lib/errorgap.rb

@@ -3,24 +3,34 @@
 require "securerandom"
 
 require_relative "errorgap/configuration"
+require_relative "errorgap/sanitizer"
+require_relative "errorgap/release_detector"
+require_relative "errorgap/delivery"
 require_relative "errorgap/breadcrumbs"
 require_relative "errorgap/notifier"
 require_relative "errorgap/notice"
 require_relative "errorgap/log_delivery"
+require_relative "errorgap/sign_ins"
+require_relative "errorgap/warden_hooks"
 require_relative "errorgap/transaction"
 require_relative "errorgap/span_collector"
 require_relative "errorgap/span_recorder"
 require_relative "errorgap/transacter"
 require_relative "errorgap/rack_middleware"
+require_relative "errorgap/integrations/sidekiq"
+require_relative "errorgap/integrations/active_job"
+require_relative "errorgap/integrations/net_http"
 require_relative "errorgap/version"
 
 module Errorgap
   class << self
     def configure
       yield(configuration)
+      delivery.configure(configuration)
       notifier.configure(configuration)
       transacter.configure(configuration)
       log_delivery.configure(configuration)
+      sign_ins.configure(configuration)
       @breadcrumbs = Breadcrumbs.new(configuration.max_breadcrumbs)
     end
 
@@ -32,6 +42,11 @@ module Errorgap
       @notifier ||= Notifier.new(configuration)
     end
 
+    # The shared sender behind notices, transactions, logs and sign-ins.
+    def delivery
+      @delivery ||= Delivery.new(configuration)
+    end
+
     def transacter
       @transacter ||= Transacter.new(configuration)
     end
@@ -40,6 +55,19 @@ module Errorgap
       @log_delivery ||= LogDelivery.new(configuration)
     end
 
+    def sign_ins
+      @sign_ins ||= SignIns.new(configuration)
+    end
+
+    # Report a sign-in to this app: "success", "failure", "password_reset",
+    # "mfa_failure" or "locked". Pass the request for its IP, user agent and
+    # path. Needs `config.auth_events = true`; Devise apps get this
+    # automatically from the Warden hooks.
+    def sign_in(outcome, user: nil, request: nil, ip: nil, user_agent: nil, path: nil, method: nil, sync: false)
+      sign_ins.record(outcome, user: user, request: request, ip: ip, user_agent: user_agent,
+                               path: path, method: method, sync: sync)
+    end
+
     def breadcrumbs
       @breadcrumbs ||= Breadcrumbs.new(configuration.max_breadcrumbs)
     end
@@ -49,6 +77,7 @@ module Errorgap
       if (transaction_id = current_transaction_id) && !context.key?(:transaction_id) && !context.key?("transaction_id")
         context = context.merge(transaction_id: transaction_id)
       end
+      session = user_session.merge(session || {}) if current_user
       notifier.notify(
         error,
         context: context,
@@ -60,6 +89,82 @@ module Errorgap
       )
     end
 
+    REPORTED_IVAR = :@__errorgap_reported
+    USER_KEY = :errorgap_user
+
+    # `notify`, unless this exception object was already reported: lets the
+    # Rack middleware, a job integration and the app's own rescue all see the
+    # same error without sending it more than once.
+    def notify_once(error, **options)
+      return nil if reported?(error)
+
+      mark_reported(error)
+      notify(error, **options)
+    end
+
+    def reported?(error)
+      error.instance_variable_defined?(REPORTED_IVAR)
+    rescue StandardError
+      false
+    end
+
+    def mark_reported(error)
+      error.instance_variable_set(REPORTED_IVAR, true) unless error.frozen?
+    rescue StandardError
+      nil
+    end
+
+    # Name the user the current request or job is acting for. Errors reported
+    # on this thread until `clear_user` carry it as `session.user_id` /
+    # `session.user_email`, which errorgap's user filters read.
+    def set_user(id: nil, email: nil)
+      user = {}
+      user[:id] = id.to_s unless id.nil? || id.to_s.empty?
+      user[:email] = email.to_s unless email.nil? || email.to_s.empty?
+      Thread.current[USER_KEY] = user.empty? ? nil : user
+    end
+
+    def clear_user
+      Thread.current[USER_KEY] = nil
+    end
+
+    def current_user
+      Thread.current[USER_KEY]
+    end
+
+    # Record a release with errorgap (Deploys): errors are then attributed to
+    # the deploy that shipped them. Defaults come from the configuration.
+    def track_release(version: nil, sha: nil, branch: nil, environment: nil, sync: true)
+      configuration.validate!
+      return if configuration.ignored_environment?
+
+      payload = {
+        version: version || configuration.release,
+        sha: sha || configuration.release_sha,
+        branch: branch || configuration.release_branch,
+        environment: environment || configuration.environment
+      }.compact
+      return unless payload[:version] || payload[:sha]
+
+      if sync
+        delivery.post("releases", payload)
+      else
+        delivery.enqueue("releases", payload)
+      end
+    rescue StandardError => exception
+      configuration.logger&.warn("[errorgap] release not recorded: #{exception.class}: #{exception.message}")
+      nil
+    end
+
+    # `config.track_release`: the first notice of a process records the
+    # release, so an app that never errors never calls errorgap.
+    def record_release_once
+      return if @release_recorded
+
+      @release_recorded = true
+      track_release(sync: false)
+    end
+
     # Record a diagnostic breadcrumb attached to subsequent notices.
     def add_breadcrumb(message, category: nil, metadata: nil)
       breadcrumbs.add(message, category: category, metadata: metadata)
@@ -110,7 +215,7 @@ module Errorgap
       if sync || !configuration.async
         transacter.deliver(transaction)
       else
-        register_thread(Thread.new { transacter.deliver(transaction) })
+        delivery.enqueue("transactions", transaction.to_h)
       end
     end
 
@@ -160,25 +265,38 @@ module Errorgap
       end
     end
 
-    # Join any in-flight async delivery threads. Call before process exit to
-    # avoid dropping queued notices/transactions/logs.
-    def flush
+    # Wait for queued notices, transactions and logs to be sent. Call before
+    # process exit; queued payloads are also flushed from an `at_exit` hook.
+    def flush(timeout = Delivery::FLUSH_TIMEOUT)
+      delivery.flush(timeout)
       threads = thread_mutex.synchronize do
         pending = delivery_threads.dup
         delivery_threads.clear
         pending
       end
-      threads.each { |thread| thread.join(5) }
+      threads.each { |thread| thread.join(timeout) }
       nil
     end
 
+    # Kept for callers that run their own delivery threads.
     def register_thread(thread)
-      thread_mutex.synchronize { delivery_threads << thread }
+      thread_mutex.synchronize do
+        delivery_threads.select!(&:alive?)
+        delivery_threads << thread
+      end
       thread
     end
 
     private
 
+    def user_session
+      user = current_user || {}
+      session = {}
+      session["user_id"] = user[:id] if user[:id]
+      session["user_email"] = user[:email] if user[:email]
+      session
+    end
+
     def sample_apm?
       rate = configuration.apm_sample_rate.to_f
       return true if rate >= 1.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: errorgap
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Errorgap
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-10-04 00:00:00.000000000 Z
+date: 2026-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -67,16 +67,24 @@ files:
 - lib/errorgap.rb
 - lib/errorgap/breadcrumbs.rb
 - lib/errorgap/configuration.rb
+- lib/errorgap/delivery.rb
+- lib/errorgap/integrations/active_job.rb
+- lib/errorgap/integrations/net_http.rb
+- lib/errorgap/integrations/sidekiq.rb
 - lib/errorgap/log_delivery.rb
 - lib/errorgap/notice.rb
 - lib/errorgap/notifier.rb
 - lib/errorgap/rack_middleware.rb
 - lib/errorgap/rails/railtie.rb
+- lib/errorgap/release_detector.rb
+- lib/errorgap/sanitizer.rb
+- lib/errorgap/sign_ins.rb
 - lib/errorgap/span_collector.rb
 - lib/errorgap/span_recorder.rb
 - lib/errorgap/transacter.rb
 - lib/errorgap/transaction.rb
 - lib/errorgap/version.rb
+- lib/errorgap/warden_hooks.rb
 - lib/generators/errorgap/install_generator.rb
 homepage: https://github.com/errorgaphq/errorgap-ruby
 licenses: