onlylogs 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e6b4ee2fde339a248ff9e15557c8bb8f0ea525b3807aa09b157e537057c0c7a
-  data.tar.gz: 208543eb460dc3f7c302fac4d4bd3277c710e402346f759c7e66c1b2dfc7049b
+  metadata.gz: f166264d89c5d2273751e3377ef236168da610b1d37d5ddf02d33959f2fe318d
+  data.tar.gz: a612d6738ee600171cd21a78b403d1abef06fdf5df893ebcc8c3401b092f6a51
 SHA512:
-  metadata.gz: 4b47a580f758cacca9c34b1de0ebe445ff4db5df1e45f6e515cd80b1dd866d3dbbb39d7aea7862b94ee46e5d18cd39797fbadcb202e59745bcb94fb0a62da2b7
-  data.tar.gz: 8956f328a31a63cbf07a180a51ffa612c516f51ae37523bba49f6a41557a14ae35a83d91bc1bcc05b465bedd6cbc61cbffb8a402822a27b17d534668acd65211
+  metadata.gz: 6c2d38d16486ea48cd8e6c695e1b9234dbe8e300f45342afa163adfef2e532cdf1cf0cdecdca411c9a13a80c6c4f32aa5c33a82dfc9137c2da35f72cffa0f2c6
+  data.tar.gz: d4b8b016e5c089712e288d6533b613571f5edee524b2784a3aff80b4d8701913aabb169f72cdedb4220c01a86f3be33d0c52eedc644538db1a3fe3e259e947c9

data/README.md

@@ -272,6 +272,22 @@ Onlylogs.configure do |config|
 end
 ```
 
+#### Bounding How Long a Viewer Search Can Run
+
+Searches started from the log viewer stop after `search_timeout` seconds, keeping whatever they
+found and reporting that they did not reach the end of the file. The default is 120 seconds:
+
+```ruby
+# config/initializers/onlylogs.rb
+Onlylogs.configure do |config|
+  config.search_timeout = 300
+
+  # Or remove the ceiling entirely (a search then holds a CPU until it reaches
+  # the end of the file, however large it is)
+  config.search_timeout = nil
+end
+```
+
 ### Filtering Log Lines with a Denylist
 
 The `Onlylogs::Formatter` supports a denylist: an array of regular expressions that prevents matching lines from being logged. This is useful for filtering out noisy or irrelevant entries like health checks or asset requests.

data/app/channels/onlylogs/logs_channel.rb

@@ -173,7 +173,8 @@ module Onlylogs
 
           if filter.present?
             # Use grep for filtered search
-            @log_file.grep(filter, regexp_mode: regexp_mode, start_position: start_position, end_position: end_position) do |result|
+            @log_file.grep(filter, regexp_mode: regexp_mode, start_position: start_position,
+              end_position: end_position, timeout: Onlylogs.search_timeout) do |result|
               break if @batch_sender.nil? || @log_watcher_running == false
 
               # Skip first line if start_position > 0 (line is cut off at byte boundary)
@@ -234,6 +235,11 @@ module Onlylogs
         else
           transmit({action: "finish", content: "Search finished."})
         end
+      rescue Onlylogs::Grep::TimeoutError
+        @batch_sender&.stop
+        transmit({action: "finish",
+                  content: "Search stopped after #{Onlylogs.search_timeout} seconds and did not reach " \
+                           "the end of the file. Narrow the range or the filter and search again."})
       ensure
         # Always cleanup even if interrupted or error occurs
         @batch_sender&.stop

data/app/models/onlylogs/grep.rb

@@ -29,7 +29,11 @@ module Onlylogs
         ->(line) { [nil, line] }
       end
 
-      begin
+      matches = 0
+
+      ActiveSupport::Notifications.instrument("search.onlylogs", file_path: file_path,
+        query: pattern, regexp: regexp_mode, start_position: start_position,
+        end_position: end_position, max_matches: max_matches) do |payload|
         each_output_line(command_args, timeout: timeout) do |line|
           byte_offset, content = parse_line.call(line.chomp)
 
@@ -37,6 +41,7 @@ module Onlylogs
           content = String.new(content, encoding: Encoding::UTF_8).scrub
 
           result = {byte_offset: byte_offset, content: content}
+          matches += 1
 
           if block_given?
             yield result
@@ -44,7 +49,12 @@ module Onlylogs
             results << result
           end
         end
+      rescue TimeoutError
+        payload[:timed_out] = true
+        raise
       ensure
+        payload[:matches] = matches
+        payload[:timed_out] ||= false
         drop_page_cache(file_path)
       end
 

data/lib/onlylogs/configuration.rb

@@ -4,7 +4,14 @@ module Onlylogs
   class Configuration
     attr_accessor :log_file_patterns, :default_log_file_path, :basic_auth_user, :basic_auth_password,
       :parent_controller, :disable_basic_authentication, :ripgrep_enabled, :editor,
-      :max_line_matches
+      :max_line_matches, :search_timeout
+
+    # Seconds a viewer search may run before it is stopped. Bounded by default:
+    # a search holds a CPU for as long as it runs, and an unbounded one over a
+    # multi-GB file can starve everything else the host is doing. Generous
+    # enough for a full scan of a large file - set it to nil to remove the
+    # ceiling entirely.
+    DEFAULT_SEARCH_TIMEOUT = 120
 
     def initialize
       @log_file_patterns = default_log_file_patterns
@@ -16,6 +23,7 @@ module Onlylogs
       @ripgrep_enabled = default_ripgrep_enabled
       @editor = nil
       @max_line_matches = 100000
+      @search_timeout = DEFAULT_SEARCH_TIMEOUT
     end
 
     def configure
@@ -147,6 +155,10 @@ module Onlylogs
     configuration.max_line_matches
   end
 
+  def self.search_timeout
+    configuration.search_timeout
+  end
+
   def self.allowed_file_patterns_for(pattern)
     absolute_pattern = ::File.expand_path(pattern.to_s)
     if glob_pattern?(absolute_pattern)

data/lib/onlylogs/version.rb

@@ -1,3 +1,3 @@
 module Onlylogs
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlylogs
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Alessandro Rodi