systemd-journal 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5c615cee8de41012105d99aec5b93f8c88f322b67bbf4d97bcb4afbd74cec35
-  data.tar.gz: 84447c503addd9fc6c3c6564472e7eb1558f6e6a184a98214c604feb2649ecea
+  metadata.gz: 7645b91580b12afef524d1ef0b89e515f5d656e7f4e2e5cd0ffccfaa3fa84db5
+  data.tar.gz: 385370380f9a850cb8c7332034ea0222ff7ef9fc6bc6d3089c54543f6cfd1784
 SHA512:
-  metadata.gz: dd1375594a013f9d237c0a62f5c4aed77f80b54637e1275cf32565905fde72187eb08feefc4d93129a3a942949de93d2f037b0af2893e95f52c006d682e32b39
-  data.tar.gz: 9debfc4954cc65ddf9fda2d448c30b67c0995cf2ad554dcfb00b067103218a5898d8d9f619e6b04236d184742397d64b5365efbbd90cb0be6f26a25cbeb8887b
+  metadata.gz: 8b04180f1b9215ceb0711b7a03b23fbb26cea7a9e35add3bc3c5e3151b0ac29bb5fcbb213c58bdc8d0c526395bbf2bad843e54602abc2669ed623815366f7e97
+  data.tar.gz: ffe8e22c89d32ec57b13300514717c79993fa67f8516c9b1eb54793b4201097f7d3e9a16ba1c16f9fed10e078c76ee2be999b4598eeb7820dc19b68ce2400f36

data/.github/workflows/ruby.yml

@@ -1,5 +1,5 @@
 name: RSpec Matrix
-on: [push]
+on: [push, pull_request]
 jobs:
   test:
     strategy:

data/README.md

@@ -80,6 +80,16 @@ j.current_entry # get the entry we're currently positioned at
 j.seek(Time.parse('2013-10-31T12:00:00+04:00:00'))
 ```
 
+Re-open the journal automatically to reduce memory usage with moving the journal:
+
+```ruby
+Journal.new(auto_reopen: false) # do not ever re-open the journal.
+                                # this should be the default for now
+
+Journal.new(auto_reopen: true)   # re-open the journal after the default ITERATIONS_TO_AUTO_REOPEN
+Journal.new(auto_reopen: 50_000) # re-open the journal after 50k iterations
+```
+
 Waiting for things to happen:
 
 ```ruby

data/lib/systemd/journal/navigable.rb

@@ -1,6 +1,9 @@
 module Systemd
   class Journal
     module Navigable
+      ITERATIONS_TO_AUTO_REOPEN = 10_000
+      private_constant :ITERATIONS_TO_AUTO_REOPEN
+
       # returns a string representing the current read position.
       # This string can be passed to {#seek} or {#cursor?}.
       # @return [String] a cursor token.
@@ -40,9 +43,11 @@ module Systemd
       # @return [Boolean] False if unable to move to the next entry, indicating
       #   that the pointer has reached the end of the journal.
       def move_next
-        rc = Native.sd_journal_next(@ptr)
-        raise JournalError, rc if rc < 0
-        rc > 0
+        with_auto_reopen {
+          rc = Native.sd_journal_next(@ptr)
+          raise JournalError, rc if rc < 0
+          rc > 0
+        }
       end
 
       # Move the read pointer forward by `amount` entries.
@@ -50,9 +55,11 @@ module Systemd
       #   moved. If this number is less than the requested amount, the read
       #   pointer has reached the end of the journal.
       def move_next_skip(amount)
-        rc = Native.sd_journal_next_skip(@ptr, amount)
-        raise JournalError, rc if rc < 0
-        rc
+        with_auto_reopen {
+          rc = Native.sd_journal_next_skip(@ptr, amount)
+          raise JournalError, rc if rc < 0
+          rc
+        }
       end
 
       # Move the read pointer to the previous entry in the journal.
@@ -60,9 +67,11 @@ module Systemd
       # @return [Boolean] False if unable to move to the previous entry,
       #   indicating that the pointer has reached the beginning of the journal.
       def move_previous
-        rc = Native.sd_journal_previous(@ptr)
-        raise JournalError, rc if rc < 0
-        rc > 0
+        with_auto_reopen {
+          rc = Native.sd_journal_previous(@ptr)
+          raise JournalError, rc if rc < 0
+          rc > 0
+        }
       end
 
       # Move the read pointer backwards by `amount` entries.
@@ -70,9 +79,11 @@ module Systemd
       #   was moved.  If this number is less than the requested amount, the
       #   read pointer has reached the beginning of the journal.
       def move_previous_skip(amount)
-        rc = Native.sd_journal_previous_skip(@ptr, amount)
-        raise JournalError, rc if rc < 0
-        rc
+        with_auto_reopen {
+          rc = Native.sd_journal_previous_skip(@ptr, amount)
+          raise JournalError, rc if rc < 0
+          rc
+        }
       end
 
       # Seek to a position in the journal.
@@ -90,7 +101,7 @@ module Systemd
       #   and seek to that entry.
       # @return [True]
       # @example Read last journal entry
-      #   j = Systemd::Joural.new
+      #   j = Systemd::Journal.new
       #   j.seek(:tail)
       #   j.move_previous
       #   puts j.current_entry
@@ -115,6 +126,35 @@ module Systemd
 
         true
       end
+
+      private
+
+      # reopen the journal automatically due to reduce memory usage
+      def with_auto_reopen
+        @sd_call_count ||= 0
+
+        ret = yield
+
+        if auto_reopen
+          @sd_call_count += 1
+          if @sd_call_count >= auto_reopen
+            cursor = self.cursor
+
+            self.close
+            self.initialize(@reopen_options)
+
+            self.seek(cursor)
+            # To avoid 'Cannot assign requested address' error
+            # It invokes native API directly to avoid nest with_auto_reopen calls
+            rc = Native.sd_journal_next_skip(@ptr, 0)
+            raise JournalError, rc if rc < 0
+
+            @sd_call_count = 0
+          end
+        end
+
+        ret
+      end
     end
   end
 end

data/lib/systemd/journal/version.rb

@@ -1,6 +1,6 @@
 module Systemd
   class Journal
     # The version of the systemd-journal gem.
-    VERSION = '2.0.0'.freeze
+    VERSION = '2.1.0'.freeze
   end
 end

data/lib/systemd/journal.rb

@@ -26,11 +26,14 @@ module Systemd
     include Systemd::Journal::Filterable
     include Systemd::Journal::Waitable
 
+    # Returns the iterations to auto reopen
+    attr_reader :auto_reopen
+
     # Returns a new instance of a Journal, opened with the provided options.
     # @param [Hash] opts optional initialization parameters.
     # @option opts [Integer] :flags a set of bitwise OR-ed
     #   {Systemd::Journal::Flags} which control what journal files are opened.
-    #   Defaults to `0`, meaning all journals avaiable to the current user.
+    #   Defaults to `0`, meaning all journals available to the current user.
     # @option opts [String] :path if provided, open the journal files living
     #   in the provided directory only.  Any provided flags will be ignored
     #   since sd_journal_open_directory does not currently accept any flags.
@@ -46,9 +49,14 @@ module Systemd
     #     path: '/var/log/journal/5f5777e46c5f4131bd9b71cbed6b9abf'
     #   )
     def initialize(opts = {})
+      @reopen_options = opts.dup # retain the options for auto reopen
       open_type, flags = validate_options!(opts)
       ptr = FFI::MemoryPointer.new(:pointer, 1)
 
+      @auto_reopen = (opts.key?(:auto_reopen) ? opts.delete(:auto_reopen) : false)
+      if @auto_reopen
+        @auto_reopen = @auto_reopen.is_a?(Integer) ? @auto_reopen : ITERATIONS_TO_AUTO_REOPEN
+      end
       @finalize = (opts.key?(:finalize) ? opts.delete(:finalize) : true)
       rc = open_journal(open_type, ptr, opts, flags)
       raise JournalError, rc if rc < 0

data/lib/systemd/journal_error.rb

@@ -1,7 +1,7 @@
 require 'ffi'
 
 module Systemd
-  # This execption is raised whenever a sd_journal_* call returns an error.
+  # This exception is raised whenever a sd_journal_* call returns an error.
   class JournalError < StandardError
     # Returns the (positive) error number.
     attr_reader :code

data/spec/systemd/journal_entry_spec.rb

@@ -75,7 +75,7 @@ RSpec.describe Systemd::JournalEntry do
           .to eq('Process 123 said test message')
       end
 
-      it 'skips field substition if requested' do
+      it 'skips field substitution if requested' do
         expect(entry.catalog(replace: false)).to eq(catalog)
       end
     end

data/spec/systemd/journal_spec.rb

@@ -41,6 +41,39 @@ RSpec.describe Systemd::Journal do
 
       expect { j.new(container: 'test') }.to raise_error(ArgumentError)
     end
+
+    context 'auto_reopen' do
+      it 'returns nil as default behavior' do
+        journal = Systemd::Journal.new()
+        expect(journal.auto_reopen).to be_falsy
+      end
+
+      it 'returns default iterations with true' do
+        journal = Systemd::Journal.new(auto_reopen: true)
+        expect(journal.auto_reopen).to be_truthy
+      end
+
+      it 'returns nil with false' do
+        journal = Systemd::Journal.new(auto_reopen: false)
+        expect(journal.auto_reopen).to be_falsy
+      end
+
+      it 'returns iterations with custom value' do
+        journal = Systemd::Journal.new(auto_reopen: 12345)
+        expect(journal.auto_reopen).to be 12345
+      end
+
+      it 'should re-open internal journal pointer at specified iterations' do
+        journal = Systemd::Journal.new(auto_reopen: 2)
+        internal_journal = journal.instance_variable_get(:@ptr)
+
+        journal.move_next
+        expect(journal.instance_variable_get(:@ptr)).to be internal_journal
+
+        journal.move_next
+        expect(journal.instance_variable_get(:@ptr)).to_not be internal_journal
+      end
+    end
   end
 
   describe 'close' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: systemd-journal
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - John Ledbetter
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-11 00:00:00.000000000 Z
+date: 2025-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -187,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Ruby bindings to libsystemd-journal