journalrb 0.1.0

data/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,102 @@
+# JournalRB
+
+JournalRB is a pure Ruby library for logging to Journald through its Unix Socket.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add journalrb
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install journalrb
+```
+
+## Usage
+
+Basic usage:
+
+```ruby
+require "journalrb"
+
+logger = JournalRB::Logger.new # Defaults to DEBUG level.
+logger.debug("Messages which may need to be enabled first, only useful for debugging")
+logger.info("Normal operational messages that require no action") # or logger.informational("Normal operational messages that require no action")
+logger.notice("Events that are unusual, but not error conditions")
+logger.warn("May indicate that an error will occur if action is not taken") # or logger.warning("May indicate that an error will occur if action is not taken")
+logger.err("Error conditions") # or logger.error("Error conditions")
+logger.crit("Critical conditions") # or logger.critical("Critical conditions")
+logger.alert("Should be corrected immediately")
+logger.emerg("System is unusable") # or logger.emergency("System is unusable")
+
+# Blocks can also be used to provide the message as long as the value returned is a string.
+logger.info { "This is an informational message provided by a block" }
+
+# Setting the log level
+logger = JournalRB::Logger.new(level: :warning)
+# or
+logger.level = :warning # or JournalRB::Logger::WARNING or 4
+# or
+logger.warning!
+
+# You can check if the currently set log level allows with a given severity using
+logger.debug?
+logger.info? # or logger.informational?
+logger.notice?
+logger.warn? # or logger.warning?
+logger.err? # or logger.error?
+logger.crit? # or logger.critical?
+logger.alert?
+logger.emerg? # or logger.emergency?
+```
+
+JournalRB supports all standard Journald log priorities (emerg, alert, crit, err, warning, notice, info, debug).
+Additional journal fields can be included in log entries by passing keyword arguments to the logging methods, and the message string can be provided either as a parameter or as a block.
+
+Example additional fields can be found at [systemd.journal-fields](https://www.freedesktop.org/software/systemd/man/latest/systemd.journal-fields.html) or as described in the `#add` method.
+
+```ruby
+require "journalrb"
+
+logger = JournalRB::Logger.new
+logger.error("An error occurred", errno: 123, code_file: "app.rb", code_line: 42, code_func: "perform_task", documentation: "https://example.com/docs/errors#123", custom_field: "custom_value")
+```
+
+If Journald is not configured to use the default socket path (`/run/systemd/journal/socket`), you can specify a custom socket path when initializing the logger:
+
+```ruby
+require "journalrb"
+
+logger = JournalRB::Logger.new(socket: "/custom/path/to/journal/socket")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zaben903/journalrb.
+
+## License
+
+Copyright (C) 2026  Zach Bensley
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/journalrb/logger.rb

@@ -0,0 +1,307 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2026  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+require "socket"
+
+module JournalRB
+  # Logger for journald events.
+  #
+  # @see https://systemd.io/JOURNAL_NATIVE_PROTOCOL/
+  class Logger
+    # System is unusable
+    EMERGENCY = 0
+    # Should be corrected immediately
+    ALERT = 1
+    # Critical conditions
+    CRITICAL = 2
+    # Error conditions
+    ERROR = 3
+    # May indicate that an error will occur if action is not taken
+    WARNING = 4
+    # Events that are unusual, but not error conditions
+    NOTICE = 5
+    # Normal operational messages that require no action
+    INFORMATIONAL = 6
+    # Messages which may need to be enabled first, only useful for debugging
+    DEBUG = 7
+
+    EMERG = EMERGENCY
+    CRIT = CRITICAL
+    ERR = ERROR
+    WARN = WARNING
+    INFO = INFORMATIONAL
+
+    LEVELS = {
+      "emergency" => EMERGENCY,
+      "emerg" => EMERGENCY,
+      "alert" => ALERT,
+      "critical" => CRITICAL,
+      "crit" => CRITICAL,
+      "error" => ERROR,
+      "err" => ERROR,
+      "warning" => WARNING,
+      "warn" => WARNING,
+      "notice" => NOTICE,
+      "informational" => INFORMATIONAL,
+      "info" => INFORMATIONAL,
+      "debug" => DEBUG
+    }.freeze
+    private_constant :LEVELS
+
+    # @param socket [String] the path to the journald socket to write log entries to
+    # @param level [Integer, String, Symbol] the log level to use for this logger
+    def initialize(socket: "/run/systemd/journal/socket", level: DEBUG)
+      self.socket = socket
+      self.level = level
+    end
+
+    # Logs a message with the given severity and metadata.
+    #
+    # @param level [Integer, String, Symbol] A priority value between 0 ("emerg") and 7 ("debug").
+    # @param message [String] The human-readable message string for this entry.
+    # @param message_id [String] A 128-bit message identifier ID for recognizing certain message types, if this is desirable.
+    #   This should contain a 128-bit ID formatted as a lower-case hexadecimal string, without any separating dashes or suchlike.
+    #   This is recommended to be a UUID-compatible ID, but this is not enforced, and formatted differently.
+    # @param code_file [String] The code location generating this message, if known.
+    # @param code_line [Integer] The code location generating this message, if known.
+    # @param code_func [String] The code location generating this message, if known.
+    # @param errno [Integer] The low-level Unix error number causing this entry, if any.
+    # @param invocation_id [String] A randomized, unique 128-bit ID identifying each runtime cycle of the unit.
+    # @param user_invocation_id [String] A randomized, unique 128-bit ID identifying each runtime cycle of the unit.
+    # @param documentation [String] A documentation URL with further information about the topic of the log message.
+    # @param tid [Integer] The numeric thread ID (TID) the log message originates from.
+    # @param kwargs [Hash] additional key/value pairs to include in the log entry, where keys are strings or symbols and values are strings or can be converted to strings.
+    #
+    # @yieldreturn [String] the human-readable message string for this entry, if the message parameter is not provided.
+    #
+    # @see https://www.freedesktop.org/software/systemd/man/latest/systemd.journal-fields.html
+    def add(level, message = nil, message_id: nil, code_file: nil, code_line: nil, code_func: nil, errno: nil, invocation_id: nil, user_invocation_id: nil, documentation: nil, tid: nil, **kwargs)
+      level = normalize_level(level)
+      return unless level <= self.level
+
+      message ||= if block_given?
+        yield
+      else
+        ""
+      end
+      raise(ArgumentError, "message must be a String") unless message.respond_to?(:to_s)
+
+      payload = {
+        MESSAGE: message,
+        PRIORITY: level,
+        MESSAGE_ID: message_id,
+        CODE_FILE: code_file,
+        CODE_LINE: code_line,
+        CODE_FUNC: code_func,
+        ERRNO: errno,
+        INVOCATION_ID: invocation_id,
+        USER_INVOCATION_ID: user_invocation_id,
+        DOCUMENTATION: documentation,
+        TID: tid
+      }.merge(kwargs.transform_keys { |k| k.to_s.upcase }).compact
+      serialized_payload = payload.map { |k, v| serialize_field(k, v.to_s) }.join
+      @socket.send(serialized_payload, 0) && true
+    end
+
+    # @see #add
+    def debug(message = nil, **kwargs, &block)
+      add(DEBUG, message, **kwargs, &block)
+    end
+
+    # @see #add
+    def informational(message = nil, **kwargs, &block)
+      add(INFORMATIONAL, message, **kwargs, &block)
+    end
+    alias_method :info, :informational
+
+    # @see #add
+    def notice(message = nil, **kwargs, &block)
+      add(NOTICE, message, **kwargs, &block)
+    end
+
+    # @see #add
+    def warning(message = nil, **kwargs, &block)
+      add(WARNING, message, **kwargs, &block)
+    end
+    alias_method :warn, :warning
+
+    # @see #add
+    def error(message = nil, **kwargs, &block)
+      add(ERROR, message, **kwargs, &block)
+    end
+    alias_method :err, :error
+
+    # @see #add
+    def critical(message = nil, **kwargs, &block)
+      add(CRITICAL, message, **kwargs, &block)
+    end
+    alias_method :crit, :critical
+
+    # @see #add
+    def alert(message = nil, **kwargs, &block)
+      add(ALERT, message, **kwargs, &block)
+    end
+
+    # @see #add
+    def emergency(message = nil, **kwargs, &block)
+      add(EMERGENCY, message, **kwargs, &block)
+    end
+    alias_method :emerg, :emergency
+
+    attr_reader :level
+    alias_method :priority, :level
+
+    def level=(level)
+      @level = normalize_level(level)
+    end
+    alias_method :priority=, :level=
+
+    # @return [Boolean] whether the log level allows entries with severity Logger::DEBUG to be written
+    def debug?
+      level >= DEBUG
+    end
+
+    # Sets the log level to Logger::DEBUG.
+    def debug!
+      self.level = DEBUG
+    end
+
+    # @return [Boolean] whether the log level allows entries with severity Logger::INFORMATIONAL to be written
+    def informational?
+      level >= INFORMATIONAL
+    end
+    alias_method :info?, :informational?
+
+    # Sets the log level to Logger::INFORMATIONAL.
+    def informational!
+      self.level = INFORMATIONAL
+    end
+    alias_method :info!, :informational!
+
+    # @return [Boolean] whether the log level allows entries with severity Logger::NOTICE to be written
+    def notice?
+      level >= NOTICE
+    end
+
+    # Sets the log level to Logger::NOTICE.
+    def notice!
+      self.level = NOTICE
+    end
+
+    # @return [Boolean] whether the log level allows entries with severity Logger::WARNING to be written
+    def warning?
+      level >= WARNING
+    end
+    alias_method :warn?, :warning?
+
+    # Sets the log level to Logger::WARNING.
+    def warning!
+      self.level = WARNING
+    end
+    alias_method :warn!, :warning!
+
+    # @return [Boolean] whether the log level allows entries with severity Logger::ERROR to be written
+    def error?
+      level >= ERROR
+    end
+    alias_method :err?, :error?
+
+    # Sets the log level to Logger::ERROR.
+    def error!
+      self.level = ERROR
+    end
+    alias_method :err!, :error!
+
+    # @return [Boolean] whether the log level allows entries with severity Logger::CRITICAL to be written
+    def critical?
+      level >= CRITICAL
+    end
+    alias_method :crit?, :critical?
+
+    # Sets the log level to Logger::CRITICAL.
+    def critical!
+      self.level = CRITICAL
+    end
+    alias_method :crit!, :critical!
+
+    # @return [Boolean] whether the log level allows entries with severity Logger::ALERT to be written
+    def alert?
+      level >= ALERT
+    end
+
+    # Sets the log level to Logger::ALERT.
+    def alert!
+      self.level = ALERT
+    end
+
+    # @return [Boolean] whether the log level allows entries with severity Logger::EMERGENCY to be written
+    def emergency?
+      level >= EMERGENCY
+    end
+    alias_method :emerg?, :emergency?
+
+    # Sets the log level to Logger::EMERGENCY.
+    def emergency!
+      self.level = EMERGENCY
+    end
+    alias_method :emerg!, :emergency!
+
+    private
+
+    # Normalizes a log level input to an integer value between 0 and 7.
+    #
+    # @param level [Integer, String, Symbol] the log level to normalize
+    #
+    # @return [Integer] the normalized log level
+    def normalize_level(level)
+      if level.is_a?(Integer)
+        return level if (EMERGENCY..DEBUG).cover?(level)
+
+        raise(ArgumentError, "invalid log level: #{level}")
+      end
+
+      key = level.to_s.downcase
+      LEVELS[key] || raise(ArgumentError, "invalid log level: #{level}")
+    end
+
+    # @param socket [String] the path to the journald socket to write log entries to
+    def socket=(socket)
+      raise(ArgumentError, "socket does not exist: #{socket}") unless File.exist?(socket)
+      raise(ArgumentError, "socket is not a UNIX socket: #{socket}") unless File.socket?(socket)
+
+      @socket = Socket.new(:UNIX, :DGRAM, 0)
+      @socket.connect(Socket.sockaddr_un(socket))
+    end
+
+    # Encodes a single journald field.
+    #
+    # Each key/value pair is serialized via one of two methods:
+    #   The first method inserts a `=` character between key and value, and suffixes the result with `\n`.
+    #   The second method should be used if the value of a field contains a `\n` byte.
+    #     In this case, the key name is serialized as is, followed by a `\n` character, followed by a (non-aligned) little-endian unsigned 64-bit integer encoding the size of the value, followed by the literal value data, followed by `\n`.
+    #
+    # @example a key `FOO` with a value `BAR` is serialized `F, O, O, =, B, A, R, \n`
+    # @example a key `FOO` with a value `BAR` may be serialized using this second method as: `F, O, O, \n, \003, \000, \000, \000, \000, \000, \000, \000, B, A, R, \n`.
+    def serialize_field(key, value)
+      if value.include?("\n")
+        "#{key}\n#{[value.bytesize].pack("Q<")}#{value}\n"
+      else
+        "#{key}=#{value}\n"
+      end
+    end
+  end
+end

data/lib/journalrb/version.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2026  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+module JournalRB
+  VERSION = "0.1.0"
+end

data/lib/journalrb.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2026  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+require_relative "journalrb/version"
+require_relative "journalrb/logger"
+
+module JournalRB
+  class Error < StandardError; end
+end