exis_ray 0.3.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 368df7fa55a8dc849917a5854026d50752f3701afede7bc9418c83e229a1fe50
-  data.tar.gz: 7998fda22e20966eae15450faf4c2e73e103c24e23b2decd3c41b76c605ec036
+  metadata.gz: bb94b36fd16b408d5359621e78a03c722c89dab7c087322b67c975db743ad24e
+  data.tar.gz: ef093be07091568e6bad52d26de306dd82f91fc8e8f554d4eb04a7ca8c3b1581
 SHA512:
-  metadata.gz: 791eca1e5cd91703ebd7d43803b09a55f718918ac65808eecd9ae8d8141944297f9d06ab1f7b46519dcd0018e0174ebc307d14a297eefa9581440e2c6448cdb0
-  data.tar.gz: e2c88c9e68556110a8ab757009e2f824849123202f692aa71d15015d3c4aaa385fc90cd093bb7657f112a1a217f98c7ed4385de11d0c6e1f9cf3c5a5b36abfee
+  metadata.gz: ce25522741b66f66318fa6d5223c0db754f1fe8f7eb1067a867f219988a1bc4ae78ef55c61e0895d553df955f129165af211a52dd41c86d6e3f6fe7066f7d7b2
+  data.tar.gz: 7ab403c8790dae80419260834d18787faa060bb2528d10974a4ef255bd6a0ea79c9aa837040015360db531b6114c8d99b4412c592d6749a0cba298ce24d072bc

data/CHANGELOG.md

@@ -1,3 +1,43 @@
+## [0.4.1] - 2026-03-23
+
+### Changed
+- **Data-Driven Internal Logging:** Refactored internal library logs (boot, instrumentation, task status) from plain text messages to structured Key-Value (KV) strings.
+- This leverages the `JsonFormatter`'s KV parser to elevate fields like `component`, `event`, and `status` to the JSON root, eliminating the need for unstructured `message` fields in infrastructure logs.
+- Simplified `TaskMonitor#log_event` and `Railtie.log_boot` to emit raw KV strings directly to the logger.
+- **Improved local debugging:** The `Reporter` now uses `exception.full_message` in non-production environments to provide a more readable backtrace in the development console.
+
+## [0.4.0] - 2026-03-23
+
+### Breaking Changes
+- **Lograge removido como dependencia.** ExisRay ya no depende de Lograge para el logging estructurado de requests HTTP. Si tu app usaba `config.lograge.custom_options`, migrá al nuevo mecanismo de subclase (ver más abajo).
+
+### Added
+- **`ExisRay::LogSubscriber`:** Nuevo subscriber propio que reemplaza Lograge. Se suscribe a `process_action.action_controller` y emite un Hash estructurado directamente al logger, compatible con Rails 6, 7 y 8.
+  - Suprime `ActionController::LogSubscriber` y `ActionView::LogSubscriber` (Rails 3.0+, sin cambios en 6/7/8).
+  - Suprime `Rails::Rack::Logger` para eliminar las líneas "Started GET /..." (Rails 3.2+, firma `call_app(request, env)` desde Rails 5.0+).
+  - Usa `notifier.all_listeners_for` en Rails 7.1+ y `notifier.listeners_for` en Rails 6/7.0 para desuscribir los subscribers por defecto. Si `all_listeners_for` cambia en futuras versiones, revisar `ActiveSupport::Notifications::Fanout`.
+- **`config.log_subscriber_class`:** Nueva opción de configuración para registrar una subclase de `ExisRay::LogSubscriber`. Permite inyectar campos extra en cada log de request HTTP sobreescribiendo `self.extra_fields(event)`. Si no se configura, se usa `ExisRay::LogSubscriber` directamente sin campos extra.
+
+### Migration Guide
+Si usabas `config.lograge.custom_options`, el equivalente es:
+
+```ruby
+# Antes
+config.lograge.custom_options = ->(event) { { user_id: Current.user_id } }
+
+# Después — app/models/my_log_subscriber.rb
+class MyLogSubscriber < ExisRay::LogSubscriber
+  def self.extra_fields(event)
+    { user_id: Current.user_id }
+  end
+end
+
+# config/initializers/exis_ray.rb
+ExisRay.configure do |config|
+  config.log_subscriber_class = "MyLogSubscriber"
+end
+```
+
 ## [0.3.4] - 2026-03-23
 
 ### Fixed

data/README.md

@@ -31,7 +31,7 @@ And then execute:
 $ bundle install
 ```
 
-*(Note: ExisRay automatically installs and configures `lograge` as a dependency to handle HTTP log condensation).*
+*(Note: ExisRay handles HTTP log condensation internally via `ExisRay::LogSubscriber`, compatible with Rails 6, 7 and 8. Lograge is no longer required).*
 
 ---
 
@@ -242,26 +242,38 @@ config.log_tags = [
 {"time":"2026-03-12T14:30:00Z","service":"App-HTTP","tags":["abcd-1234-uuid","CustomValue"],"method":"GET","status":200}
 ```
 
-### 3. Extending JSON with Custom Properties (Lograge)
+### 3. Extending JSON with Custom HTTP Fields
 
-If you prefer to inject key-value pairs directly into the root of the JSON (which is highly recommended for querying in Datadog, Kibana, etc.), you can leverage Lograge's `custom_options` in your host application.
+To inject extra fields into each HTTP request log, create a subclass of `ExisRay::LogSubscriber` and override `self.extra_fields`:
 
-ExisRay will flawlessly merge these attributes with the core Trace ID and Business Context.
+**File:** `app/models/my_log_subscriber.rb`
+```ruby
+class MyLogSubscriber < ExisRay::LogSubscriber
+  def self.extra_fields(event)
+    {
+      ip_address: event.payload[:ip],
+      user_agent: event.payload[:headers]["HTTP_USER_AGENT"]
+    }
+  end
+end
+```
 
-**File:** `config/environments/production.rb`
+Then register it in your initializer:
+
+**File:** `config/initializers/exis_ray.rb`
 ```ruby
-config.lograge.custom_options = lambda do |event|
-  {
-    ip_address: event.payload[:ip],
-    browser: event.payload[:user_agent]
-  }
+ExisRay.configure do |config|
+  config.log_subscriber_class = "MyLogSubscriber"
 end
 ```
+
 **Output:**
 ```json
-{"time":"2026-03-12T14:30:00Z","service":"App-HTTP","root_id":"Root=1-65a...","method":"GET","ip_address":"192.168.1.1","browser":"Chrome","status":200}
+{"time":"2026-03-12T14:30:00Z","service":"App-HTTP","root_id":"Root=1-65a...","method":"GET","ip_address":"192.168.1.1","user_agent":"Chrome","status":200}
 ```
 
+If you don't need extra fields, skip this step — `ExisRay::LogSubscriber` is used by default with no additional fields.
+
 ---
 
 ## 🏗 Architecture
@@ -271,6 +283,7 @@ end
 * **`ExisRay::Reporter`**: The observability layer. Bridges the gap between your app and Sentry.
 * **`ExisRay::JsonFormatter`**: The central logging engine. Intercepts HTTP, Sidekiq, and Tasks to output clean JSON.
     * **KV String Parser:** It automatically detects if a log message (String) uses `key=value` format. If so, it parses the pairs and elevates them to the root of the JSON. For example, `Rails.logger.info "event=boot status=ok"` becomes `{"event":"boot","status":"ok",...}`. It supports quoted values with spaces: `message="something went wrong"`.
+* **`ExisRay::LogSubscriber`**: Replaces Lograge for HTTP request logging. Subscribes to `process_action.action_controller` and suppresses Rails' default multi-line log subscribers. Compatible with Rails 6, 7, and 8. Subclass it and override `self.extra_fields(event)` to inject custom fields.
 * **`ExisRay::TaskMonitor`**: The entry point for non-HTTP processes.
 
 ## License

data/lib/exis_ray/configuration.rb

@@ -31,6 +31,13 @@ module ExisRay
     #   @example :json
     attr_accessor :log_format
 
+    # @!attribute [rw] log_subscriber_class
+    #   @return [String, nil] Nombre de la subclase de ExisRay::LogSubscriber de la app host.
+    #   Usada para inyectar campos extra en cada log de request HTTP via `extra_fields`.
+    #   Si es nil, se usa ExisRay::LogSubscriber directamente (sin campos extra).
+    #   @example 'MyLogSubscriber'
+    attr_accessor :log_subscriber_class
+
     # Inicializa la configuración con valores por defecto compatibles con AWS X-Ray.
     def initialize
       @trace_header = 'HTTP_X_AMZN_TRACE_ID'
@@ -38,6 +45,7 @@ module ExisRay
       @reporter_class = 'Reporter'
       @current_class = 'Current'
       @log_format = :text
+      @log_subscriber_class = nil
     end
 
     # Indica si la aplicación está configurada para emitir logs en formato estructurado (JSON).

data/lib/exis_ray/log_subscriber.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require "active_support/log_subscriber"
+
+module ExisRay
+  # Reemplaza Lograge para el logging estructurado de requests HTTP en Rails 6, 7 y 8.
+  #
+  # Se suscribe a `process_action.action_controller` y emite un Hash al logger,
+  # que JsonFormatter convierte a JSON. Suprime los log subscribers por defecto
+  # de Rails (ActionController, ActionView, Rails::Rack::Logger) para evitar
+  # líneas de log duplicadas o en formato texto.
+  #
+  # Para inyectar campos extra en cada log de request, heredá esta clase y
+  # sobreescribí `extra_fields`:
+  #
+  #   class MyLogSubscriber < ExisRay::LogSubscriber
+  #     def self.extra_fields(event)
+  #       { user_agent: event.payload[:headers]["HTTP_USER_AGENT"] }
+  #     end
+  #   end
+  #
+  # Luego configurá la subclase:
+  #
+  #   ExisRay.configure do |config|
+  #     config.log_subscriber_class = "MyLogSubscriber"
+  #   end
+  #
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    # Procesa el evento de finalización de un request HTTP y lo emite como Hash estructurado.
+    #
+    # @param event [ActiveSupport::Notifications::Event]
+    # @return [void]
+    def process_action(event)
+      payload = build_payload(event)
+      logger.info(payload)
+    rescue StandardError
+      # El logger nunca debe interrumpir el flujo del request.
+    end
+
+    # Hook para que las subclases inyecten campos extra en cada log de request.
+    # Por defecto retorna un Hash vacío.
+    #
+    # @param event [ActiveSupport::Notifications::Event]
+    # @return [Hash]
+    def self.extra_fields(_event)
+      {}
+    end
+
+    # --- Instalación y supresión de subscribers ---
+
+    # Activa el subscriber correcto (subclase configurada o ExisRay::LogSubscriber por defecto)
+    # y suprime los log subscribers por defecto de Rails.
+    #
+    # @return [void]
+    def self.install!
+      suppress_default_log_subscribers!
+      suppress_rack_logger!
+      subscriber_class.attach_to(:action_controller)
+    end
+
+    private
+
+    def build_payload(event)
+      payload = event.payload
+      status  = payload[:status] || exception_status(payload[:exception])
+
+      data = {
+        method:     payload[:method],
+        path:       payload[:path],
+        format:     payload[:format],
+        controller: payload[:controller],
+        action:     payload[:action],
+        status:     status,
+        duration:   event.duration.round(2),
+        view:       payload[:view_runtime]&.round(2),
+        db:         payload[:db_runtime]&.round(2)
+      }
+
+      data.merge!(self.class.extra_fields(event))
+      data.compact
+    end
+
+    # Infiere el status HTTP desde el nombre de la excepción cuando el request
+    # terminó con una excepción no rescatada (payload[:status] es nil).
+    #
+    # @param exception_info [Array(String, String), nil] [nombre_clase, mensaje]
+    # @return [Integer]
+    def exception_status(exception_info)
+      return 500 unless exception_info
+
+      exception_class_name = exception_info.first
+      # ActionDispatch::ExceptionWrapper disponible desde Rails 3.2+
+      ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
+    rescue StandardError
+      500
+    end
+
+    # Resuelve la clase a attachar: subclase configurada o ExisRay::LogSubscriber.
+    #
+    # @return [Class]
+    def self.subscriber_class
+      klass_name = ExisRay.configuration.log_subscriber_class
+      return self unless klass_name.present?
+
+      klass_name.safe_constantize || self
+    end
+
+    # Suprime ActionController::LogSubscriber y ActionView::LogSubscriber
+    # para evitar los logs multi-línea por defecto de Rails.
+    #
+    # Introducido en Rails 3.0. Presente sin cambios en Rails 6, 7 y 8.
+    #
+    # @return [void]
+    def self.suppress_default_log_subscribers!
+      require "action_controller/log_subscriber"
+      require "action_view/log_subscriber"
+
+      ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+        case subscriber
+        when ActionController::LogSubscriber
+          unsubscribe_subscriber(:action_controller, subscriber)
+        when ActionView::LogSubscriber
+          unsubscribe_subscriber(:action_view, subscriber)
+        end
+      end
+    end
+
+    # Suprime las líneas "Started GET /..." emitidas por Rails::Rack::Logger.
+    #
+    # Rails::Rack::Logger introducido en Rails 3.2. La firma de `call_app` recibe
+    # (request, env) desde Rails 5.0+. Compatible con Rails 6, 7 y 8.
+    #
+    # @return [void]
+    def self.suppress_rack_logger!
+      require "rails/rack/logger"
+
+      ::Rails::Rack::Logger.class_eval do
+        def call_app(request, env) # rubocop:disable Lint/UnusedMethodArgument
+          status, headers, body = @app.call(env)
+          [status, headers, ::Rack::BodyProxy.new(body) {}]
+        ensure
+          ActiveSupport::LogSubscriber.flush_all!
+        end
+      end
+    end
+
+    # Desuscribe un subscriber de todas las notificaciones de un namespace.
+    #
+    # API de notificaciones:
+    # - Rails 6 / 7.0: `notifier.listeners_for(event_name)`
+    # - Rails 7.1+:    `notifier.all_listeners_for(event_name)` (listeners_for fue deprecado)
+    # - Rails 8:       solo `all_listeners_for`
+    #
+    # Si `all_listeners_for` desaparece en futuras versiones, revisar
+    # ActiveSupport::Notifications::Fanout para el API vigente.
+    #
+    # @param namespace [Symbol]
+    # @param subscriber [ActiveSupport::LogSubscriber]
+    # @return [void]
+    def self.unsubscribe_subscriber(namespace, subscriber)
+      events   = subscriber.public_methods(false).reject { |m| m.to_s == "call" }
+      notifier = ActiveSupport::Notifications.notifier
+
+      events.each do |event|
+        event_name = "#{event}.#{namespace}"
+        listeners  = if notifier.respond_to?(:all_listeners_for)
+                       # Rails 7.1+ (introducido en 7.1.0)
+                       notifier.all_listeners_for(event_name)
+                     else
+                       # Rails 6 / 7.0
+                       notifier.listeners_for(event_name)
+                     end
+
+        listeners.each do |listener|
+          delegate = listener.instance_variable_get(:@delegate)
+          ActiveSupport::Notifications.unsubscribe(listener) if delegate == subscriber
+        end
+      end
+    end
+
+    private_class_method :suppress_default_log_subscribers!,
+                         :suppress_rack_logger!,
+                         :unsubscribe_subscriber,
+                         :subscriber_class
+  end
+end

data/lib/exis_ray/railtie.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "rails/railtie"
-require "lograge" # Requerido globalmente para que su propio Railtie se registre en el boot
 
 module ExisRay
   # Integración automática de la gema con el ecosistema de Ruby on Rails.
@@ -17,14 +16,11 @@ module ExisRay
       app.middleware.insert_after ActionDispatch::RequestId, ExisRay::HttpMiddleware
     end
 
-    # 2. Configuración de Estrategia de Logging (Lograge y Tags)
+    # 2. Configuración de Estrategia de Logging
     # CLAVE: Usamos `after: :load_config_initializers` para garantizar que la app
     # ya haya leído `config/initializers/exis_ray.rb` antes de tomar esta decisión.
     initializer "exis_ray.configure_logging", after: :load_config_initializers do |app|
-      if ExisRay.configuration.json_logs?
-        app.config.lograge.enabled = true
-        app.config.lograge.formatter = Lograge::Formatters::Raw.new
-      else
+      unless ExisRay.configuration.json_logs?
         # Comportamiento legacy: Text Plain Tags
         app.config.log_tags ||= []
         app.config.log_tags << proc do
@@ -39,18 +35,20 @@ module ExisRay
       # Aplicamos el formateador JSON globalmente al logger ya instanciado de Rails
       if ExisRay.configuration.json_logs? && Rails.logger
         Rails.logger.formatter = ExisRay::JsonFormatter.new
-        Rails.logger.info({ message: "[ExisRay] JSON Logging unificado activado." })
+
+        # Activamos nuestro LogSubscriber HTTP y suprimimos los de Rails por defecto.
+        # Reemplaza Lograge, compatible con Rails 6, 7 y 8.
+        require "exis_ray/log_subscriber"
+        ExisRay::LogSubscriber.install!
+
+        log_boot("component=exis_ray event=json_logging_enabled")
       end
 
       # --- Instrumentación de ActiveResource ---
       if defined?(ActiveResource::Base)
         require "exis_ray/active_resource_instrumentation"
         ActiveResource::Base.send(:prepend, ExisRay::ActiveResourceInstrumentation)
-
-        log_message(
-          text: "[ExisRay] ActiveResource instrumentado.",
-          json: { message: "[ExisRay] ActiveResource instrumentado." }
-        )
+        log_boot("component=exis_ray event=active_resource_instrumented")
       end
 
       # --- Instrumentación de Sidekiq ---
@@ -73,27 +71,21 @@ module ExisRay
           end
         end
 
-        # Sidekiq maneja su propio logger. Lo forzamos a usar nuestra estructura JSON.
         if ExisRay.configuration.json_logs? && ::Sidekiq.logger
           ::Sidekiq.logger.formatter = ExisRay::JsonFormatter.new
-          Rails.logger.info({ message: "[ExisRay] Sidekiq Middleware y JsonFormatter integrados." })
-        else
-          Rails.logger.info "[ExisRay] Sidekiq Middleware integrado."
         end
+        log_boot("component=exis_ray event=sidekiq_instrumented")
       end
     end
 
-    # Helper interno para imprimir logs de inicialización respetando el formato elegido.
+    # Emite un log de boot en DEBUG con formato key=value.
+    # En modo texto es legible directamente. En modo JSON el JsonFormatter
+    # lo parsea y eleva cada campo al nivel raíz del JSON automáticamente.
     #
-    # @param text [String] El mensaje para el formato texto.
-    # @param json [Hash] El payload para el formato JSON.
+    # @param message [String] String en formato key=value.
     # @return [void]
-    def self.log_message(text:, json:)
-      if ExisRay.configuration.json_logs?
-        Rails.logger.info(json)
-      else
-        Rails.logger.info(text)
-      end
+    def self.log_boot(message)
+      Rails.logger.debug(message)
     end
   end
 end

data/lib/exis_ray/reporter.rb

@@ -32,7 +32,7 @@ module ExisRay
       prepare_scope(context, tags, fingerprint, transaction_name)
       add_tags(exception: excep.class.to_s)
 
-      Rails.logger.error(excep) unless Rails.env.production?
+      Rails.logger.error(excep.full_message) unless Rails.env.production?
 
       if report_to_new_sentry?
         exception_to_new_sentry(excep)

data/lib/exis_ray/task_monitor.rb

@@ -29,14 +29,14 @@ module ExisRay
         curr.correlation_id = ExisRay::Tracer.correlation_id
       end
 
-      log_event(:info, "Iniciando tarea: #{task_name}", task: task_name, status: "started")
+      log_event(:info, "component=exis_ray event=task_started task=#{task_name} status=started")
 
       # Bloque de ejecución con o sin tags dependiendo de la configuración
       execute_with_optional_tags { yield }
 
-      log_event(:info, "Finalizada con éxito.", task: task_name, status: "success")
+      log_event(:info, "component=exis_ray event=task_finished task=#{task_name} status=success")
     rescue StandardError => e
-      log_event(:error, "Falló la tarea #{task_name}: #{e.message}", task: task_name, status: "failed", error: e.message)
+      log_event(:error, "component=exis_ray event=task_failed task=#{task_name} status=failed error=#{e.message.inspect}")
       raise e
     ensure
       # Limpieza centralizada obligatoria para evitar filtraciones de memoria o contexto
@@ -89,12 +89,8 @@ module ExisRay
     # @param message [String] Mensaje en texto plano para el modo clásico.
     # @param payload [Hash] Datos estructurados para el modo JSON.
     # @return [void]
-    def self.log_event(level, message, **payload)
-      if ExisRay.configuration.json_logs?
-        Rails.logger.send(level, payload.merge(message: "[ExisRay] #{message}"))
-      else
-        Rails.logger.send(level, "[ExisRay] #{message}")
-      end
+    def self.log_event(level, message)
+      Rails.logger.send(level, message)
     rescue StandardError
       # El logger nunca debe interrumpir el flujo principal de la tarea.
     end

data/lib/exis_ray/version.rb

@@ -2,5 +2,5 @@
 
 module ExisRay
   # Versión actual de la gema.
-  VERSION = "0.3.4"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exis_ray
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.1
 platform: ruby
 authors:
 - Gabriel Edera
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: lograge
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.11'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.11'
 description: Gema que gestiona el contexto de request, logs y propagación de headers.
 email:
 - gab.edera@gmail.com
@@ -70,6 +56,7 @@ files:
 - lib/exis_ray/faraday_middleware.rb
 - lib/exis_ray/http_middleware.rb
 - lib/exis_ray/json_formatter.rb
+- lib/exis_ray/log_subscriber.rb
 - lib/exis_ray/railtie.rb
 - lib/exis_ray/reporter.rb
 - lib/exis_ray/sidekiq/client_middleware.rb