ecs_log_rails 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd1b34b42d808de7704a6bc3fcd5240589b8564eb2f352e2b4ab57b8198919da
-  data.tar.gz: bcfc234ba61e9f281719da5b3e2db82dcba3f23b4e75fea51e964e1d5c2b692a
+  metadata.gz: 28a63bf2598536867a77136433f3f9e44985b62615bcd309fc531b91e41c3bb5
+  data.tar.gz: 1da522e5fba13277f146e84ca3feafaf0de91be4548ae9ed040a3f21bad7360f
 SHA512:
-  metadata.gz: 346417ab21c86105bce5f6a1dd8bda4de0c31126d70418b5142f6c99c31c7f1e9f992c3c21162233826a2410f32578b0b7f4c5fc9b890c93c8af3842a8dec3ae
-  data.tar.gz: 2fa28ac0d4ad163d9dd9336a9ec705b1713f4e3395453252a0f869e2be2af6c5c35a22eab52ce40b2b3fefdde044ce9e050d73452a9cb4b0e7dca7288889adc6
+  metadata.gz: 2cffef1b4fbf4bc502648b47e9b9df98582b26ec07303b39efa76b8767be1eaa4e9dfac14f36d12d8d4a32303afb44ccd5e7a6df779bf2cd23d33d85553f3795
+  data.tar.gz: 712e02233731889aba67e39d16414508c5ae7b2de3d924e8700c2ccc6848a90be9af45925108d33e40d0797197eeef4e3d0ff6b610969c84162f490dae64b88a

data/lib/ecs_log_rails/ecs_formatter.rb

@@ -26,6 +26,7 @@ class EcsFormatter
     add_source
     add_destination
     add_service
+    add_apm_trace
     add_rails
     add_error
     add_custom_payload
@@ -84,6 +85,20 @@ class EcsFormatter
     })
   end
 
+  def add_apm_trace
+    ecs_add(:trace, {
+      id: data[:apm_trace_id]
+    })
+
+    ecs_add(:transaction, {
+      id: data[:apm_transaction_id]
+    })
+
+    ecs_add(:span, {
+      id: data[:apm_span_id]
+    })
+  end
+
   def add_rails
     ecs_add(:rails, {
       controller: data[:controller],

data/lib/ecs_log_rails/railtie.rb

@@ -10,6 +10,7 @@ module EcsLogRails
     config.ecs_log_rails.log_file = File.join("log", "ecs_log_rails.log")
     config.ecs_log_rails.service_env = Rails.env
     config.ecs_log_rails.service_type = "rails"
+    config.ecs_log_rails.log_correlation = false
 
     config.after_initialize do |app|
       app.config.ecs_log_rails.service_name ||= Rails.application.class.module_parent.name

data/lib/ecs_log_rails/version.rb

@@ -1,3 +1,3 @@
 module EcsLogRails
-  VERSION = "0.1.2".freeze
+  VERSION = "0.1.3".freeze
 end

data/lib/ecs_log_rails.rb

@@ -8,6 +8,7 @@ module EcsLogRails
 
   def setup(app)
     self.application = app
+    validate_log_correlation!
     setup_lograge
     setup_custom_payload
     setup_logger
@@ -19,7 +20,7 @@ module EcsLogRails
     application.config.lograge.keep_original_rails_log = ecs_log_rails_config.keep_original_rails_log
     # custom options
     application.config.lograge.custom_options = ->(event) do
-      {
+      options = {
         original_url: event.payload[:request]&.original_url,
         remote_ip: event.payload[:request]&.remote_ip,
         ip: event.payload[:request]&.ip,
@@ -29,6 +30,18 @@ module EcsLogRails
         exception: event.payload[:exception],
         exception_object: event.payload[:exception_object]
       }
+
+      if ecs_log_rails_config.log_correlation
+        # Note: ElasticAPM.log_ids can yield nil values, or an empty string if called without a block,
+        # when there's no active transaction/span. We use this signature to have more control.
+        ElasticAPM.log_ids do |transaction_id, span_id, trace_id|
+          options[:apm_transaction_id] = transaction_id if transaction_id
+          options[:apm_span_id] = span_id if span_id
+          options[:apm_trace_id] = trace_id if trace_id
+        end
+      end
+
+      options
     end
     Lograge.setup(application)
   end
@@ -71,5 +84,14 @@ module EcsLogRails
   def ecs_log_rails_config
     application.config.ecs_log_rails
   end
+
+  def validate_log_correlation!
+    return unless ecs_log_rails_config.log_correlation
+
+    unless defined?(ElasticAPM)
+      raise "EcsLogRails log_correlation is enabled but ElasticAPM is not defined. " \
+            "Please add 'elastic-apm' gem to your Gemfile to be able to use log_correlation."
+    end
+  end
 end
 require "ecs_log_rails/railtie" if defined?(Rails)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ecs_log_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Francesco Coda Zabetta
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -55,7 +54,6 @@ homepage: https://github.com/vicvega/ecs_log_rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -70,8 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Elastic Common Schema for rails' logs
 test_files: []