From patchwork Thu Mar 30 14:15:18 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruno Victal X-Patchwork-Id: 48817 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 B7330171AB; Thu, 30 Mar 2023 15:16:26 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.0 required=5.0 tests=MAILING_LIST_MULTI, RCVD_IN_MSPIKE_H2,SPF_HELO_PASS 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 079401719C for ; Thu, 30 Mar 2023 15:16:26 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pht4R-0006pX-Fo; Thu, 30 Mar 2023 10:16:07 -0400 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 1pht4N-0006oV-B4 for guix-patches@gnu.org; Thu, 30 Mar 2023 10:16:03 -0400 Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pht4M-0001bV-FG for guix-patches@gnu.org; Thu, 30 Mar 2023 10:16:03 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pht4M-0000Xo-4U for guix-patches@gnu.org; Thu, 30 Mar 2023 10:16:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#62465] [PATCH v3 1/2] services: mcron: Add 'shepherd-requirement' field. References: <47e924fd42f74fc2800dc64399f7a069ad463515.1679854500.git.mirai@makinata.eu> In-Reply-To: <47e924fd42f74fc2800dc64399f7a069ad463515.1679854500.git.mirai@makinata.eu> Resent-From: Bruno Victal Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Thu, 30 Mar 2023 14:16:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 62465 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 62465@debbugs.gnu.org Cc: Bruno Victal , maxim.cournoyer@gmail.com Received: via spool by 62465-submit@debbugs.gnu.org id=B62465.16801857292046 (code B ref 62465); Thu, 30 Mar 2023 14:16:02 +0000 Received: (at 62465) by debbugs.gnu.org; 30 Mar 2023 14:15:29 +0000 Received: from localhost ([127.0.0.1]:59155 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pht3o-0000Wv-KQ for submit@debbugs.gnu.org; Thu, 30 Mar 2023 10:15:29 -0400 Received: from smtpmciv2.myservices.hosting ([185.26.107.238]:42192) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pht3n-0000Wo-DR for 62465@debbugs.gnu.org; Thu, 30 Mar 2023 10:15:27 -0400 Received: from mail1.netim.hosting (unknown [185.26.106.173]) by smtpmciv2.myservices.hosting (Postfix) with ESMTP id 48CCD20DEA; Thu, 30 Mar 2023 16:15:26 +0200 (CEST) Received: from localhost (localhost [127.0.0.1]) by mail1.netim.hosting (Postfix) with ESMTP id F1117800A0; Thu, 30 Mar 2023 16:15:25 +0200 (CEST) X-Virus-Scanned: Debian amavisd-new at mail1.netim.hosting Received: from mail1.netim.hosting ([127.0.0.1]) by localhost (mail1-2.netim.hosting [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id pEGp2giG8Q6B; Thu, 30 Mar 2023 16:15:25 +0200 (CEST) Received: from guix-nuc.home.arpa (unknown [10.192.1.83]) (Authenticated sender: lumen@makinata.eu) by mail1.netim.hosting (Postfix) with ESMTPSA id 6D08D8009E; Thu, 30 Mar 2023 16:15:25 +0200 (CEST) From: Bruno Victal Date: Thu, 30 Mar 2023 15:15:18 +0100 Message-Id: <4427884b06f47c6152b35e9559e6c1dc9412ebe5.1680185251.git.mirai@makinata.eu> X-Mailer: git-send-email 2.39.1 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/mcron.scm (mcron-configuration)[shepherd-requirement]: New field. (list-of-symbols?): New predicate. (mcron-shepherd-services): Add support for additional shepherd requirements. * doc/guix.texi (Scheduled Job Execution): Update it. --- Notable changes from v2 to v3: Changing the final log-file value used in v2 behind the scenes made it poorly reflexive as you couldn't trust what the accessors returned. v3 makes log-file a mandatory field that has to be set manually and leaves the default service instantiation responsible for setting the default log-file that is used for the main mcron instance. doc/guix.texi | 4 ++++ gnu/services/mcron.scm | 13 +++++++++++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index c49e51b72e..5a597cf122 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -19379,6 +19379,10 @@ Scheduled Job Execution @item @code{mcron} (default: @code{mcron}) (type: file-like) The mcron package to use. +@item @code{shepherd-requirement} (default: @code{()}) (type: list-of-symbols) +This is a list of symbols naming Shepherd services that this service +will depend on. + @item @code{jobs} (default: @code{()}) (type: list-of-gexps) This is a list of gexps (@pxref{G-Expressions}), where each gexp corresponds to an mcron job specification (@pxref{Syntax, mcron job diff --git a/gnu/services/mcron.scm b/gnu/services/mcron.scm index 2ef5980e09..99eb0edd60 100644 --- a/gnu/services/mcron.scm +++ b/gnu/services/mcron.scm @@ -32,6 +32,7 @@ (define-module (gnu services mcron) #:export (mcron-configuration mcron-configuration? mcron-configuration-mcron + mcron-configuration-shepherd-requirement mcron-configuration-jobs mcron-configuration-log? mcron-configuration-log-file @@ -58,6 +59,9 @@ (define-module (gnu services mcron) (define list-of-gexps? (list-of gexp?)) +(define list-of-symbols? + (list-of symbol?)) + (define-maybe/no-serialization string) (define-configuration/no-serialization mcron-configuration @@ -65,6 +69,11 @@ (define-configuration/no-serialization mcron-configuration (file-like mcron) "The mcron package to use.") + (shepherd-requirement + (list-of-symbols '()) + "This is a list of symbols naming Shepherd services that this service +will depend on.") + (jobs (list-of-gexps '()) "This is a list of gexps (@pxref{G-Expressions}), where each gexp @@ -158,13 +167,13 @@ (define (shepherd-schedule-action mcron files) (define (mcron-shepherd-services config) (match-record config - (mcron jobs log? log-file log-format date-format) + (mcron shepherd-requirement jobs log? log-file log-format date-format) (if (eq? jobs '()) '() ;nothing to do (let ((files (job-files mcron jobs))) (list (shepherd-service (provision '(mcron)) - (requirement '(user-processes)) + (requirement `(user-processes ,@shepherd-requirement)) (modules `((srfi srfi-1) (srfi srfi-26) (ice-9 popen) ;for the 'schedule' action From patchwork Thu Mar 30 14:15:19 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruno Victal X-Patchwork-Id: 48819 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 39F2B171AB; Thu, 30 Mar 2023 15:35:24 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.0 required=5.0 tests=MAILING_LIST_MULTI, RCVD_IN_MSPIKE_H2,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 EAB2117152 for ; Thu, 30 Mar 2023 15:35:21 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1phtMt-0006HT-0B; Thu, 30 Mar 2023 10:35:11 -0400 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 1phtMl-0006H6-9J for guix-patches@gnu.org; Thu, 30 Mar 2023 10:35:03 -0400 Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1phtMj-0004Cz-RZ for guix-patches@gnu.org; Thu, 30 Mar 2023 10:35:01 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1phtMj-000139-M3 for guix-patches@gnu.org; Thu, 30 Mar 2023 10:35:01 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#62465] [PATCH v3 2/2] services: mcron: Add instance name support for mcron. Resent-From: Bruno Victal Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Thu, 30 Mar 2023 14:35:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 62465 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 62465@debbugs.gnu.org Cc: Bruno Victal , maxim.cournoyer@gmail.com Received: via spool by 62465-submit@debbugs.gnu.org id=B62465.16801868774000 (code B ref 62465); Thu, 30 Mar 2023 14:35:01 +0000 Received: (at 62465) by debbugs.gnu.org; 30 Mar 2023 14:34:37 +0000 Received: from localhost ([127.0.0.1]:59176 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1phtML-00012S-9R for submit@debbugs.gnu.org; Thu, 30 Mar 2023 10:34:37 -0400 Received: from smtpm5.myservices.hosting ([185.26.105.236]:49584) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1phtMH-00012F-T6 for 62465@debbugs.gnu.org; Thu, 30 Mar 2023 10:34:35 -0400 Received: from mail1.netim.hosting (unknown [185.26.106.173]) by smtpm5.myservices.hosting (Postfix) with ESMTP id 6C638203B5; Thu, 30 Mar 2023 16:34:32 +0200 (CEST) Received: from localhost (localhost [127.0.0.1]) by mail1.netim.hosting (Postfix) with ESMTP id 678A7800A0; Thu, 30 Mar 2023 16:16:08 +0200 (CEST) X-Virus-Scanned: Debian amavisd-new at mail1.netim.hosting Received: from mail1.netim.hosting ([127.0.0.1]) by localhost (mail1-2.netim.hosting [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id pI2fWCQh3Pcx; Thu, 30 Mar 2023 16:16:07 +0200 (CEST) Received: from guix-nuc.home.arpa (unknown [10.192.1.83]) (Authenticated sender: lumen@makinata.eu) by mail1.netim.hosting (Postfix) with ESMTPSA id A79048009C; Thu, 30 Mar 2023 16:16:07 +0200 (CEST) From: Bruno Victal Date: Thu, 30 Mar 2023 15:15:19 +0100 Message-Id: <090d1b4795f68fd814c89e830acbc9064bdbb648.1680185251.git.mirai@makinata.eu> X-Mailer: git-send-email 2.39.1 In-Reply-To: <4427884b06f47c6152b35e9559e6c1dc9412ebe5.1680185251.git.mirai@makinata.eu> References: <4427884b06f47c6152b35e9559e6c1dc9412ebe5.1680185251.git.mirai@makinata.eu> 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 Allow running more than one mcron instance. Make log-file a mandatory field when instantiating mcron-configuration records. Follow-up to . * gnu/services/mcron.scm (mcron-configuration)[instance-name]: New field. [log-file]: Update description. Remove default value. (mcron-shepherd-services): Implement instance-name support. Set the default service instantiation to log to /var/log/mcron.log. * gnu/tests/base.scm (%mcron-os): Update tests. * doc/guix.texi (Scheduled Job Execution): Update it. --- Notable changes from v2 to v3: Changing the final log-file value used in v2 behind the scenes made it poorly reflexive as you couldn't trust what the accessors returned. v3 makes log-file a mandatory field that has to be set manually and leaves the default service instantiation responsible for setting the default log-file that is used for the main mcron instance. doc/guix.texi | 32 ++++++++++++++++++++++++++++++-- gnu/services/mcron.scm | 28 ++++++++++++++++++++++------ gnu/tests/base.scm | 4 +++- 3 files changed, 55 insertions(+), 9 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index 5a597cf122..b9bd78f3cc 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -19383,6 +19383,10 @@ Scheduled Job Execution This is a list of symbols naming Shepherd services that this service will depend on. +@item @code{instance} (type: maybe-symbol) +Set the shepherd service name to @code{mcron-@var{instance}}. This is +useful when you want to have more than one mcron instance. + @item @code{jobs} (default: @code{()}) (type: list-of-gexps) This is a list of gexps (@pxref{G-Expressions}), where each gexp corresponds to an mcron job specification (@pxref{Syntax, mcron job @@ -19391,8 +19395,10 @@ Scheduled Job Execution @item @code{log?} (default: @code{#t}) (type: boolean) Log messages to standard output. -@item @code{log-file} (default: @code{"/var/log/mcron.log"}) (type: string) -Log file location. +@item @code{log-file} (type: string) +Log file location. By default, the main mcron instance (which is +instantiated with @samp{(service mcron-service-type)}) is set to log to +@file{/var/log/mcron.log}. @item @code{log-format} (default: @code{"~1@@*~a ~a: ~a~%"}) (type: string) @code{(ice-9 format)} format string for log messages. The default value @@ -19407,6 +19413,28 @@ Scheduled Job Execution @end deftp @c %end of fragment +Occasionally, it is desirable to run another mcron instance to separate +some of the jobs from the main mcron instance for clarity purposes, or if +the jobs are very chatty and frequent. (for example, a heartbeat check +every 30 seconds) + +The example below shows how an extra mcron service can be defined. +@lisp +(use (guix) + (guix records) + (gnu services) + (gnu services mcron)) + +(define secondary-mcron-service-type + (service-type + (inherit mcron-service-type) + (name 'mcron-secondary) + (default-value + (mcron-configuration + (instance 'secondary) + (log-file "/var/log/mcron-secondary.log"))))) +@end lisp + @node Log Rotation @subsection Log Rotation diff --git a/gnu/services/mcron.scm b/gnu/services/mcron.scm index 99eb0edd60..164ef0e723 100644 --- a/gnu/services/mcron.scm +++ b/gnu/services/mcron.scm @@ -27,12 +27,14 @@ (define-module (gnu services mcron) #:use-module (guix records) #:use-module (guix gexp) #:use-module (srfi srfi-1) + #:use-module (ice-9 format) #:use-module (ice-9 match) #:use-module (ice-9 vlist) #:export (mcron-configuration mcron-configuration? mcron-configuration-mcron mcron-configuration-shepherd-requirement + mcron-configuration-instance mcron-configuration-jobs mcron-configuration-log? mcron-configuration-log-file @@ -63,6 +65,7 @@ (define list-of-symbols? (list-of symbol?)) (define-maybe/no-serialization string) +(define-maybe/no-serialization symbol) (define-configuration/no-serialization mcron-configuration (mcron @@ -74,6 +77,11 @@ (define-configuration/no-serialization mcron-configuration "This is a list of symbols naming Shepherd services that this service will depend on.") + (instance + maybe-symbol + "Set the shepherd service name to @code{mcron-@var{instance}}. +This is useful when you want to have more than one mcron instance.") + (jobs (list-of-gexps '()) "This is a list of gexps (@pxref{G-Expressions}), where each gexp @@ -85,8 +93,10 @@ (define-configuration/no-serialization mcron-configuration "Log messages to standard output.") (log-file - (string "/var/log/mcron.log") - "Log file location.") + string + "Log file location. By default, the main mcron instance +(which is instantiated with @samp{(service mcron-service-type)}) +is set to log to @file{/var/log/mcron.log}.") (log-format (string "~1@*~a ~a: ~a~%") @@ -167,12 +177,16 @@ (define (shepherd-schedule-action mcron files) (define (mcron-shepherd-services config) (match-record config - (mcron shepherd-requirement jobs log? log-file log-format date-format) + (mcron shepherd-requirement instance + jobs log? log-file log-format date-format) (if (eq? jobs '()) '() ;nothing to do - (let ((files (job-files mcron jobs))) + (let* ((files (job-files mcron jobs)) + (instance-name + (format #f "mcron~@[-~a~]" (maybe-value instance))) + (service-name (string->symbol instance-name))) (list (shepherd-service - (provision '(mcron)) + (provision (list service-name)) (requirement `(user-processes ,@shepherd-requirement)) (modules `((srfi srfi-1) (srfi srfi-26) @@ -220,7 +234,9 @@ (define mcron-service-type (inherit config) (jobs (append (mcron-configuration-jobs config) jobs))))) - (default-value (mcron-configuration)))) ;empty job list + (default-value + (mcron-configuration + (log-file "/var/log/mcron.log"))))) ;empty job list ;;; diff --git a/gnu/tests/base.scm b/gnu/tests/base.scm index 97edbbc6ad..ffff713e4c 100644 --- a/gnu/tests/base.scm +++ b/gnu/tests/base.scm @@ -885,7 +885,9 @@ (define %mcron-os "touch witness-touch"))) (simple-operating-system (service mcron-service-type - (mcron-configuration (jobs (list job1 job2 job3))))))) + (mcron-configuration + (jobs (list job1 job2 job3)) + (log-file "/var/log/mcron.log")))))) (define (run-mcron-test name) (define os