ecs_log_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 124f6a66b55ce717ace54e2fd6021c1b8689a676ba8b4f8539c5a323960c9fd1
+  data.tar.gz: 2f3b5883b2fa210de148c73e4ca9a8ef8f7e0154c6795b16a621cda4e7c89bb5
+SHA512:
+  metadata.gz: aea14dcf42ef25a68b05c9e6c5fca1cf7aea2788b6a4e02004cbc50acfc7e8432ad44c4ad9587a7d5d0838a9a87905849fab1d323bfeb2106f83cd50c5f2d047
+  data.tar.gz: ce426299531612a0711a2f696759312ddb3fbbf90bd2aef58a1414ff619f053f6e8b97d08a7c6b29adf4425c515000544e83ed997732fde9be4c3382b5526397

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Francesco Coda Zabetta
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/ecs_log_rails/ecs_formatter.rb

@@ -0,0 +1,126 @@
+require "logstash-event"
+
+class EcsFormatter
+  attr_reader :ecs_data, :data, :service_env, :service_name, :service_type
+
+  def initialize(service_name:, service_type:, service_env:)
+    @ecs_data = {}
+    @service_name = service_name
+    @service_env = service_env
+    @service_type = service_type
+  end
+
+  def call(data)
+    @data = data
+    generate_ecs
+    event = LogStash::Event.new(deep_compact(ecs_data))
+    event.to_json
+  end
+
+  private
+
+  def generate_ecs
+    add_http
+    add_url
+    add_event
+    add_source
+    add_destination
+    add_service
+    add_rails
+    add_error
+    add_custom_payload
+  end
+
+  def add_http
+    ecs_add(:http, {
+      request: {
+        method: data[:method],
+        referrer: data[:referrer]
+      },
+      response: {
+        mime_type: data[:format],
+        status_code: data[:status]
+      }
+    })
+  end
+
+  def add_url
+    ecs_add(:url, {
+      path: data[:path],
+      original: data[:original_url]
+    })
+  end
+
+  def add_event
+    ecs_add(:event, {
+      kind: "event",
+      # ECS event duration in nanoseconds
+      duration: nanoseconds(data[:duration])
+    })
+  end
+
+  def add_source
+    ecs_add(:source, {
+      ip: data[:remote_ip]
+    })
+  end
+
+  def add_destination
+    ecs_add(:destination, {
+      ip: data[:ip],
+      name: data[:host]
+    })
+  end
+
+  def add_service
+    ecs_add(:service, {
+      name: service_name,
+      type: service_type,
+      environment: service_env
+    })
+  end
+
+  def add_rails
+    ecs_add(:rails, {
+      controller: data[:controller],
+      action: data[:action],
+      params: data[:params],
+      view_runtime: data[:view],
+      db_runtime: data[:db]
+    })
+  end
+
+  def add_error
+    ecs_add(:error, {
+      type: data[:exception]&.first,
+      message: data[:exception]&.last,
+      stack_trace: data[:exception_object]&.backtrace&.join("\n")
+    })
+  end
+
+  def add_custom_payload
+    return if data[:ecs_custom].nil?
+
+    ecs_data.merge!(data[:ecs_custom])
+  end
+
+  def deep_compact(hash)
+    res_hash = hash.map do |key, value|
+      value = deep_compact(value) if value.is_a?(Hash)
+
+      value = nil if [{}, []].include?(value)
+      [key, value]
+    end
+    res_hash.to_h.compact
+  end
+
+  def ecs_add(key, value)
+    ecs_data.store(key, value)
+  end
+
+  def nanoseconds(ms)
+    return if ms.nil?
+
+    (ms * 1_000_000).to_i
+  end
+end

data/lib/ecs_log_rails/ordered_options.rb

@@ -0,0 +1,10 @@
+require "active_support"
+require "active_support/ordered_options"
+
+module EcsLogRails
+  class OrderedOptions < ActiveSupport::OrderedOptions
+    def custom_payload(&block)
+      self.custom_payload_method = block
+    end
+  end
+end

data/lib/ecs_log_rails/railtie.rb

@@ -0,0 +1,20 @@
+require "rails/railtie"
+require "ecs_log_rails/ordered_options"
+
+module EcsLogRails
+  class Railtie < Rails::Railtie
+    config.ecs_log_rails = EcsLogRails::OrderedOptions.new
+    config.ecs_log_rails.enabled = false
+    config.ecs_log_rails.keep_original_rails_log = true
+    config.ecs_log_rails.log_level = :info
+    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.after_initialize do |app|
+      app.config.ecs_log_rails.service_name ||= Rails.application.class.module_parent.name
+
+      EcsLogRails.setup(app) if app.config.ecs_log_rails.enabled
+    end
+  end
+end

data/lib/ecs_log_rails/version.rb

@@ -0,0 +1,3 @@
+module EcsLogRails
+  VERSION = "0.1.0".freeze
+end

data/lib/ecs_log_rails.rb

@@ -0,0 +1,75 @@
+require "lograge"
+require "ecs_log_rails/ecs_formatter"
+
+module EcsLogRails
+  module_function
+
+  mattr_accessor :application
+
+  def setup(app)
+    self.application = app
+    setup_lograge
+    setup_custom_payload
+    setup_logger
+    setup_formatter
+  end
+
+  def setup_lograge
+    # by default keep original rails log
+    application.config.lograge.keep_original_rails_log = ecs_log_rails_config.keep_original_rails_log
+    # custom options
+    application.config.lograge.custom_options = ->(event) do
+      {
+        original_url: event.payload[:request]&.original_url,
+        remote_ip: event.payload[:request]&.remote_ip,
+        ip: event.payload[:request]&.ip,
+        host: event.payload[:request]&.host,
+        referrer: event.payload[:request]&.referer,
+        params: event.payload[:params]&.except("controller", "action"),
+        exception: event.payload[:exception],
+        exception_object: event.payload[:exception_object]
+      }
+    end
+    Lograge.setup(application)
+  end
+
+  def setup_logger
+    Lograge.logger = ActiveSupport::Logger.new(ecs_log_rails_config.log_file)
+    Lograge.log_level = ecs_log_rails_config.log_level
+  end
+
+  def setup_formatter
+    Lograge.formatter = EcsFormatter.new(
+      service_name: ecs_log_rails_config.service_name,
+      service_env: ecs_log_rails_config.service_env,
+      service_type: ecs_log_rails_config.service_type
+    )
+  end
+
+  def setup_custom_payload
+    return unless ecs_log_rails_config.custom_payload_method.respond_to?(:call)
+
+    base_classes = Array(ecs_log_rails_config.base_controller_class)
+    base_classes.map! { |klass| klass.try(:constantize) }
+    base_classes << ActionController::Base if base_classes.empty?
+
+    base_classes.each do |base_class|
+      extend_base_class(base_class)
+    end
+  end
+
+  def extend_base_class(klass)
+    append_payload_method = klass.instance_method(:append_info_to_payload)
+    custom_payload_method = ecs_log_rails_config.custom_payload_method
+
+    klass.send(:define_method, :append_info_to_payload) do |payload|
+      append_payload_method.bind_call(self, payload)
+      payload[:custom_payload] = {ecs_custom: custom_payload_method.call(self)}
+    end
+  end
+
+  def ecs_log_rails_config
+    application.config.ecs_log_rails
+  end
+end
+require "ecs_log_rails/railtie" if defined?(Rails)

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: ecs_log_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Francesco Coda Zabetta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lograge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logstash-event
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Convert rails' multi-line logging into a single line JSON formatted ECS
+  compliant
+email: francesco.codazabetta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- lib/ecs_log_rails.rb
+- lib/ecs_log_rails/ecs_formatter.rb
+- lib/ecs_log_rails/ordered_options.rb
+- lib/ecs_log_rails/railtie.rb
+- lib/ecs_log_rails/version.rb
+homepage: https://github.com/vicvega/ecs_log_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Elastic Common Schema for rails' logs
+test_files: []