logstruct 0.1.11 → 0.2.0

data/lib/log_struct.rb

@@ -7,6 +7,7 @@ require "log_struct/version"
 require "log_struct/enums"
 require "log_struct/configuration"
 require "log_struct/formatter"
+require "log_struct/logged_errors"
 require "log_struct/railtie"
 require "log_struct/concerns/error_handling"
 require "log_struct/concerns/configuration"
@@ -15,7 +16,7 @@ require "log_struct/concerns/logging"
 # Require integrations
 require "log_struct/integrations"
 
-# SemanticLogger integration - core feature for high-performance logging
+# SemanticLogger: the logger, formatters and setup LogStruct writes its lines with
 require "log_struct/semantic_logger/formatter"
 require "log_struct/semantic_logger/color_formatter"
 require "log_struct/semantic_logger/logger"
@@ -54,8 +55,9 @@ module LogStruct
   LogStruct::RailsBootBannerSilencer.install!
 
   # Patch Puma immediately for server runs so we can convert its lifecycle
-  # messages into structured logs reliably.
-  if ARGV.include?("server")
+  # messages into structured logs reliably. Not when LogStruct is disabled, and not
+  # when Puma isn't installed (install_patches! skips it).
+  if LogStruct.enabled? && ARGV.include?("server")
     begin
       require "log_struct/integrations/puma"
       LogStruct::Integrations::Puma.install_patches!
@@ -65,7 +67,7 @@ module LogStruct
       if defined?(::Rails) && ::Rails.respond_to?(:env) && ::Rails.env.test?
         raise e
       else
-        LogStruct.handle_exception(e, source: LogStruct::Source::Puma)
+        LogStruct.handle_exception(e, source: LogStruct::Source::Internal, context: {integration: :puma})
       end
     end
   end

data/logstruct.gemspec

@@ -15,26 +15,35 @@ Gem::Specification.new do |spec|
     "Log messages, params, and job args are automatically filtered and scrubbed to remove any sensitive info."
   spec.homepage = "https://logstruct.com"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.2.0"
+  spec.required_ruby_version = ">= 3.3.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/DocSpring/logstruct"
   spec.metadata["changelog_uri"] = "#{spec.metadata["source_code_uri"]}/blob/main/CHANGELOG.md"
 
-  # Specify which files should be added to the gem when it is released.
-  spec.files = Dir[
-    "lib/**/*",
-    "README.md",
-    "CHANGELOG.md",
-    "LICENSE",
-    "*.gemspec",
-  ]
+  # Specify which files should be added to the gem when it is released: only files committed to git, so a
+  # local build can't pick up untracked files. Without git (an unpacked gem), it falls back to Dir.
+  patterns = ["lib/**/*", "README.md", "CHANGELOG.md", "LICENSE", "*.gemspec"]
+  tracked_files = begin
+    output = IO.popen(%w[git ls-files -z], chdir: __dir__, err: File::NULL, &:read)
+    output.split("\x0") if $?.success?
+  rescue Errno::ENOENT
+    nil
+  end
+  spec.files = if tracked_files
+    tracked_files.select { |file| patterns.any? { |pattern| File.fnmatch?(pattern, file, File::FNM_PATHNAME) } }
+  else
+    Dir[*patterns].select { |file| File.file?(file) }
+  end
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "actionpack", ">= 7.1"
+  spec.add_dependency "activesupport", ">= 7.1"
+  spec.add_dependency "globalid", ">= 1.0"
   spec.add_dependency "lograge", ">= 0.11"
-  spec.add_dependency "rails", ">= 7.1"
+  spec.add_dependency "railties", ">= 7.1"
   spec.add_dependency "semantic_logger", "~> 4.15"
   spec.add_dependency "sorbet-runtime", ">= 0.5"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstruct
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.2.0
 platform: ruby
 authors:
 - DocSpring
@@ -9,6 +9,48 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: globalid
+  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: lograge
   requirement: !ruby/object:Gem::Requirement
@@ -24,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -240,13 +282,13 @@ files:
 - README.md
 - lib/log_struct.rb
 - lib/log_struct/boot_buffer.rb
-- lib/log_struct/builders/active_job.rb
 - lib/log_struct/concerns/configuration.rb
 - lib/log_struct/concerns/error_handling.rb
 - lib/log_struct/concerns/logging.rb
 - lib/log_struct/config_struct/error_handling_modes.rb
 - lib/log_struct/config_struct/filters.rb
 - lib/log_struct/config_struct/integrations.rb
+- lib/log_struct/config_struct/limits.rb
 - lib/log_struct/configuration.rb
 - lib/log_struct/enums.rb
 - lib/log_struct/enums/error_handling_mode.rb
@@ -262,6 +304,7 @@ files:
 - lib/log_struct/integrations/action_mailer.rb
 - lib/log_struct/integrations/action_mailer/error_handling.rb
 - lib/log_struct/integrations/action_mailer/event_logging.rb
+- lib/log_struct/integrations/action_mailer/fallback_error_handlers.rb
 - lib/log_struct/integrations/action_mailer/metadata_collection.rb
 - lib/log_struct/integrations/active_job.rb
 - lib/log_struct/integrations/active_job/log_subscriber.rb
@@ -273,20 +316,24 @@ files:
 - lib/log_struct/integrations/dotenv.rb
 - lib/log_struct/integrations/event_time.rb
 - lib/log_struct/integrations/good_job.rb
-- lib/log_struct/integrations/good_job/log_subscriber.rb
 - lib/log_struct/integrations/good_job/logger.rb
 - lib/log_struct/integrations/host_authorization.rb
 - lib/log_struct/integrations/integration_interface.rb
 - lib/log_struct/integrations/lograge.rb
 - lib/log_struct/integrations/puma.rb
-- lib/log_struct/integrations/rack.rb
 - lib/log_struct/integrations/rack_error_handler.rb
+- lib/log_struct/integrations/rack_error_handler/debug_exceptions_logging.rb
+- lib/log_struct/integrations/rack_error_handler/error_lines.rb
 - lib/log_struct/integrations/rack_error_handler/middleware.rb
+- lib/log_struct/integrations/rack_error_handler/parse_error_logging.rb
+- lib/log_struct/integrations/rack_middleware.rb
 - lib/log_struct/integrations/rack_setup.rb
+- lib/log_struct/integrations/rails_log_subscribers.rb
 - lib/log_struct/integrations/request_context.rb
 - lib/log_struct/integrations/request_context/middleware.rb
 - lib/log_struct/integrations/shrine.rb
 - lib/log_struct/integrations/sidekiq.rb
+- lib/log_struct/integrations/sidekiq/job_context_middleware.rb
 - lib/log_struct/integrations/sidekiq/logger.rb
 - lib/log_struct/integrations/sorbet.rb
 - lib/log_struct/log.rb
@@ -295,8 +342,12 @@ files:
 - lib/log_struct/log/action_mailer/delivery.rb
 - lib/log_struct/log/action_mailer/error.rb
 - lib/log_struct/log/active_job.rb
+- lib/log_struct/log/active_job/discard.rb
 - lib/log_struct/log/active_job/enqueue.rb
+- lib/log_struct/log/active_job/error.rb
 - lib/log_struct/log/active_job/finish.rb
+- lib/log_struct/log/active_job/retry.rb
+- lib/log_struct/log/active_job/retry_stopped.rb
 - lib/log_struct/log/active_job/schedule.rb
 - lib/log_struct/log/active_job/start.rb
 - lib/log_struct/log/active_model_serializers.rb
@@ -305,7 +356,6 @@ files:
 - lib/log_struct/log/active_storage/download.rb
 - lib/log_struct/log/active_storage/exist.rb
 - lib/log_struct/log/active_storage/metadata.rb
-- lib/log_struct/log/active_storage/stream.rb
 - lib/log_struct/log/active_storage/upload.rb
 - lib/log_struct/log/active_storage/url.rb
 - lib/log_struct/log/ahoy.rb
@@ -320,18 +370,15 @@ files:
 - lib/log_struct/log/dotenv/update.rb
 - lib/log_struct/log/error.rb
 - lib/log_struct/log/good_job.rb
-- lib/log_struct/log/good_job/enqueue.rb
 - lib/log_struct/log/good_job/error.rb
-- lib/log_struct/log/good_job/finish.rb
 - lib/log_struct/log/good_job/log.rb
-- lib/log_struct/log/good_job/schedule.rb
-- lib/log_struct/log/good_job/start.rb
 - lib/log_struct/log/interfaces/additional_data_field.rb
 - lib/log_struct/log/interfaces/common_fields.rb
 - lib/log_struct/log/interfaces/public_common_fields.rb
 - lib/log_struct/log/interfaces/request_fields.rb
 - lib/log_struct/log/plain.rb
 - lib/log_struct/log/puma.rb
+- lib/log_struct/log/puma/error.rb
 - lib/log_struct/log/puma/shutdown.rb
 - lib/log_struct/log/puma/start.rb
 - lib/log_struct/log/request.rb
@@ -346,16 +393,21 @@ files:
 - lib/log_struct/log/shrine/metadata.rb
 - lib/log_struct/log/shrine/upload.rb
 - lib/log_struct/log/sidekiq.rb
+- lib/log_struct/log/sidekiq/error.rb
+- lib/log_struct/log/sidekiq/log.rb
 - lib/log_struct/log/sql.rb
+- lib/log_struct/logged_errors.rb
 - lib/log_struct/monkey_patches/active_support/tagged_logging/formatter.rb
 - lib/log_struct/multi_error_reporter.rb
 - lib/log_struct/param_filters.rb
+- lib/log_struct/params_errors.rb
 - lib/log_struct/rails_boot_banner_silencer.rb
 - lib/log_struct/railtie.rb
 - lib/log_struct/semantic_logger/color_formatter.rb
 - lib/log_struct/semantic_logger/concerns/log_methods.rb
 - lib/log_struct/semantic_logger/formatter.rb
 - lib/log_struct/semantic_logger/logger.rb
+- lib/log_struct/semantic_logger/reopen_after_fork.rb
 - lib/log_struct/semantic_logger/setup.rb
 - lib/log_struct/shared/add_request_fields.rb
 - lib/log_struct/shared/interfaces/additional_data_field.rb
@@ -387,7 +439,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/log_struct/builders/active_job.rb

@@ -1,84 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require_relative "../log/active_job/enqueue"
-require_relative "../log/active_job/schedule"
-require_relative "../log/active_job/start"
-require_relative "../log/active_job/finish"
-
-module LogStruct
-  module Builders
-    module ActiveJob
-      extend T::Sig
-
-      sig { params(job: T.untyped).returns(T.nilable(String)) }
-      def self.safe_provider_job_id(job)
-        job.respond_to?(:provider_job_id) ? job.provider_job_id : nil
-      end
-
-      sig { params(job: T.untyped).returns(T.nilable(Integer)) }
-      def self.safe_executions(job)
-        job.respond_to?(:executions) ? job.executions : nil
-      end
-
-      sig { params(job: T.untyped).returns(T.nilable(T::Array[T.untyped])) }
-      def self.safe_arguments(job)
-        return nil unless job.class.respond_to?(:log_arguments?)
-        job.class.log_arguments? ? job.arguments : nil
-      end
-
-      sig { params(job: T.untyped).returns(Log::ActiveJob::Enqueue) }
-      def self.enqueue(job)
-        Log::ActiveJob::Enqueue.new(
-          job_id: job.job_id,
-          job_class: job.class.to_s,
-          queue_name: job.queue_name,
-          arguments: safe_arguments(job),
-          executions: safe_executions(job),
-          provider_job_id: safe_provider_job_id(job)
-        )
-      end
-
-      sig { params(job: T.untyped, scheduled_at: Time).returns(Log::ActiveJob::Schedule) }
-      def self.schedule(job, scheduled_at:)
-        Log::ActiveJob::Schedule.new(
-          job_id: job.job_id,
-          job_class: job.class.to_s,
-          queue_name: job.queue_name,
-          arguments: safe_arguments(job),
-          executions: safe_executions(job),
-          provider_job_id: safe_provider_job_id(job),
-          scheduled_at: scheduled_at
-        )
-      end
-
-      sig { params(job: T.untyped, started_at: Time, attempt: T.nilable(Integer)).returns(Log::ActiveJob::Start) }
-      def self.start(job, started_at:, attempt:)
-        Log::ActiveJob::Start.new(
-          job_id: job.job_id,
-          job_class: job.class.to_s,
-          queue_name: job.queue_name,
-          arguments: safe_arguments(job),
-          executions: safe_executions(job),
-          provider_job_id: safe_provider_job_id(job),
-          started_at: started_at,
-          attempt: attempt
-        )
-      end
-
-      sig { params(job: T.untyped, duration_ms: Float, finished_at: Time).returns(Log::ActiveJob::Finish) }
-      def self.finish(job, duration_ms:, finished_at:)
-        Log::ActiveJob::Finish.new(
-          job_id: job.job_id,
-          job_class: job.class.to_s,
-          queue_name: job.queue_name,
-          arguments: safe_arguments(job),
-          executions: safe_executions(job),
-          provider_job_id: safe_provider_job_id(job),
-          duration_ms: duration_ms,
-          finished_at: finished_at
-        )
-      end
-    end
-  end
-end

data/lib/log_struct/integrations/good_job/log_subscriber.rb

@@ -1,179 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-begin
-  require "active_support/log_subscriber"
-rescue LoadError
-  # ActiveSupport is not available, log subscriber will be skipped
-end
-
-require_relative "../../log/good_job"
-require_relative "../../enums/event"
-require_relative "../../enums/level"
-require_relative "../event_time"
-
-module LogStruct
-  module Integrations
-    module GoodJob
-      # LogSubscriber for GoodJob ActiveSupport notifications
-      #
-      # This subscriber captures GoodJob's ActiveSupport notifications and converts
-      # them into structured LogStruct::Log::GoodJob entries. It provides detailed
-      # logging for job lifecycle events, performance metrics, and error tracking.
-      #
-      # ## Supported Events:
-      # - job.enqueue - Job queued for execution
-      # - job.start - Job execution started
-      # - job.finish - Job completed successfully
-      # - job.error - Job failed with error
-      # - job.retry - Job retry initiated
-      # - job.schedule - Job scheduled for future execution
-      #
-      # ## Event Data Captured:
-      # - Job identification (ID, class, queue)
-      # - Execution context (arguments, priority, scheduled time)
-      # - Performance metrics (execution time, wait time)
-      # - Error information (class, message, backtrace)
-      # - Process and thread information
-      class LogSubscriber < ::ActiveSupport::LogSubscriber
-        extend T::Sig
-
-        # Job enqueued event
-        sig { params(event: ::ActiveSupport::Notifications::Event).void }
-        def enqueue(event)
-          payload = T.let(event.payload, T::Hash[Symbol, T.untyped])
-          job = payload[:job]
-          base_fields = build_base_fields(job, payload)
-          ts = EventTime.coerce_event_time(event.time)
-
-          logger.info(Log::GoodJob::Enqueue.new(
-            **base_fields.to_kwargs,
-            scheduled_at: (job&.scheduled_at ? Time.at(job.scheduled_at.to_i) : nil),
-            duration_ms: event.duration.to_f,
-            enqueue_caller: job&.enqueue_caller_location,
-            timestamp: ts
-          ))
-        end
-
-        # Job execution started event
-        sig { params(event: ::ActiveSupport::Notifications::Event).void }
-        def start(event)
-          payload = T.let(event.payload, T::Hash[Symbol, T.untyped])
-          job = payload[:job]
-          execution = payload[:execution] || payload[:good_job_execution]
-          base_fields = build_base_fields(job, payload)
-          ts = EventTime.coerce_event_time(event.time)
-
-          logger.info(Log::GoodJob::Start.new(
-            **base_fields.to_kwargs,
-            wait_ms: begin
-              wt = execution&.wait_time || calculate_wait_time(execution)
-              wt ? (wt.to_f * 1000.0) : nil
-            end,
-            scheduled_at: (job&.scheduled_at ? Time.at(job.scheduled_at.to_i) : nil),
-            process_id: ::Process.pid,
-            thread_id: Thread.current.object_id.to_s(36),
-            timestamp: ts
-          ))
-        end
-
-        # Job completed successfully event
-        sig { params(event: ::ActiveSupport::Notifications::Event).void }
-        def finish(event)
-          payload = T.let(event.payload, T::Hash[Symbol, T.untyped])
-          job = payload[:job]
-          base_fields = build_base_fields(job, payload)
-          start_ts = EventTime.coerce_event_time(event.time)
-          end_ts = EventTime.coerce_event_time(event.end)
-
-          logger.info(Log::GoodJob::Finish.new(
-            **base_fields.to_kwargs,
-            duration_ms: event.duration.to_f,
-            finished_at: end_ts,
-            process_id: ::Process.pid,
-            thread_id: Thread.current.object_id.to_s(36),
-            result: payload[:result]&.to_s,
-            timestamp: start_ts
-          ))
-        end
-
-        # Job failed with error event
-        sig { params(event: ::ActiveSupport::Notifications::Event).void }
-        def error(event)
-          payload = T.let(event.payload, T::Hash[Symbol, T.untyped])
-          job = payload[:job]
-          execution = payload[:execution] || payload[:good_job_execution]
-          exception = payload[:exception] || payload[:error]
-          ts = EventTime.coerce_event_time(event.time)
-          base_fields = build_base_fields(job, payload)
-
-          logger.error(Log::GoodJob::Error.new(
-            **base_fields.to_kwargs,
-            exception_executions: execution&.exception_executions,
-            error_class: exception&.class&.name,
-            error_message: exception&.message,
-            backtrace: exception&.backtrace,
-            duration_ms: event.duration.to_f,
-            process_id: ::Process.pid,
-            thread_id: Thread.current.object_id.to_s(36),
-            timestamp: ts
-          ))
-        end
-
-        # Job scheduled for future execution event
-        sig { params(event: ::ActiveSupport::Notifications::Event).void }
-        def schedule(event)
-          payload = T.let(event.payload, T::Hash[Symbol, T.untyped])
-          job = payload[:job]
-          base_fields = build_base_fields(job, payload)
-          ts = EventTime.coerce_event_time(event.time)
-
-          logger.info(Log::GoodJob::Schedule.new(
-            **base_fields.to_kwargs,
-            scheduled_at: (job&.scheduled_at ? Time.at(job.scheduled_at.to_i) : nil),
-            priority: job&.priority,
-            cron_key: job&.cron_key,
-            duration_ms: event.duration.to_f,
-            timestamp: ts
-          ))
-        end
-
-        private
-
-        # Build BaseFields from job + payload (execution)
-        sig { params(job: T.untyped, payload: T::Hash[Symbol, T.untyped]).returns(Log::GoodJob::BaseFields) }
-        def build_base_fields(job, payload)
-          execution = payload[:execution] || payload[:good_job_execution]
-          Log::GoodJob::BaseFields.new(
-            job_id: job&.job_id,
-            job_class: job&.job_class,
-            queue_name: job&.queue_name&.to_sym,
-            arguments: job&.arguments,
-            executions: execution&.executions
-          )
-        end
-
-        # Calculate wait time from job creation to execution start
-        sig { params(execution: T.untyped).returns(T.nilable(Float)) }
-        def calculate_wait_time(execution)
-          return nil unless execution.respond_to?(:created_at)
-          return nil unless execution.respond_to?(:performed_at)
-          return nil unless execution.created_at && execution.performed_at
-
-          (execution.performed_at - execution.created_at).to_f
-        rescue
-          # Return nil if calculation fails
-          nil
-        end
-
-        # Get the appropriate logger for GoodJob events
-        sig { returns(T.untyped) }
-        def logger
-          # Always use Rails.logger - in production it will be configured by the integration setup,
-          # in tests it will be set up by the test harness
-          Rails.logger
-        end
-      end
-    end
-  end
-end

data/lib/log_struct/integrations/rack.rb

@@ -1,31 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "rack"
-require "action_dispatch/middleware/show_exceptions"
-require_relative "rack/error_handling_middleware"
-require_relative "rack_setup"
-
-module LogStruct
-  module Integrations
-    # Rack middleware integration for structured logging
-    module Rack
-      extend T::Sig
-      extend IntegrationInterface
-
-      # Set up Rack middleware for structured error logging
-      sig { override.params(config: LogStruct::Configuration).returns(T.nilable(T::Boolean)) }
-      def self.setup(config)
-        return nil unless RackSetup.enabled?(config)
-
-        # Add structured logging middleware for security violations and errors
-        # Need to insert after ShowExceptions to catch IP spoofing errors
-        RackSetup.insert_after(
-          ::ActionDispatch::ShowExceptions,
-          Integrations::RackErrorHandler::Middleware
-        )
-        true
-      end
-    end
-  end
-end