onlylogs 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: baff3b51025f63d5ba3537ebf50f48c75478e64287ea98e9634d19fe070a42f5
-  data.tar.gz: 47c2a4a23cfbfe44c25e0fbdbb96413e49aac96fe7ff6695c3440ec00aa0b08b
+  metadata.gz: 54d4a10b4637cbbcf3daafb56170213a8bba06696127e2e87def0d71e50adc2d
+  data.tar.gz: 36fb3bca8a7520c90396f5791485c6566c63a8b9b07abb9e4611dca7982ac2ee
 SHA512:
-  metadata.gz: 1676249dd2d66f2b9b4032473313fac9306c2f05283dfa927c229af55f5ace1f7a740456231d15de5a92b7de5b7fc56a54ecdc643e1adc33e53718ec5e2befce
-  data.tar.gz: 73d9f8296c302d3c84d5ae74748a0ca6601c26f00722b33a1fe067f1c1e62810b6e70fac8825e04763de0640759caa785092ba56f8df69f3dc8bee0373150056
+  metadata.gz: 43e0af4fc1f92eb0a5b8c4ef7cea17310811bb816b942438dc72c1182c70ef76b4201c6d53d9d8f0f560bcf698b9e5f8119556404ca6da6917ff87ac6267142a
+  data.tar.gz: 6a6f1ac76f19c9c718064012ba3b3d9556ddd0b27b13c6ba1d58d48454fa454c8d3dbe564841cd20d9b7f14621d872d0bdc160ab6cfa1795e27725be6d6d2f7c

data/README.md

@@ -12,7 +12,13 @@ stream them to https://onlylogs.io and continue enjoying the same features.
 > [!IMPORTANT]
 > https://onlylogs.io is still in beta. Send us an email to a@renuo.ch if you want access to the platform.
 
-## Installation
+## Installation as self-hosted
+
+If you already have a disk, you can just keep there also your log files (as well as you probably already do).
+
+This section explains how to setup onlylogs to self host your logs and access them directly from your Rails app.
+
+If instead you want to stream your logs to https://onlylogs.io, head to the onlylogs.io instructions page.
 
 Add this line to your application's Gemfile:
 
@@ -63,6 +69,18 @@ Please be sure to secure them properly.
 > [!IMPORTANT]
 > By default, onlylogs endpoints are completely inaccessible until basic auth credentials are configured.
 
+### Notes about Docker
+
+If your app is running in a Docker container, for example with Kamal, remember to mount your logs folder:
+
+```yaml
+# config/deploy.yml
+volumes:
+- "storage:/rails/storage"
+- "cache:/rails/tmp/cache"
+- "logs:/rails/log"
+```
+
 ### Basic Authentication Setup
 
 Credentials can be configured using environment variables, Rails credentials, or programmatically.
@@ -254,6 +272,18 @@ Onlylogs.configure do |config|
 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.
+
+```ruby
+# config/environments/production.rb
+config.logger = Onlylogs::Logger.new(Rails.root.join("log", "production.log"))
+config.logger.formatter.denylist = [/health_check/, /ping/, /\.css\z/]
+```
+
+Any log message matching at least one pattern in the denylist will be silently dropped.
+
 ## Development & Contributing
 
 You are more than welcome to help and contribute to this package.  
@@ -292,6 +322,23 @@ For testing how onlylogs behaves under production-like network conditions, you c
 ./bin/simulate_latency disable
 ```
 
+### Performance Testing
+
+Performance tests require large log files that are not included in the repository. You can download them using the provided script:
+
+```bash
+bin/download_performance_fixtures
+```
+
+Once the fixtures are downloaded, you can run the performance tests locally:
+
+```bash
+bin/rails test test/models/onlylogs/grep_performance_test.rb
+```
+
+> [!NOTE]
+> Performance tests are automatically skipped in CI environments or if the large fixture files are missing.
+
 ### Plans for the future
 
 We believe that by simply analysing your logs you can also have a fancy errors report.

data/app/models/onlylogs/ansi_color_parser.rb

@@ -35,7 +35,7 @@ module Onlylogs
     }.freeze
 
     # Pre-built closing span (frozen for better performance)
-    CLOSING_SPAN = '</span>'.freeze
+    CLOSING_SPAN = "</span>".freeze
 
     def self.parse(string)
       return string if string.blank?

data/app/models/onlylogs/batch_sender.rb

@@ -55,13 +55,13 @@ module Onlylogs
 
     def send_batch
       lines_to_send = nil
-      
+
       @mutex.synchronize do
         return if @buffer.empty?
         lines_to_send = @buffer.dup
         @buffer.clear
       end
-      
+
       return if lines_to_send.empty?
 
       @channel.send(:transmit, {

data/app/models/onlylogs/file_path_parser.rb

@@ -9,10 +9,10 @@ module Onlylogs
       { symbols: [ :atom ], sniff: /atom/i, url: "atom://core/open/file?filename=%{file}&line=%{line}" },
       { symbols: [ :emacs, :emacsclient ], sniff: /emacs/i, url: "emacs://open?url=file://%{file}&line=%{line}" },
       { symbols: [ :idea ], sniff: /idea/i, url: "idea://open?file=%{file}&line=%{line}" },
-      { symbols: [ :macvim, :mvim ], sniff: /vim/i, url: "mvim://open?url=file://%{file_unencoded}&line=%{line}" },
-      { symbols: [ :rubymine ], sniff: /mine/i, url: "x-mine://open?file=%{file}&line=%{line}" },
+      { symbols: [ :macvim, :mvim, :vim ], sniff: /vim/i, url: "mvim://open?url=file://%{file_unencoded}&line=%{line}" },
+      { symbols: [ :rubymine, :mine ], sniff: /mine/i, url: "x-mine://open?file=%{file}&line=%{line}" },
       { symbols: [ :sublime, :subl, :st ], sniff: /subl/i, url: "subl://open?url=file://%{file}&line=%{line}" },
-      { symbols: [ :textmate, :txmt, :tm ], sniff: /mate/i, url: "txmt://open?url=file://%{file}&line=%{line}" },
+      { symbols: [ :textmate, :txmt, :tm, :mate ], sniff: /mate/i, url: "txmt://open?url=file://%{file}&line=%{line}" },
       { symbols: [ :vscode, :code ], sniff: /code/i, url: "vscode://file/%{file}:%{line}" },
       { symbols: [ :vscodium, :codium ], sniff: /codium/i, url: "vscodium://file/%{file}:%{line}" }
     ].freeze
@@ -46,7 +46,11 @@ module Onlylogs
 
     def self.for_formatting_string(formatting_string)
       new proc { |file, line|
-        formatting_string % { file: URI.encode_www_form_component(file), file_unencoded: file, line: line }
+        formatting_string % {
+          file: URI.encode_www_form_component(file),
+          file_unencoded: file,
+          line: line
+        }
       }
     end
 
@@ -57,11 +61,18 @@ module Onlylogs
     # Cache for the editor instance
     @cached_editor_instance = nil
 
+    def self.clear_editor_cache
+      @cached_editor_instance = nil
+    end
+
     def self.cached_editor_instance
-      return @cached_editor_instance if @cached_editor_instance      
-      @cached_editor_instance = editor_from_symbol(Onlylogs.editor)      
+      @cached_editor_instance ||= if ENV["ONLYLOGS_EDITOR_URL"]
+        for_formatting_string(ENV["ONLYLOGS_EDITOR_URL"])
+      else
+        editor_from_symbol(Onlylogs.editor)
+      end
     end
-    
+
 
     def self.editor_from_symbol(symbol)
       KNOWN_EDITORS.each do |preset|

data/app/views/layouts/onlylogs/application.html.erb

@@ -7,7 +7,9 @@
 
   <%= yield :head %>
 
-  <%= javascript_importmap_tags "application", importmap: Onlylogs.importmap  %>
+  <% if defined?(Importmap) %>
+    <%= javascript_importmap_tags "application", importmap: Onlylogs.importmap  %>
+  <% end %>
   
   <style>
     html, body {

data/app/views/onlylogs/shared/_log_container.html.erb

@@ -1,32 +1,33 @@
 <%# locals: (log_file_path:, tail: 100, filter: "", autoscroll: true) %>
-<script src="https://cdn.jsdelivr.net/npm/clusterize.js@0.18.1/clusterize.min.js"></script>
+<script nonce="<%= request.content_security_policy_nonce %>"
+        src="https://cdn.jsdelivr.net/npm/clusterize.js@0.18.1/clusterize.min.js"></script>
 <%= render "onlylogs/shared/log_container_styles" %>
 
 <%
     mode = filter.blank? ? "live" : "search"
     cursor_position = mode == "search" ? 0 : [File.size(log_file_path) - (tail * 100), 0].max
-     
+
     raise SecurityError, "File path not allowed" unless Onlylogs.allowed_file_path?(log_file_path)
-        
+
     encrypted_log_file_path = Onlylogs::SecureFilePath.encrypt(log_file_path)
 %>
 
 <div data-controller="log-streamer text-selection keyboard-shortcuts"
-     data-log-streamer-file-path-value="<%= encrypted_log_file_path %>"     
+     data-log-streamer-file-path-value="<%= encrypted_log_file_path %>"
      data-log-streamer-cursor-position-value="<%= cursor_position %>"
      data-log-streamer-filter-value="<%= filter %>"
-     data-log-streamer-auto-scroll-value="<%= autoscroll %>"     
+     data-log-streamer-auto-scroll-value="<%= autoscroll %>"
      data-log-streamer-mode-value="<%= mode %>"
      class="onlylogs-log-container" >
     <div data-log-streamer-target="logLines" data-text-selection-target="logLines" id="scrollArea" class="onlylogs-log-lines clusterize-scroll">
       <div id="contentArea" class="clusterize-content">
       </div>
     </div>
-    
-    <button type="button" 
-            data-text-selection-target="button" 
-            class="onlylogs-context-menu" 
-            data-action="click->text-selection#searchSelectedText" 
+
+    <button type="button"
+            data-text-selection-target="button"
+            class="onlylogs-context-menu"
+            data-action="click->text-selection#searchSelectedText"
             title="Search selected text"
             style="display: none;">
       🔍 Search
@@ -55,15 +56,15 @@
           <label style="margin-bottom: 0;">
             Filter:
             <div style="display: inline-flex; align-items: center; position: relative;">
-              <input type="text" 
-                     name="filter" 
+              <input type="text"
+                     name="filter"
                      value="<%= filter %>"
                      placeholder="Enter filter text..."
                      data-log-streamer-target="filterInput"
                      data-text-selection-target="filterInput"
                      data-action="input->log-streamer#applyFilter"
                      style="padding-right: 1.5rem;">
-              <button type="button"                       
+              <button type="button"
                       data-action="click->log-streamer#clearFilter"
                       class="clear-filter-button"
                       title="Clear filter">
@@ -73,7 +74,7 @@
           </label>
         </div>
         <div>
-          <button type="button" 
+          <button type="button"
                   data-log-streamer-target="stopButton"
                   data-action="click->log-streamer#stopSearch"
                   class="stop-search-button"
@@ -93,7 +94,7 @@
           <%= number_to_human_size(File.size(log_file_path)) %>
         </div>
         <div style="width:67px">
-          <button type="button" 
+          <button type="button"
                   data-log-streamer-target="clearButton"
                   data-action="click->log-streamer#clearLogs"
                   class="clear-logs-button"

data/config/importmap.rb

@@ -3,4 +3,3 @@ pin "@rails/actioncable", to: "actioncable.esm.js"
 pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true
 pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", preload: true
 pin_all_from Onlylogs::Engine.root.join("app/javascript/onlylogs/controllers"), under: "controllers", to: "onlylogs/controllers"
-

data/lib/onlylogs/configuration.rb

@@ -14,7 +14,7 @@ module Onlylogs
       @parent_controller = nil
       @disable_basic_authentication = false
       @ripgrep_enabled = default_ripgrep_enabled
-      @editor = default_editor
+      @editor = nil
       @max_line_matches = 100000
     end
 
@@ -26,20 +26,20 @@ module Onlylogs
       if (credentials_editor = Rails.application.credentials.dig(:onlylogs, :editor))
         return credentials_editor
       end
-      
+
       # 2. Check environment variables (ONLYLOGS_EDITOR > RAILS_EDITOR > EDITOR)
       if ENV["ONLYLOGS_EDITOR"]
         return ENV["ONLYLOGS_EDITOR"].to_sym
       end
-      
+
       if ENV["RAILS_EDITOR"]
         return ENV["RAILS_EDITOR"].to_sym
       end
-      
+
       if ENV["EDITOR"]
         return ENV["EDITOR"].to_sym
       end
-      
+
       # 3. Default fallback
       :vscode
     end
@@ -114,7 +114,7 @@ module Onlylogs
   end
 
   def self.editor
-    configuration.default_editor
+    configuration.editor || configuration.default_editor
   end
 
   def self.editor=(editor_symbol)

data/lib/onlylogs/engine.rb

@@ -1,4 +1,8 @@
-require "importmap-rails"
+begin
+  require "importmap-rails"
+rescue LoadError
+  # importmap-rails is optional
+end
 
 module Onlylogs
   class Engine < ::Rails::Engine
@@ -14,14 +18,15 @@ module Onlylogs
       app.config.assets.precompile += %w[ onlylogs_manifest ]
     end
 
+    if defined?(Importmap)
+      initializer "onlylogs.importmap", after: "importmap" do |app|
+        Onlylogs.importmap.draw(root.join("config/importmap.rb"))
+        if app.config.importmap.sweep_cache && app.config.reloading_enabled?
+          Onlylogs.importmap.cache_sweeper(watches: root.join("app/javascript"))
 
-    initializer "onlylogs.importmap", after: "importmap" do |app|
-      Onlylogs.importmap.draw(root.join("config/importmap.rb"))
-      if app.config.importmap.sweep_cache && app.config.reloading_enabled?
-        Onlylogs.importmap.cache_sweeper(watches: root.join("app/javascript"))
-
-        ActiveSupport.on_load(:action_controller_base) do
-          before_action { Onlylogs.importmap.cache_sweeper.execute_if_updated }
+          ActiveSupport.on_load(:action_controller_base) do
+            before_action { Onlylogs.importmap.cache_sweeper.execute_if_updated }
+          end
         end
       end
     end

data/lib/onlylogs/formatter.rb

@@ -2,8 +2,16 @@ module Onlylogs
   class Formatter < ActiveSupport::Logger::SimpleFormatter
     include ActiveSupport::TaggedLogging::Formatter
 
+    attr_accessor :denylist
+
+    def initialize
+      super
+      @denylist = []
+    end
+
     def call(severity, time, progname, msg)
       return nil if "Onlylogs::LogsChannel".in?(msg)
+      return nil if denylist.any? { |pattern| pattern.match?(msg) }
       tags = [ time.iso8601, severity[0].upcase ]
       push_tags tags
       str = super

data/lib/onlylogs/socket_logger.rb

@@ -18,7 +18,6 @@ module Onlylogs
     end
 
     def add(severity, message = nil, progname = nil, &block)
-
       if message.nil?
         if block_given?
           message = block.call
@@ -44,7 +43,7 @@ module Onlylogs
       puts "Onlylogs::SocketLogger error: #{e.message}"
       reconnect_socket
     rescue => e
-      puts"Onlylogs::SocketLogger unexpected error: #{e.class}: #{e.message}"
+      puts "Onlylogs::SocketLogger unexpected error: #{e.class}: #{e.message}"
       reconnect_socket
     end
 

data/lib/onlylogs/version.rb

@@ -1,3 +1,3 @@
 module Onlylogs
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/onlylogs.rb

@@ -13,5 +13,7 @@ require "onlylogs/socket_logger"
 # loader.setup
 
 module Onlylogs
-  mattr_accessor :importmap, default: Importmap::Map.new
+  if defined?(Importmap)
+    mattr_accessor :importmap, default: Importmap::Map.new
+  end
 end

metadata

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