onlylogs 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9303c9ba4c727343d48702332baef85d112068f0639a148ff42afc8693b1f7af
-  data.tar.gz: 82fe3f9d70cfc3b2d4a6f661a296974037aca9fd8bd8e97317476bb091d3c320
+  metadata.gz: 4707246899a958c58bf6ea58aba6f21234d938c660ce23dbad8df598654a4b5c
+  data.tar.gz: c46cf3df22e80cd90749bf144f62a271a9556b13ee718640377aa86f34608e05
 SHA512:
-  metadata.gz: d7bf3497e6013d367776e50e716d113781cdde78b79d302b01a126778092aa36fb0f025c93162301b4f9444d9be83bd30ebd2b832d3e3e5da29d6ed721bd6138
-  data.tar.gz: 879705e6eb4dafe29e1bf1698495cfb0731ccefc13f3127547a45173e4fdc6beda4ea53c13b4406ae6c3d1ba10ffe36f3b2f21bf1a7e3ff17adf195b5161170f
+  metadata.gz: 7eabe1b6124704eee89f759001cb7df9bf8fa5bb71ad98ac9c26bbc091db38c93ee3c7fdb4b35729f33cc9eeb2d0ac3170b2d2ef11ae5b979b7ec454664bc435
+  data.tar.gz: fa8226aa140b44b8eac0f3a03000aac95615470343d90de827d98da79ba4045c776b052171b3555ef955db2747dc760640cd787f6207ae95f6e67e70e152dca1

data/README.md

@@ -58,6 +58,33 @@ Here you can grep your logs with regular expressions.
 > If ripgrep is not installed, onlylogs falls back to `grep`. 
 > A warning icon (⚠️) will be displayed in the toolbar when using `grep` to indicate slower search performance.
 
+## Logging in production
+
+Rails apps log to `STDOUT` in production and let the platform collect the stream.
+onlylogs keeps that default: `Onlylogs::HttpLogger.new` writes every line to `$stdout` and, when
+`ONLYLOGS_DRAIN_URL` is set, ships it to https://onlylogs.io as well. Nothing is written to disk.
+
+```ruby
+# config/environments/production.rb
+config.logger = Onlylogs::HttpLogger.new
+```
+
+Keep this default on an **ephemeral filesystem** (Heroku, Deploio, Docker, Kubernetes). A log file
+there is lost on every deploy and, while it grows, its page cache counts towards the container's
+memory limit: it shows up as a memory leak that resets on each release.
+
+If you have a **persistent disk** and want the files, for instance to browse them with the engine,
+pass a rotating log device as the local fallback. Rails rotates at 100 MB in development, which is a
+good size here too:
+
+```ruby
+# config/environments/production.rb
+log_file = Logger::LogDevice.new(Rails.root.join("log", "production.log"), shift_age: 5, shift_size: 100.megabytes)
+config.logger = Onlylogs::HttpLogger.new(local_fallback: log_file)
+```
+
+Any IO or log device works and is used as is. `Onlylogs::SocketLogger` accepts the same argument.
+
 ## Authentication
 
 Yes, we should do this right away, because this engine gives access to your log files, so you want to be sure.
@@ -294,7 +321,7 @@ The `Onlylogs::Formatter` supports a denylist: an array of regular expressions t
 
 ```ruby
 # config/environments/production.rb
-config.logger = Onlylogs::Logger.new(Rails.root.join("log", "production.log"))
+config.logger = Onlylogs::HttpLogger.new
 config.logger.formatter.denylist = [/health_check/, /ping/, /\.css\z/]
 ```
 

data/app/channels/onlylogs/logs_channel.rb

@@ -92,6 +92,10 @@ module Onlylogs
     # an explicit cursor (matches the default whole-file live-mode page load).
     LIVE_TAIL_BYTES = 10_000
 
+    # The button re-runs the viewer's own reset, which reopens the file at its current tail.
+    ROTATED_MESSAGE = 'The file was rotated. <button type="button" class="reload-button" ' \
+      'data-action="click->log-streamer#reset">Reload</button>'
+
     def start_log_watcher(file_path, filter = nil, regexp_mode = false)
       return if @log_watcher_running
 
@@ -130,6 +134,10 @@ module Onlylogs
               })
             end
           end
+
+          # watch returns on its own only when the file was rotated: nothing more will
+          # arrive under this name from where we are, so the viewer has to start over.
+          transmit({action: "finish", content: ROTATED_MESSAGE}) if @log_watcher_running
         end
       rescue => e
         Rails.logger.error "Log watcher error: #{e.message}"

data/app/javascript/onlylogs/controllers/log_streamer_controller.js

@@ -7,6 +7,8 @@ export default class LogStreamerController extends Controller {
     autoScroll: { type: Boolean, default: true },
     filter: { type: String, default: '' },
     mode: { type: String, default: 'live' },
+    // false for a file nothing writes to any more: the viewer only searches, never tails.
+    liveEnabled: { type: Boolean, default: true },
     regexpMode: { type: Boolean, default: false },
     fileSize: { type: Number, default: 0 },
     startPosition: { type: Number, default: 0 },
@@ -125,7 +127,7 @@ export default class LogStreamerController extends Controller {
   }
 
   switchToLive() {
-    if (this.isLiveMode()) return;
+    if (this.isLiveMode() || !this.liveEnabledValue) return;
 
     this.#clearHighlighting();
     this.#setMode('live');
@@ -178,8 +180,11 @@ export default class LogStreamerController extends Controller {
   // The only writer of modeValue. Everything that changes the mode goes through
   // here so the switch, the URL and the toolbar layout can never disagree.
   #setMode(mode) {
+    if (mode === 'live' && !this.liveEnabledValue) return;
+
     this.modeValue = mode;
-    this.#updateUrlParam('mode', mode === 'live' ? null : 'static');
+    // Search is the only mode when live is disabled, so the URL need not say so.
+    this.#updateUrlParam('mode', mode === 'live' || !this.liveEnabledValue ? null : 'static');
     this.#liveFilterStartedAt = mode === 'live' ? new Date() : null;
     this.#syncModeControls();
   }
@@ -435,8 +440,9 @@ export default class LogStreamerController extends Controller {
     const end = endParam ? parseInt(endParam) : this.fileSizeValue;
     this.#setRange(start, end);
 
-    // Calculate mode: check mode param, default to live
-    this.modeValue = params.get('mode') === 'static' ? 'static' : 'live';
+    // Calculate mode: check mode param, default to live unless live is disabled
+    const wantsStatic = params.get('mode') === 'static' || !this.liveEnabledValue;
+    this.modeValue = wantsStatic ? 'static' : 'live';
     this.#liveFilterStartedAt = this.isLiveMode() ? new Date() : null;
     this.#syncModeControls();
   }

data/app/models/onlylogs/file.rb

@@ -8,6 +8,7 @@ module Onlylogs
       self.path = path
       self.last_position = last_position
       validate!
+      @inode = ::File.stat(path).ino
     end
 
     def go_to_position(position)
@@ -16,11 +17,12 @@ module Onlylogs
       self.last_position = position
     end
 
+    # Yields new lines until the file is rotated away from under its name; then
+    # returns, since the position no longer means anything on the file now there.
     def watch(&block)
-      # return enum_for(:watch) unless block
-
       loop do
         sleep 0.5
+        return if rotated?
 
         new_lines = read_new_lines
         next if new_lines.empty?
@@ -29,6 +31,15 @@ module Onlylogs
       end
     end
 
+    # A rename rotation puts another inode under the name, a copytruncate rotation
+    # keeps the inode but makes the file smaller than what was already read.
+    def rotated?
+      return true unless exist?
+
+      stat = ::File.stat(path)
+      stat.ino != @inode || stat.size < last_position
+    end
+
     def size
       ::File.size(path)
     end

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

@@ -1,4 +1,4 @@
-<%# locals: (log_file_path:) %>
+<%# locals: (log_file_path:, live_enabled: true) %>
 <script nonce="<%= request.content_security_policy_nonce %>"
         src="<%= asset_path('onlylogs/clusterize.js') %>"></script>
 <link rel="stylesheet" href="<%= asset_path('onlylogs/clusterize.css') %>" />
@@ -8,7 +8,9 @@
     autoscroll = local_assigns[:autoscroll] != false
     filter = local_assigns[:filter] || ""
     regexp_mode = local_assigns[:regexp_mode] == true
-    mode = local_assigns[:mode] || "live"
+    # A file nothing writes to any more (no drain attached, a rotated log) has nothing
+    # to follow, so live mode is not offered at all and the viewer opens in search.
+    mode = live_enabled ? (local_assigns[:mode] || "live") : "static"
     file_size = File.size(log_file_path)
     start_position = local_assigns[:start_position]
     end_position = local_assigns[:end_position]
@@ -27,6 +29,7 @@
      data-log-streamer-auto-scroll-value="<%= autoscroll %>"
      data-log-streamer-regexp-mode-value="<%= regexp_mode %>"
      data-log-streamer-mode-value="<%= mode %>"
+     data-log-streamer-live-enabled-value="<%= live_enabled %>"
      data-log-streamer-file-size-value="<%= file_size %>"
      data-action="text-selection:start->log-streamer#pauseForSelection text-selection:search->log-streamer#switchToSearch"
      class="onlylogs-log-container" >
@@ -39,7 +42,13 @@
         at all until something is typed. This says so instead of looking idle. %>
     <div class="onlylogs-search-placeholder" data-log-streamer-target="searchPlaceholder" hidden>
       <p class="onlylogs-search-placeholder__title">Nothing to search for yet</p>
-      <p class="onlylogs-search-placeholder__hint">Type a query to search this file, or switch to Live to follow it as it is written.</p>
+      <p class="onlylogs-search-placeholder__hint">
+        <% if live_enabled %>
+          Type a query to search this file, or switch to Live to follow it as it is written.
+        <% else %>
+          Type a query to search this file.
+        <% end %>
+      </p>
     </div>
 
     <button type="button"
@@ -52,6 +61,7 @@
 
     <div class="onlylogs-log-toolbar">
       <div class="onlylogs-toolbar-row onlylogs-toolbar-row--controls">
+        <% if live_enabled %>
         <div class="onlylogs-mode-switch" role="group" aria-label="Log mode">
           <button type="button"
                   class="onlylogs-mode-switch__button"
@@ -74,6 +84,7 @@
             <span>🔍 <u>S</u>earch</span>
           </button>
         </div>
+        <% end %>
         <div>
           <label class="toolbar-label">
             <span data-onlylogs-mode="live">Follow:</span>

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

@@ -242,7 +242,8 @@
             background-color: var(--ol-accent);
           }
 
-          .search-whole-file-button {
+          .search-whole-file-button,
+          .reload-button {
             font: inherit;
             border: 1px solid var(--ol-accent-border);
             background-color: var(--ol-accent-soft);

data/lib/onlylogs/version.rb

@@ -1,3 +1,3 @@
 module Onlylogs
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

metadata

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