From patchwork Tue Feb 4 22:57:47 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: =?utf-8?q?Ludovic_Court=C3=A8s?= X-Patchwork-Id: 38215 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 4B05327BBE9; Tue, 4 Feb 2025 22:59:27 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-8.6 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,MAILING_LIST_MULTI,RCVD_IN_DNSWL_BLOCKED, RCVD_IN_MSPIKE_H2,RCVD_IN_VALIDITY_CERTIFIED,RCVD_IN_VALIDITY_RPBL, RCVD_IN_VALIDITY_SAFE,SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 09CBB27BBE2 for ; Tue, 4 Feb 2025 22:59:26 +0000 (GMT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tfRsm-0001DH-Sj; Tue, 04 Feb 2025 17:59:05 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tfRsk-0001CW-N9 for guix-patches@gnu.org; Tue, 04 Feb 2025 17:59:02 -0500 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1tfRsk-0004qI-Dy; Tue, 04 Feb 2025 17:59:02 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=MIME-Version:References:In-Reply-To:Date:From:To:Subject; bh=XjoKqwFnSUbj0xT2MojRgNkg/Ts0OTCU7pNN2Lwm6Rs=; b=si2bdI8sJuE532+ii1EKLDCEUJ7hy+vSwrlNjM8W2MD80nZwbV3vS6nlaJ330sS4ct9Id3k8yGQuvBut14dE0G+k7v8S9sPrrKKjmdgV3K3GpJRVb2u9+LT5hunqlWnAQnTyiscKeXgyfeoP5m8AVgBAymGkx2PdMopJ1dI7nrjc7QtH/P7wMcgJ1S62dd8c14hlJ3UqUY8CtZ8umEohz8oLMr3Xl+ws9Dki9kOhs5+pDtTKycTz84NNNGFHVAzzw93PmRLggJrIgxroC6bOF9ZCjD/bG/NrgKk+2YPia9UK+awAesJhNcdlHTOCs388RleTDDZ/JWVdqh/W0xm4jA==; Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1tfRsk-00055L-8k; Tue, 04 Feb 2025 17:59:02 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#76063] [PATCH 1/3] services: Add =?utf-8?b?4oCYc3lzdGVtLWxv?= =?utf-8?b?Z+KAmQ==?= Shepherd service. Resent-From: Ludovic =?utf-8?q?Court=C3=A8s?= Original-Sender: "Debbugs-submit" Resent-CC: ludo@gnu.org, maxim.cournoyer@gmail.com, guix-patches@gnu.org Resent-Date: Tue, 04 Feb 2025 22:59:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 76063 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 76063@debbugs.gnu.org Cc: Ludovic =?utf-8?q?Court=C3=A8s?= , Ludovic =?utf-8?q?Court?= =?utf-8?q?=C3=A8s?= , Maxim Cournoyer X-Debbugs-Original-Xcc: Ludovic =?utf-8?q?Court=C3=A8s?= , Maxim Cournoyer Received: via spool by 76063-submit@debbugs.gnu.org id=B76063.173870988719435 (code B ref 76063); Tue, 04 Feb 2025 22:59:02 +0000 Received: (at 76063) by debbugs.gnu.org; 4 Feb 2025 22:58:07 +0000 Received: from localhost ([127.0.0.1]:47128 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tfRrq-00053N-Hp for submit@debbugs.gnu.org; Tue, 04 Feb 2025 17:58:07 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:56410) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1tfRro-00052f-Cm for 76063@debbugs.gnu.org; Tue, 04 Feb 2025 17:58:05 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tfRri-0004eg-RK; Tue, 04 Feb 2025 17:57:58 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:References:In-Reply-To:Date:Subject:To: From; bh=XjoKqwFnSUbj0xT2MojRgNkg/Ts0OTCU7pNN2Lwm6Rs=; b=g7R5RpSrhHpXvPJ+PC/i 3Azp5UIwhiJctbhbKFk1qLkGsz7SrMZ+Xz6HYwDwSMImt23Zi6ub5LBJr7aFiQ/cUWa65Ao+z8nLY IQymvdTUiEh/1B6ROzBVkzshPJiZDFD4w+MLZrsf96KGoh+O7eAosEXP9vHS3LvOqQakD4jqgq4fA ZbM8YvOJl3DyTsmUeHxoapC4sBjSM7nJBhgtRvs/0t8TQ5S8lz/0oHaAHaeXhs4Q6bIJwJ9PdzV3O bh4+WOpVp7sARF5hJJffhMeTi9jGyqpflRp16X/7GnzbPL6SRX+DNJIy8yyJTNLO61120yCDxtP+i IuOx6l8uac3nWQ==; From: Ludovic =?utf-8?q?Court=C3=A8s?= Date: Tue, 4 Feb 2025 23:57:47 +0100 Message-ID: X-Mailer: git-send-email 2.48.1 In-Reply-To: References: MIME-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches * gnu/services/shepherd.scm (gexp-or-integer?) (gexp-or-string?, gexp-or-string-or-false?): New procedures. (system-log-configuration): New record type. (shepherd-system-log-service-type): New variable. * doc/guix.texi (Shepherd Services): Document it. Change-Id: I1e29fe0977eb4f8026ee6a2d2f282e269c8c00b4 Reviewed-by: Maxim Cournoyer --- doc/guix.texi | 55 +++++++++++++++++++ gnu/services/shepherd.scm | 108 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 163 insertions(+) diff --git a/doc/guix.texi b/doc/guix.texi index bb5f29277f..f52d79d549 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -45757,6 +45757,61 @@ Shepherd Services on the @code{timer} service. @end defvar +@cindex system log service, from Shepherd +@cindex syslogd, Shepherd system log service +@defvar shepherd-system-log-service-type +This service implements a @dfn{system log}, reading messages +applications send to @file{/dev/log} and writing them to files or +terminals according to user-defined rules. It provides functionality +traditionally implemented by @command{syslogd} programs. + +The value of services of this type must be a +@code{system-log-configuration} record, as described below. +@end defvar + +@c %start of fragment + +@deftp {Data Type} system-log-configuration +Available @code{system-log-configuration} fields are: + +@table @asis +@item @code{provision} (default: @code{(system-log syslogd)}) (type: list-of-symbols) +The name(s) of the system log service. + +@item @code{requirement} (default: @code{(root-file-system)}) (type: list-of-symbols) +Dependencies of the system log service. + +@item @code{kernel-log-file} (type: gexp-or-string-or-false) +File from which kernel messages are read, @file{/dev/kmsg} by default. + +@item @code{message-destination} (default: @code{#f}) (type: gexp-or-false) +This gexp must evaluate to a procedure that, when passed a log message, +returns the list of files to write it to; @code{#f} is equivalent to +using @code{(default-message-destination-procedure)}. @pxref{System Log +Service,,, shepherd,The GNU Shepherd Manual}, for information on how to +write that procedure. + +@item @code{date-format} (type: gexp-or-string) +String or string-valued gexp providing a specifying how to format +timestamps in log file. It must be a valid string for @code{strftime}, +including delimiting space---e.g., @code{"%c "} for a format identical +to that of traditional syslogd implementations. + +@item @code{history-size} (type: gexp-or-integer) +Number of logging messages kept in memory for the purposes of making +them available to @command{herd status system-log}. + +@item @code{max-silent-time} (type: gexp-or-integer) +Time after which a mark is written to log files if nothing was logged +during that time frame. + +@end table + +@end deftp + + +@c %end of fragment + @defvar %shepherd-root-service This service represents PID@tie{}1. @end defvar diff --git a/gnu/services/shepherd.scm b/gnu/services/shepherd.scm index 328bfbedff..bc31285cfb 100644 --- a/gnu/services/shepherd.scm +++ b/gnu/services/shepherd.scm @@ -31,6 +31,7 @@ (define-module (gnu services shepherd) #:use-module ((guix diagnostics) #:select (define-with-syntax-properties formatted-message)) #:use-module (gnu services) + #:use-module (gnu services configuration) #:use-module (gnu services herd) #:use-module (gnu packages admin) #:use-module (ice-9 match) @@ -84,6 +85,17 @@ (define-module (gnu services shepherd) shepherd-timer-service-type shepherd-transient-service-type + system-log-configuration + system-log-configuration? + system-log-configuration-provision + system-log-configuration-requirement + system-log-configuration-message-destination + system-log-configuration-date-format + system-log-configuration-history-size + system-log-configuration-max-silent-time + + shepherd-system-log-service-type + assert-valid-graph)) ;;; Commentary: @@ -721,3 +733,99 @@ (define shepherd-transient-service-type This runs @command{rsync} in the background, as a service that you can inspect with @command{herd status} and stop with @command{herd stop}."))) + + +;;; +;;; System log. +;;; + +(define (gexp-or-false? x) + (or (gexp? x) (not x))) + +(define (gexp-or-integer? x) + (or (gexp? x) (integer? x))) + +(define (gexp-or-string? x) + (or (gexp? x) (string? x))) + +(define (gexp-or-string-or-false? x) + (or (gexp-or-string? x) (not x))) + +(define-configuration system-log-configuration + (provision + (list-of-symbols '(system-log syslogd)) + "The name(s) of the system log service." + empty-serializer) + (requirement + (list-of-symbols '(root-file-system)) + "Dependencies of the system log service." + empty-serializer) + (kernel-log-file + (gexp-or-string-or-false #~(kernel-log-file)) + "File from which kernel messages are read, @file{/dev/kmsg} by default." + empty-serializer) + (message-destination + (gexp-or-false #f) + "This gexp must evaluate to a procedure that, when passed a log message, +returns the list of files to write it to; @code{#f} is equivalent to using +@code{(default-message-destination-procedure)}. @pxref{System Log Service,,, +shepherd, The GNU Shepherd Manual}, for information on how to write that +procedure." + empty-serializer) + (date-format + (gexp-or-string #~default-logfile-date-format) + "String or string-valued gexp providing a specifying how to format +timestamps in log file. It must be a valid string for @code{strftime}, +including delimiting space---e.g., @code{\"%c \"} for a format identical to +that of traditional syslogd implementations." + empty-serializer) + (history-size + (gexp-or-integer #~(default-log-history-size)) + "Number of logging messages kept in memory for the purposes of making them +available to @command{herd status system-log}." + empty-serializer) + (max-silent-time + (gexp-or-integer #~(default-max-silent-time)) + "Time after which a mark is written to log files if nothing was logged +during that time frame." + empty-serializer)) + +(define shepherd-system-log-service-type + (shepherd-service-type + 'shepherd-system-log + (lambda (config) + (shepherd-service + (documentation "Shepherd's built-in system log (syslogd).") + (provision (system-log-configuration-provision config)) + (requirement (system-log-configuration-requirement config)) + (modules '((shepherd service system-log) + ((shepherd support) #:select (default-logfile-date-format)) + ((shepherd logger) #:select (default-log-history-size)))) + (free-form + #~(system-log-service #:provision + '#$(system-log-configuration-provision config) + #:requirement + '#$(system-log-configuration-requirement config) + + ;; XXX: As of Shepherd 1.0.1, + ;; 'default-message-destination-procedure' is not + ;; exported, hence this conditional. + #$@(match (system-log-configuration-message-destination + config) + (#f #~()) + (value #~(#:message-destination #$value))) + + #:date-format + #$(system-log-configuration-date-format + config) + #:history-size + #$(system-log-configuration-history-size config) + #:max-silent-time + #$(system-log-configuration-max-silent-time + config))))) + (system-log-configuration) + (description + "The Shepherd's @code{system-log} service plays the role of traditional +@command{syslogd} daemons, reading data logged by daemons to @file{/dev/log} +and writing it to several files in @file{/var/log} according to user-provided +dispatching rules.")))