[1/1] dev-manual: note on using journald without syslog

Message ID 20220316162857.1226591-1-yocto@opensource.nslick.com
State New
Headers show
Series [1/1] dev-manual: note on using journald without syslog | expand

Commit Message

Nicholas Sielicki March 16, 2022, 4:28 p.m. UTC
From: Nicholas Sielicki <nicholas.sielicki@legrand.com>

journald is not a syslog provider, so using journald exclusively amounts
to just preventing a syslog provider from being specified on a system
where journald is active.

Various spots where this has popped up:
* https://stackoverflow.com/q/48746397
* https://lists.yoctoproject.org/g/yocto/topic/82883035#53548

Signed-off-by: Nicholas Sielicki <nicholas.sielicki@legrand.com>
---
 documentation/dev-manual/common-tasks.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

Comments

Michael Opdenacker March 16, 2022, 9:10 p.m. UTC | #1
Hi Nicolas,

Many thanks for the patch!

See my comments below...

On 3/16/22 17:28, Nicholas Sielicki wrote:
> From: Nicholas Sielicki <nicholas.sielicki@legrand.com>
>
> journald is not a syslog provider, so using journald exclusively amounts
> to just preventing a syslog provider from being specified on a system
> where journald is active.
>
> Various spots where this has popped up:
> * https://stackoverflow.com/q/48746397
> * https://lists.yoctoproject.org/g/yocto/topic/82883035#53548
>
> Signed-off-by: Nicholas Sielicki <nicholas.sielicki@legrand.com>
> ---
>  documentation/dev-manual/common-tasks.rst | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)
>
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index ca3fbc856..4e9c2c04e 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -7910,6 +7910,20 @@ image cannot use this package group. However, it can install SysVinit
>  and the appropriate packages will have support for both systemd and
>  SysVinit.
>  
> +Using systemd-journald without a traditional syslog daemon
> +------------------------------------------------------------------------
>

FYI, here, your underlining is unnecessary longer than the text. There
is no warning though, but that's a convention we seem to follow. I fixed
this by myself.
> +
> +Counter-intuitively, ``systemd-journald`` is not a syslog runtime or provider,
> +and the proper way to use systemd-journald as your sole logging mechanism is to
> +effectively disable syslog entirely by set these variables in your distribution
> +configuration file::


s/by set/by setting/

I fixed that by myself. No need to resubmit, unless other people have
comments.
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>

Thanks again!
Michael.

Patch

diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index ca3fbc856..4e9c2c04e 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -7910,6 +7910,20 @@  image cannot use this package group. However, it can install SysVinit
 and the appropriate packages will have support for both systemd and
 SysVinit.
 
+Using systemd-journald without a traditional syslog daemon
+------------------------------------------------------------------------
+
+Counter-intuitively, ``systemd-journald`` is not a syslog runtime or provider,
+and the proper way to use systemd-journald as your sole logging mechanism is to
+effectively disable syslog entirely by set these variables in your distribution
+configuration file::
+
+   VIRTUAL-RUNTIME_syslog = ""
+   VIRTUAL-RUNTIME_base-utils-syslog = ""
+
+Doing so will prevent ``rsyslog`` / ``busybox-syslog`` from being pulled in by
+default, leaving only ``journald``.
+
 Selecting a Device Manager
 ==========================