txlemetry-rails 4.0.0

data/lib/txlemetry/rails.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'txlemetry/rails/version'
+require 'txlemetry/rails/configuration'
+require 'txlemetry/rails/tracing_headers'
+require 'txlemetry/rails/request_metadata'
+require 'txlemetry/rails/request_context'
+require 'txlemetry/rails/capture_exceptions'
+require 'txlemetry/rails/rescued_exception_interceptor'
+require 'txlemetry/rails/active_job'
+require 'txlemetry/rails/error_subscriber'
+require 'txlemetry/rails/logs/severity'
+require 'txlemetry/rails/logs/rate_limiter'
+require 'txlemetry/rails/logs/appender'
+require 'txlemetry/rails/logs/setup'
+require 'txlemetry/rails/facade'
+require 'txlemetry/rails/railtie'
+
+module Txlemetry
+  module Rails
+    # Thread-local key for tracking web request context
+    IN_WEB_REQUEST_KEY = :txlemetry_in_web_request
+    ACTIVE_JOB_CAPTURED_EXCEPTION_IVAR = :@txlemetry_active_job_exception_captured
+    WEB_CAPTURED_EXCEPTION_IVAR = :@txlemetry_web_exception_captured
+
+    private_constant :ACTIVE_JOB_CAPTURED_EXCEPTION_IVAR
+    private_constant :WEB_CAPTURED_EXCEPTION_IVAR
+
+    class << self
+      # @return [Txlemetry::Rails::Configuration] Rails integration configuration.
+      def config
+        @config ||= Configuration.new
+      end
+
+      # @param config [Txlemetry::Rails::Configuration] Rails integration configuration.
+      attr_writer :config
+
+      # Configure Rails integration options.
+      #
+      # @yieldparam config [Txlemetry::Rails::Configuration]
+      # @return [void]
+      def configure
+        yield config if block_given?
+      end
+
+      # Mark that we're in a web request context
+      # CaptureExceptions middleware will handle exception capture
+      # @api private
+      # @return [void]
+      def enter_web_request
+        Thread.current[IN_WEB_REQUEST_KEY] = true
+      end
+
+      # Clear web request context (called at end of request)
+      # @api private
+      # @return [void]
+      def exit_web_request
+        Thread.current[IN_WEB_REQUEST_KEY] = false
+      end
+
+      # Check if we're currently in a web request context
+      # Used by ErrorSubscriber to avoid duplicate captures
+      # @api private
+      # @return [Boolean]
+      def in_web_request?
+        Thread.current[IN_WEB_REQUEST_KEY] == true
+      end
+
+      # Mark an exception as already captured by the ActiveJob integration.
+      # Used by ErrorSubscriber to avoid duplicate captures when Rails reports
+      # the same re-raised job exception via Rails.error.
+      # @api private
+      # @param exception [Exception]
+      # @return [void]
+      def mark_active_job_exception_captured(exception)
+        exception.instance_variable_set(ACTIVE_JOB_CAPTURED_EXCEPTION_IVAR, true)
+      rescue StandardError
+        nil
+      end
+
+      # Check whether an exception was already captured by ActiveJobExtensions.
+      # @api private
+      # @param exception [Exception]
+      # @return [Boolean]
+      def active_job_exception_captured?(exception)
+        exception.instance_variable_get(ACTIVE_JOB_CAPTURED_EXCEPTION_IVAR) == true
+      rescue StandardError
+        false
+      end
+
+      # Mark an exception as already captured by the CaptureExceptions middleware.
+      #
+      # ActionDispatch::Executor sits above our middleware and reports unhandled
+      # exceptions to Rails.error *after* the response has unwound back through
+      # CaptureExceptions, so `in_web_request?` is already false by then. The mark
+      # lets ErrorSubscriber recognize the report as a duplicate.
+      #
+      # The whole cause chain is marked because ActionDispatch::ExceptionWrapper
+      # unwraps ActionView::Template::Error to its cause, meaning Rails can report
+      # a different object than the one the middleware captured.
+      # @api private
+      # @param exception [Exception]
+      # @return [void]
+      def mark_web_exception_captured(exception)
+        current = exception
+        seen = {}.compare_by_identity
+
+        while current.is_a?(Exception) && !seen[current]
+          seen[current] = true
+          current.instance_variable_set(WEB_CAPTURED_EXCEPTION_IVAR, true)
+          current = current.cause
+        end
+      rescue StandardError
+        nil
+      end
+
+      # Check whether an exception was already captured by CaptureExceptions.
+      # @api private
+      # @param exception [Exception]
+      # @return [Boolean]
+      def web_exception_captured?(exception)
+        exception.instance_variable_get(WEB_CAPTURED_EXCEPTION_IVAR) == true
+      rescue StandardError
+        false
+      end
+    end
+  end
+end
+
+Txlemetry::Rails.install_txlemetry_facade!

data/lib/txlemetry-rails.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+unless defined?(Rails)
+  raise LoadError, 'txlemetry-rails requires Rails. Use the txlemetry-ruby gem directly for non-Rails applications.'
+end
+
+# Load core Txlemetry Ruby SDK
+require 'txlemetry'
+
+# Load Rails integration
+require 'txlemetry/rails'

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: txlemetry-rails
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: ruby
+authors:
+- Txlemetry
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: txlemetry-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: Automatic exception tracking and instrumentation for Ruby on Rails applications
+  using Txlemetry
+email: support@txlemetry.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- NOTICE
+- lib/generators/txlemetry/install_generator.rb
+- lib/generators/txlemetry/templates/txlemetry.rb
+- lib/txlemetry-rails.rb
+- lib/txlemetry/rails.rb
+- lib/txlemetry/rails/active_job.rb
+- lib/txlemetry/rails/capture_exceptions.rb
+- lib/txlemetry/rails/configuration.rb
+- lib/txlemetry/rails/error_subscriber.rb
+- lib/txlemetry/rails/facade.rb
+- lib/txlemetry/rails/logs/appender.rb
+- lib/txlemetry/rails/logs/rate_limiter.rb
+- lib/txlemetry/rails/logs/setup.rb
+- lib/txlemetry/rails/logs/severity.rb
+- lib/txlemetry/rails/parameter_filter.rb
+- lib/txlemetry/rails/railtie.rb
+- lib/txlemetry/rails/request_context.rb
+- lib/txlemetry/rails/request_metadata.rb
+- lib/txlemetry/rails/rescued_exception_interceptor.rb
+- lib/txlemetry/rails/tracing_headers.rb
+- lib/txlemetry/rails/version.rb
+homepage: https://txlemetry.com
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Txlemetry integration for Rails
+test_files: []