exis_ray 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5162f50fce688356ff17e9adff2464f6bc7ba9c83ee2e3a1f662dc4568fb6d3
-  data.tar.gz: b2559412f57a487971edbf42cd0b24e18bbbe9fe33890096e8e6769647895e49
+  metadata.gz: ad3239a79f3c1393bc7138ed81a149afbc8564817687906e1dd06931a231a03f
+  data.tar.gz: 5ff151e3ca3035d9d962622ea9a5b3231078fe913be160d1acb1e8f1c892f05e
 SHA512:
-  metadata.gz: 9efba79f9584005d1beb8c1d749dc4efb54959aa47433a671b611cbc15ce93bb4f081f390047b736039a1fad1d621cc2d5661fb82c3f340c2f57a7bddc461f19
-  data.tar.gz: a2878c45410719109283a4a2b44201bc0b45fbe5a7ee2c70ba020a5b255392ab42af18fa52995f75e98dc4e32ae0727c718429b590daa3af797202e1488db897
+  metadata.gz: 333e04eb54ce9df129976069e99bd349d4c56902e0f1c2e39baa56fc15bcdfacea9b977bb4e03f35bad36d0cf3ad149aa232c8de90385f267d035b24af666fc4
+  data.tar.gz: 1cb26ee1550c63524352ecce48ce2fcc761076cf9f6957757ce0e14b9ab6ced7aadc09e45ac0a954f8c2dc1018555f446ed1aa0fc9f2d3e44d6e7722c8d5e3a9

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## [0.4.2] - 2026-03-23
+
+### Added
+- **Full compliance with "Gabriel's Global Standards" for Logging:**
+  - **Sensitive Data Filtering:** The KV parser and Hash merger now automatically filter sensitive keys (`password`, `token`, `api_key`, `auth`, etc.) replacing values with `[FILTERED]`.
+  - **Standardized HTTP Logs:** Added `component=exis_ray` and `event=http_request` to all automatic Rails request logs.
+  - **Dynamic Log Levels:** `LogSubscriber` now uses `ERROR` level for 5xx status codes and `INFO` for the rest.
+  - **Performance:** Switched to block form for internal `DEBUG` logs in `Railtie` to avoid unnecessary string interpolation.
+
+## [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

data/lib/exis_ray/json_formatter.rb

@@ -25,6 +25,9 @@ module ExisRay
     # Extrae pares key=value de un string. Soporta valores sin espacios o entre comillas dobles.
     KV_PARSE_RE  = /(\w+)=("(?:[^"\\]|\\.)*"|\S+)/
 
+    # Claves sensibles que deben filtrarse automáticamente según el estándar de Gabriel.
+    SENSITIVE_KEYS = /password|pass|passwd|secret|token|api_key|auth/i
+
     # Procesa un mensaje de log y lo formatea como una cadena estructurada en JSON.
     #
     # @param severity [String] El nivel de severidad del log (ej. "INFO", "ERROR", "DEBUG").
@@ -103,7 +106,8 @@ module ExisRay
     # @return [void]
     def process_message(payload, msg)
       if msg.is_a?(Hash)
-        payload.merge!(msg)
+        # Filtramos las claves del Hash antes del merge
+        payload.merge!(filter_sensitive_hash(msg))
       elsif msg.is_a?(String) && kv_string?(msg)
         parsed = parse_kv_string(msg)
         parsed.empty? ? payload[:message] = msg : payload.merge!(parsed)
@@ -129,9 +133,33 @@ module ExisRay
     def parse_kv_string(str)
       result = {}
       str.scan(KV_PARSE_RE) do |key, value|
-        result[key.to_sym] = value.start_with?('"') ? (value[1..-2] || "").gsub('\\"', '"') : value
+        val = value.start_with?('"') ? (value[1..-2] || "").gsub('\\"', '"') : value
+        result[key.to_sym] = filter_sensitive_value(key, val)
       end
       result
     end
+
+    # Filtra un valor si la clave se considera sensible.
+    #
+    # @param key [String, Symbol]
+    # @param value [Object]
+    # @return [Object]
+    def filter_sensitive_value(key, value)
+      key.to_s.match?(SENSITIVE_KEYS) ? "[FILTERED]" : value
+    end
+
+    # Filtra recursivamente un Hash que contenga claves sensibles.
+    #
+    # @param hash [Hash]
+    # @return [Hash]
+    def filter_sensitive_hash(hash)
+      hash.each_with_object({}) do |(k, v), result|
+        result[k] = if v.is_a?(Hash)
+                      filter_sensitive_hash(v)
+                    else
+                      filter_sensitive_value(k, v)
+                    end
+      end
+    end
   end
 end

data/lib/exis_ray/log_subscriber.rb

@@ -32,7 +32,12 @@ module ExisRay
     # @return [void]
     def process_action(event)
       payload = build_payload(event)
-      logger.info(payload)
+      # Usamos el nivel ERROR si el status es 5xx, cumpliendo el estándar de Gabriel.
+      if payload[:status] && payload[:status] >= 500
+        logger.error(payload)
+      else
+        logger.info(payload)
+      end
     rescue StandardError
       # El logger nunca debe interrumpir el flujo del request.
     end
@@ -65,6 +70,8 @@ module ExisRay
       status  = payload[:status] || exception_status(payload[:exception])
 
       data = {
+        component:  "exis_ray",
+        event:      "http_request",
         method:     payload[:method],
         path:       payload[:path],
         format:     payload[:format],

data/lib/exis_ray/railtie.rb

@@ -41,18 +41,14 @@ module ExisRay
         require "exis_ray/log_subscriber"
         ExisRay::LogSubscriber.install!
 
-        Rails.logger.info({ message: "[ExisRay] JSON Logging unificado activado." })
+        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 ---
@@ -75,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.4.0"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exis_ray
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Gabriel Edera