heavylog 0.0.20 → 0.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d938340a9fc57747dc46c35aadb0a9b92c08da6466f3d333479e7b0c4de63d4
-  data.tar.gz: f31b3c1ec5566d8de8c6199b21dfae45b00b22c5710dd1eecb07e676a55b3a2e
+  metadata.gz: 1e9bcdf11b686f9e5035d2d75e6ed92e412b7e7e05f085d06ef92166410d8329
+  data.tar.gz: f21daaea34d6422d4043f5078a34a08b904da8a25d5ba09d6bc4cd4d62254d0d
 SHA512:
-  metadata.gz: 44fa9815cb453c895d70db9912558f9b16cf775caaa83d1d723fde9252ced6a6c4a07072d0b0db8b352236a11701330af9ec0adf7de8bc94c41a89e96c6e5dfa
-  data.tar.gz: 993f3cb991245997f89827c4bd6581060b35eadd64d4c229419c5dbe6cbc1f8467319e66514c91af9d445bd683231144d8393419729b4ab513f7a7996ffe1854
+  metadata.gz: f89838a3639dcb7c3a0eee03b76f762b73a11494dac5af0e87b58e3f767a1a3b1c6e1d63b6084c5c5a6de29c971f17a7de09c905f3685d1150a2d0d18903e5da
+  data.tar.gz: 5b191bca2b91d8debfe0e55a7fb1e4dda0af1ab8df1d68ce83a92c9c99a59cafa8de0c6a6a210fd09de7826456a5cd8602dc38cddf12f70b9f07a635e4155c5e

data/.github/workflows/test.yml

@@ -12,7 +12,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0.1
+          ruby-version: 3.1.1
 
       - uses: actions/cache@v1
         with:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    heavylog (0.0.20)
+    heavylog (0.0.22)
       actionpack (>= 5)
       activesupport (>= 5)
       railties (>= 5)
@@ -10,93 +10,93 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.3.2)
-      actionview (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
-      rack (~> 2.0, >= 2.0.9)
+    actionpack (7.0.3.1)
+      actionview (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.3.2)
-      activesupport (= 6.1.3.2)
+    actionview (7.0.3.1)
+      activesupport (= 7.0.3.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.1.3.2)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
-    backport (1.1.2)
-    benchmark (0.1.1)
+    backport (1.2.0)
+    benchmark (0.2.0)
     builder (3.2.4)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.10)
     connection_pool (2.2.5)
     crass (1.0.6)
-    diff-lcs (1.4.4)
-    docile (1.3.5)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
     e2mmap (0.1.0)
     erubi (1.10.0)
-    i18n (1.8.10)
+    i18n (1.11.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    json (2.5.1)
-    kramdown (2.3.1)
+    json (2.6.2)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    loofah (2.9.1)
+    loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mini_portile2 (2.5.1)
-    minitest (5.14.4)
-    nokogiri (1.11.3)
-      mini_portile2 (~> 2.5.0)
+    mini_portile2 (2.8.0)
+    minitest (5.16.2)
+    nokogiri (1.13.7)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    parallel (1.20.1)
-    parser (3.0.1.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    racc (1.5.2)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
-    railties (6.1.3.2)
-      actionpack (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
+    railties (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       method_source
-      rake (>= 0.8.7)
+      rake (>= 12.2)
       thor (~> 1.0)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    redis (4.2.5)
-    regexp_parser (2.1.1)
-    request_store (1.5.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    redis (4.7.1)
+    regexp_parser (2.5.0)
+    request_store (1.5.1)
       rack (>= 1.4)
-    reverse_markdown (2.0.0)
+    reverse_markdown (2.1.1)
       nokogiri
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
     rubocop (0.93.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
@@ -106,12 +106,12 @@ GEM
       rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
     rubocop-performance (1.5.2)
       rubocop (>= 0.71.0)
     ruby-progressbar (1.11.0)
-    sidekiq (6.2.1)
+    sidekiq (6.5.1)
       connection_pool (>= 2.2.2)
       rack (~> 2.0)
       redis (>= 4.2.0)
@@ -120,10 +120,11 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    solargraph (0.40.4)
-      backport (~> 1.1)
+    solargraph (0.45.0)
+      backport (~> 1.2)
       benchmark
       bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
       e2mmap
       jaro_winkler (~> 1.5)
       kramdown (~> 2.3)
@@ -134,13 +135,15 @@ GEM
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
-    thor (1.1.0)
+    thor (1.2.1)
     tilt (2.0.10)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.7.0)
-    yard (0.9.26)
-    zeitwerk (2.4.2)
+    unicode-display_width (1.8.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   ruby

data/lib/heavylog/formatters/ecs.rb

@@ -11,11 +11,14 @@ module Heavylog
         "messages"           => "message",
         "request_id"         => "http.request.id",
         "method"             => "http.request.method",
-        "format"             => "http.request.mime_type",
+        "referrer"           => "http.request.referrer",
+        "format"             => "http.response.format",
         "status"             => "http.response.status_code",
         "location"           => "http.response.location",
         "ip"                 => "source.address",
+        "host"               => "url.domain",
         "path"               => "url.original",
+        "user_agent"         => "user_agent.original",
         "controller"         => "heavylog.controller",
         "action"             => "heavylog.action",
         "unpermitted_params" => "heavylog.unpermitted_params",
@@ -27,22 +30,38 @@ module Heavylog
 
       def call(data)
         ECS_MAP.each do |original, correct|
-          data[correct] = data.delete(original) if data[original]
+          dig_set(data, correct.split("."), data.delete(original)) if data.key?(original)
         end
 
-        data["event.module"] = "heavylog"
-        data["event.category"] = "web"
-        data["event.dataset"] ||= data["heavylog.controller"] == "SidekiqLogger" ? "heavylog.sidekiq" : "heavylog.rails"
+        dig_set(data, %w[event module], "heavylog")
+        dig_set(data, %w[event category], "web")
 
-        if data["http.response.status_code"]
-          data["event.outcome"] = (200..399).cover?(data["http.response.status_code"]) ? "success" : "failure"
+        unless data.dig("event", "dataset")
+          value = data.dig("heavylog", "controller") == "SidekiqLogger" ? "heavylog.sidekiq" : "heavylog.rails"
+          dig_set(data, %w[event dataset], value)
         end
 
-        data["source.ip"] ||= data["source.address"]
-        data["url.path"] ||= data["url.original"]
+        if (code = data.dig("http", "response", "status_code"))
+          dig_set(data, %w[event outcome], (200..399).cover?(code) ? "success" : "failure")
+        end
+
+        dig_set(data, %w[source ip], data.dig("source", "address")) unless data.dig("source", "ip")
+        dig_set(data, %w[url path], data.dig("url", "original")) unless data.dig("url", "path")
 
         ::JSON.dump(data)
       end
+
+      private
+
+      def dig_set(obj, keys, value)
+        key = keys.first
+        if keys.length == 1
+          obj[key] = value
+        else
+          obj[key] = {} unless obj[key]
+          dig_set(obj[key], keys.slice(1..-1), value)
+        end
+      end
     end
   end
 end

data/lib/heavylog/log_subscriber.rb

@@ -31,6 +31,7 @@ module Heavylog
       data.merge!(extract_runtimes(event, payload))
       data.merge!(extract_location)
       data.merge!(extract_unpermitted_params)
+      data.merge!(extract_request_data(payload))
       data.merge!(custom_options(event))
     end
 
@@ -59,11 +60,11 @@ module Heavylog
     end
 
     def extract_status(payload)
-      if (status = payload[:status])
-        { status: status.to_i }
-      elsif (error = payload[:exception])
+      if (error = payload[:exception])
         exception, message = error
-        { status: get_error_status_code(exception), error: "#{exception}: #{message}" }
+        { status: payload[:status] || get_error_status_code(exception), error: "#{exception}: #{message}" }
+      elsif (status = payload[:status])
+        { status: status.to_i }
       else
         { status: 0 }
       end
@@ -101,5 +102,19 @@ module Heavylog
       RequestStore.store[:heavylog_unpermitted_params] = nil
       { unpermitted_params: unpermitted_params }
     end
+
+    def extract_request_data(payload)
+      if payload[:request].is_a?(ActionDispatch::Request)
+        data = {}
+
+        data[:referrer] = payload[:request].referrer if payload[:request].referrer
+        data[:host] = payload[:request].host
+        data[:user_agent] = payload[:request].user_agent
+
+        return data
+      end
+
+      {}
+    end
   end
 end

data/lib/heavylog/middleware.rb

@@ -11,7 +11,9 @@ module Heavylog
     end
 
     def call(env)
-      ignore = @sprockets && env["PATH_INFO"] =~ @assets_regex
+      ignore = (@sprockets && env["PATH_INFO"] =~ @assets_regex) ||
+               (Heavylog.ignore_path && env["PATH_INFO"] =~ Heavylog.ignore_path)
+
       unless ignore
         request = ActionDispatch::Request.new(env)
         RequestStore.store[:heavylog_request_id] = request.uuid

data/lib/heavylog/railtie.rb

@@ -7,6 +7,7 @@ module Heavylog
     config.heavylog.path = "log/heavylog.log"
     config.heavylog.message_limit = 1024 * 1024 * 50 # 50MB
     config.heavylog.log_sidekiq = false
+    config.heavylog.ignore_path = nil
     config.heavylog.error_handler = lambda { |e|
       Kernel.puts "HeavyLog: Error writing to log: #{e.class}: #{e.message}\n  #{e.backtrace.join("\n  ")}"
     }

data/lib/heavylog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Heavylog
-  VERSION = "0.0.20"
+  VERSION = "0.0.23"
 end

data/lib/heavylog.rb

@@ -17,7 +17,7 @@ module Heavylog
   TRUNCATION = "[TRUNCATED]"
   ANSI_REGEX = /\e\[(\d+)m/.freeze
 
-  mattr_accessor :logger, :application, :formatter, :log_level
+  mattr_accessor :logger, :application, :formatter, :log_level, :ignore_path
 
   def setup(app)
     self.application = app
@@ -43,6 +43,7 @@ module Heavylog
 
     Heavylog.formatter = config.formatter || Heavylog::Formatters::Raw.new
     Heavylog.log_level = config.log_level || :info
+    Heavylog.ignore_path = config.ignore_path || nil
   end
 
   def attach_to_action_controller
@@ -53,7 +54,7 @@ module Heavylog
     return unless config.log_sidekiq
 
     Sidekiq.configure_server do |config|
-      config.options[:job_logger] = SidekiqLogger
+      config.job_logger = SidekiqLogger
     end
 
     Sidekiq.error_handlers << SidekiqExceptionHandler.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heavylog
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.23
 platform: ruby
 authors:
 - Kristjan Rang
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+date: 2022-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -214,7 +214,7 @@ homepage: https://github.com/krisrang/heavylog
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -229,8 +229,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Format all Rails logging per request
 test_files: []