[v3,2/8] busybox: add logging configuration file

Message ID 20181007114605.18153-3-casantos@datacom.com.br
State Rejected, archived
Headers show
Series
  • init scripts: rewrite S01logging
Related show

Commit Message

Carlos Santos Oct. 7, 2018, 11:45 a.m.
Provide a template to help users to customize syslogd and klogd without
editting the startup script.

syslogd options worth to configure are remote logging (-R), rotation
(-s, -b) and minimal priority level (-l).

klogd minimal priority level (-c) can be configured too, preventing
non-critical kernel messages from appearing on the console.

This file is also useful as an example for init script authors.

Signed-off-by: Carlos Santos <casantos@datacom.com.br>
---
Changes v1->v2
- Implement suggestions made by Nicolas Cavallari and Arnout Vandecappelle
Changes v2->v3
- Add reference to documentation, as suggested by Matt Weber.
---
 package/busybox/busybox.mk          |  2 ++
 package/busybox/etc.default.logging | 17 +++++++++++++++++
 2 files changed, 19 insertions(+)
 create mode 100644 package/busybox/etc.default.logging

Comments

Matt Weber Oct. 8, 2018, 3:23 p.m. | #1
Carlos,

On Sun, Oct 7, 2018 at 6:46 AM Carlos Santos <casantos@datacom.com.br> wrote:
>
> Provide a template to help users to customize syslogd and klogd without
> editting the startup script.
>
> syslogd options worth to configure are remote logging (-R), rotation
> (-s, -b) and minimal priority level (-l).
>
> klogd minimal priority level (-c) can be configured too, preventing
> non-critical kernel messages from appearing on the console.
>
> This file is also useful as an example for init script authors.
>
> Signed-off-by: Carlos Santos <casantos@datacom.com.br>

Tested the disable option in the config and the init script picked it
up as expected.

Tested-by: Matt Weber <matthew.weber@rockwellcollins.com>
Arnout Vandecappelle Oct. 21, 2018, 6:27 p.m. | #2
On 07/10/2018 12:45, Carlos Santos wrote:
> Provide a template to help users to customize syslogd and klogd without
> editting the startup script.
> 
> syslogd options worth to configure are remote logging (-R), rotation
> (-s, -b) and minimal priority level (-l).
> 
> klogd minimal priority level (-c) can be configured too, preventing
> non-critical kernel messages from appearing on the console.
> 
> This file is also useful as an example for init script authors.

 We also discussed this, and we agreed in the end that it is not very useful to
have a default defaults file. It needlessly consumes space on the target, the
user anyway probably has to consult documentation to know which options to use,
and there is (usually) only one option that can be set in the file:
<DAEMON>_ARGS. In addition, we can't expect all package authors to submit
something that is of such a high quality as this example...

 Regards,
 Arnout

> 
> Signed-off-by: Carlos Santos <casantos@datacom.com.br>
> ---
> Changes v1->v2
> - Implement suggestions made by Nicolas Cavallari and Arnout Vandecappelle
> Changes v2->v3
> - Add reference to documentation, as suggested by Matt Weber.
> ---
>  package/busybox/busybox.mk          |  2 ++
>  package/busybox/etc.default.logging | 17 +++++++++++++++++
>  2 files changed, 19 insertions(+)
>  create mode 100644 package/busybox/etc.default.logging
> 
> diff --git a/package/busybox/busybox.mk b/package/busybox/busybox.mk
> index 757086592f..91131c0012 100644
> --- a/package/busybox/busybox.mk
> +++ b/package/busybox/busybox.mk
> @@ -252,6 +252,8 @@ define BUSYBOX_INSTALL_LOGGING_SCRIPT
>  	then \
>  		$(INSTALL) -m 0755 -D package/busybox/S01logging \
>  			$(TARGET_DIR)/etc/init.d/S01logging; \
> +		$(INSTALL) -m 0644 -D package/busybox/etc.default.logging \
> +			$(TARGET_DIR)/etc/default/logging; \
>  	fi
>  endef
>  
> diff --git a/package/busybox/etc.default.logging b/package/busybox/etc.default.logging
> new file mode 100644
> index 0000000000..5e52eff985
> --- /dev/null
> +++ b/package/busybox/etc.default.logging
> @@ -0,0 +1,17 @@
> +#
> +# /etc/default/logging (busybox version)
> +#
> +# Online documentation of syslogd and klogd is available at
> +#
> +#    https://busybox.net/downloads/BusyBox.html
> +#
> +
> +# Use SYSLOGD_ARGS to pass additional arguments to syslogd (e.g. for log
> +# rotation).
> +# SYSLOGD_ARGS="" # (default value)
> +
> +# Use KLOGD_ARGS to pass additional arguments to klogd.
> +# KLOGD_ARGS="" # (default value)
> +
> +# Uncomment the line below to disable this service
> +# ENABLED="no"
>
Carlos Santos Nov. 2, 2018, 7:01 p.m. | #3
> From: "Arnout Vandecappelle" <arnout@mind.be>
> To: "DATACOM" <casantos@datacom.com.br>, "buildroot" <buildroot@buildroot.org>
> Cc: "ratbert90" <aduskett@gmail.com>, "Matthew Weber" <matthew.weber@rockwellcollins.com>, "Chris Packham"
> <judge.packham@gmail.com>
> Sent: Domingo, 21 de outubro de 2018 15:27:24
> Subject: Re: [PATCH v3 2/8] busybox: add logging configuration file

> On 07/10/2018 12:45, Carlos Santos wrote:
>> Provide a template to help users to customize syslogd and klogd without
>> editting the startup script.
>> 
>> syslogd options worth to configure are remote logging (-R), rotation
>> (-s, -b) and minimal priority level (-l).
>> 
>> klogd minimal priority level (-c) can be configured too, preventing
>> non-critical kernel messages from appearing on the console.
>> 
>> This file is also useful as an example for init script authors.
> 
> We also discussed this, and we agreed in the end that it is not very useful to
> have a default defaults file. It needlessly consumes space on the target, the
> user anyway probably has to consult documentation to know which options to use,
> and there is (usually) only one option that can be set in the file:
> <DAEMON>_ARGS. In addition, we can't expect all package authors to submit
> something that is of such a high quality as this example...

OK, I will drop the default files from the series.

Patch

diff --git a/package/busybox/busybox.mk b/package/busybox/busybox.mk
index 757086592f..91131c0012 100644
--- a/package/busybox/busybox.mk
+++ b/package/busybox/busybox.mk
@@ -252,6 +252,8 @@  define BUSYBOX_INSTALL_LOGGING_SCRIPT
 	then \
 		$(INSTALL) -m 0755 -D package/busybox/S01logging \
 			$(TARGET_DIR)/etc/init.d/S01logging; \
+		$(INSTALL) -m 0644 -D package/busybox/etc.default.logging \
+			$(TARGET_DIR)/etc/default/logging; \
 	fi
 endef
 
diff --git a/package/busybox/etc.default.logging b/package/busybox/etc.default.logging
new file mode 100644
index 0000000000..5e52eff985
--- /dev/null
+++ b/package/busybox/etc.default.logging
@@ -0,0 +1,17 @@ 
+#
+# /etc/default/logging (busybox version)
+#
+# Online documentation of syslogd and klogd is available at
+#
+#    https://busybox.net/downloads/BusyBox.html
+#
+
+# Use SYSLOGD_ARGS to pass additional arguments to syslogd (e.g. for log
+# rotation).
+# SYSLOGD_ARGS="" # (default value)
+
+# Use KLOGD_ARGS to pass additional arguments to klogd.
+# KLOGD_ARGS="" # (default value)
+
+# Uncomment the line below to disable this service
+# ENABLED="no"