diff mbox

[PATCHv2] syslog-ng: New package

Message ID 1444808488-3387-1-git-send-email-judge.packham@gmail.com
State Superseded
Headers show

Commit Message

Chris Packham Oct. 14, 2015, 7:41 a.m. UTC 
syslog-ng is an enhanced log daemon, supporting a wide range of input
and output methods: syslog, unstructured text, queueing, SQL & NoSQL.

Signed-off-by: Chris Packham <judge.packham@gmail.com>
---
Changes since v1:
 - add hash file
 - use simplified logging configuration for buildroot
 - don't install man pages

 package/Config.in                |  3 +++
 package/syslog-ng/Config.in      | 18 +++++++++++++
 package/syslog-ng/S01logging     | 36 ++++++++++++++++++++++++++
 package/syslog-ng/syslog-ng.conf | 16 ++++++++++++
 package/syslog-ng/syslog-ng.hash |  2 ++
 package/syslog-ng/syslog-ng.mk   | 55 ++++++++++++++++++++++++++++++++++++++++
 6 files changed, 130 insertions(+)
 create mode 100644 package/syslog-ng/Config.in
 create mode 100644 package/syslog-ng/S01logging
 create mode 100644 package/syslog-ng/syslog-ng.conf
 create mode 100644 package/syslog-ng/syslog-ng.hash
 create mode 100644 package/syslog-ng/syslog-ng.mk

Comments

Thomas Petazzoni Oct. 14, 2015, 7:50 a.m. UTC | #1 
Dear Chris Packham,

Thanks for this new version, a few comments below.

On Wed, 14 Oct 2015 20:41:28 +1300, Chris Packham wrote:

> diff --git a/package/Config.in b/package/Config.in
> index 8e3c64a..e191af7 100644
> --- a/package/Config.in
> +++ b/package/Config.in
> @@ -1518,6 +1518,9 @@ endif
>  if BR2_PACKAGE_BUSYBOX_SHOW_OTHERS
>  	source "package/sysklogd/Config.in"
>  endif
> +if BR2_PACKAGE_BUSYBOX_SHOW_OTHERS
> +	source "package/syslog-ng/Config.in"
> +endif

You can probably group is with the BR2_PACKAGE_BUSYBOX_SHOW_OTHERS used
for sysklogd.

> diff --git a/package/syslog-ng/S01logging b/package/syslog-ng/S01logging
> new file mode 100644
> index 0000000..3fa7107
> --- /dev/null
> +++ b/package/syslog-ng/S01logging
> @@ -0,0 +1,36 @@
> +#!/bin/sh
> +
> +start() {
> +  echo -n "Starting syslog-ng daemon: "

Indentation should be done with one tab in the init script.

And use "printf" here rather than "echo -n". We changed this in all
init scripts about a week ago or so. The reasoning is that printf is
POSIX, while echo -n is specific to certain shells only.

> +  start-stop-daemon -S -q -p /var/run/syslog-ng.pid --exec /usr/sbin/syslog-ng
> +  [ $? = 0 ] && echo "OK" || echo "FAIL"

Using echo here is fine.


> +# Locally computed
> +sha1 494418ca185d912e2296dccac4ca1b38924159ff syslog-ng-3.7.1.tar.gz

If it's locally computed, use a sha256.

> +SYSLOG_NG_VERSION = 3.7.1
> +SYSLOG_NG_SOURCE = syslog-ng-$(SYSLOG_NG_VERSION).tar.gz
> +SYSLOG_NG_SITE = https://github.com/balabit/syslog-ng/releases/download/syslog-ng-$(SYSLOG_NG_VERSION)
> +SYSLOG_NG_LICENSE = LGPL (syslog-ng core), GPL (modules)

Please indicate the version of the license (GPLv2, GPLv2+, GPLv3,
GPLv3+, etc.).

> +SYSLOG_NG_LICENSE_FILES = COPYING
> +SYSLOG_NG_DEPENDENCIES = host-bison host-flex host-pkgconf \
> +	eventlog libglib2 openssl pcre \
> +	$(if $(BR2_PACKAGE_PYTHON),python) \
> +	$(if $(BR2_PACKAGE_PYTHON3),python3) \
> +	$(if $(BR2_PACKAGE_LIBESMTP),libesmtp) \
> +	$(if $(BR2_PACKAGE_JSON_C),json-c)

When there are autoconf options associated to certain optional
dependencies, we generally prefer to have them handled in one block
like this:

ifeq ($(BR2_PACKAGE_LIBESTMP),y)
SYSLOG_NG_DEPENDENCIES += libesmtp
SYSLOG_NG_CONF_OPTS += --enable-<something>
else
SYSLOG_NG_CONF_OPTS += --disable-<something>
endif

> +SYSLOG_NG_CONF_OPTS = --disable-manpages
> +
> +ifeq ($(BR2_INIT_SYSTEMD),y)
> +SYSLOG_NG_CONF_OPTS += \
> +	--enable-systemd \
> +	--with-systemdsystemunitdir=/usr/lib/systemd/system
> +SYSLOG_NG_DEPENDENCIES += systemd
> +else
> +SYSLOG_NG_CONF_OPTS += --disable-systemd
> +endif
> +
> +define SYSLOG_NG_INSTALL_INIT_SYSV
> +	$(INSTALL) -m 0755 -D package/syslog-ng/S01logging \
> +		$(TARGET_DIR)/etc/init.d/S01logging
> +endef
> +
> +ifeq ($(BR2_PACKAGE_PYTHON)$(BR2_PACKAGE_PYTHON3),)
> +SYSLOG_NG_CONF_OPTS += --disable-python --without-python
> +endif

See above: don't only disable when not available, but also explicitly
enable when available.

> +ifeq ($(BR2_PACKAGE_LIBESMTP),)
> +SYSLOG_NG_CONF_OPTS += --disable-smtp
> +endif

Ditto.

> +
> +ifeq ($(BR2_PACKAGE_JSON_C),)
> +SYSLOG_NG_CONF_OPTS += --disable-json
> +endif

Ditto.

> +define SYSLOG_NG_FIXUP_CONFIG
> +	$(TARGET_MAKE_ENV) $(MAKE) -C $(@D) \
> +		DESTDIR=$(TARGET_DIR) scl-uninstall-local

This seems a bit weird. What needs to be uninstalled ?

> +	$(INSTALL) -D -m 0644 package/syslog-ng/syslog-ng.conf \
> +		$(TARGET_DIR)/etc/syslog-ng.conf
> +endef
> +
> +SYSLOG_NG_POST_INSTALL_TARGET_HOOKS = SYSLOG_NG_FIXUP_CONFIG
> +
> +$(eval $(autotools-package))

Thanks!

Thomas
Chris Packham Oct. 14, 2015, 7:58 a.m. UTC | #2 
On Wed, Oct 14, 2015 at 8:50 PM, Thomas Petazzoni
<thomas.petazzoni@free-electrons.com> wrote:
> Dear Chris Packham,
>
> Thanks for this new version, a few comments below.
>
> On Wed, 14 Oct 2015 20:41:28 +1300, Chris Packham wrote:
>
>> diff --git a/package/Config.in b/package/Config.in
>> index 8e3c64a..e191af7 100644
>> --- a/package/Config.in
>> +++ b/package/Config.in
>> @@ -1518,6 +1518,9 @@ endif
>>  if BR2_PACKAGE_BUSYBOX_SHOW_OTHERS
>>       source "package/sysklogd/Config.in"
>>  endif
>> +if BR2_PACKAGE_BUSYBOX_SHOW_OTHERS
>> +     source "package/syslog-ng/Config.in"
>> +endif
>
> You can probably group is with the BR2_PACKAGE_BUSYBOX_SHOW_OTHERS used
> for sysklogd.
>
>> diff --git a/package/syslog-ng/S01logging b/package/syslog-ng/S01logging
>> new file mode 100644
>> index 0000000..3fa7107
>> --- /dev/null
>> +++ b/package/syslog-ng/S01logging
>> @@ -0,0 +1,36 @@
>> +#!/bin/sh
>> +
>> +start() {
>> +  echo -n "Starting syslog-ng daemon: "
>
> Indentation should be done with one tab in the init script.
>
> And use "printf" here rather than "echo -n". We changed this in all
> init scripts about a week ago or so. The reasoning is that printf is
> POSIX, while echo -n is specific to certain shells only.
>
>> +  start-stop-daemon -S -q -p /var/run/syslog-ng.pid --exec /usr/sbin/syslog-ng
>> +  [ $? = 0 ] && echo "OK" || echo "FAIL"
>
> Using echo here is fine.
>
>
>> +# Locally computed
>> +sha1 494418ca185d912e2296dccac4ca1b38924159ff syslog-ng-3.7.1.tar.gz
>
> If it's locally computed, use a sha256.
>
>> +SYSLOG_NG_VERSION = 3.7.1
>> +SYSLOG_NG_SOURCE = syslog-ng-$(SYSLOG_NG_VERSION).tar.gz
>> +SYSLOG_NG_SITE = https://github.com/balabit/syslog-ng/releases/download/syslog-ng-$(SYSLOG_NG_VERSION)
>> +SYSLOG_NG_LICENSE = LGPL (syslog-ng core), GPL (modules)
>
> Please indicate the version of the license (GPLv2, GPLv2+, GPLv3,
> GPLv3+, etc.).

Will do.

>
>> +SYSLOG_NG_LICENSE_FILES = COPYING
>> +SYSLOG_NG_DEPENDENCIES = host-bison host-flex host-pkgconf \
>> +     eventlog libglib2 openssl pcre \
>> +     $(if $(BR2_PACKAGE_PYTHON),python) \
>> +     $(if $(BR2_PACKAGE_PYTHON3),python3) \
>> +     $(if $(BR2_PACKAGE_LIBESMTP),libesmtp) \
>> +     $(if $(BR2_PACKAGE_JSON_C),json-c)
>
> When there are autoconf options associated to certain optional
> dependencies, we generally prefer to have them handled in one block
> like this:
>
> ifeq ($(BR2_PACKAGE_LIBESTMP),y)
> SYSLOG_NG_DEPENDENCIES += libesmtp
> SYSLOG_NG_CONF_OPTS += --enable-<something>
> else
> SYSLOG_NG_CONF_OPTS += --disable-<something>
> endif
>

Noted.

>> +SYSLOG_NG_CONF_OPTS = --disable-manpages
>> +
>> +ifeq ($(BR2_INIT_SYSTEMD),y)
>> +SYSLOG_NG_CONF_OPTS += \
>> +     --enable-systemd \
>> +     --with-systemdsystemunitdir=/usr/lib/systemd/system
>> +SYSLOG_NG_DEPENDENCIES += systemd
>> +else
>> +SYSLOG_NG_CONF_OPTS += --disable-systemd
>> +endif
>> +
>> +define SYSLOG_NG_INSTALL_INIT_SYSV
>> +     $(INSTALL) -m 0755 -D package/syslog-ng/S01logging \
>> +             $(TARGET_DIR)/etc/init.d/S01logging
>> +endef
>> +
>> +ifeq ($(BR2_PACKAGE_PYTHON)$(BR2_PACKAGE_PYTHON3),)
>> +SYSLOG_NG_CONF_OPTS += --disable-python --without-python
>> +endif
>
> See above: don't only disable when not available, but also explicitly
> enable when available.
>
>> +ifeq ($(BR2_PACKAGE_LIBESMTP),)
>> +SYSLOG_NG_CONF_OPTS += --disable-smtp
>> +endif
>
> Ditto.
>
>> +
>> +ifeq ($(BR2_PACKAGE_JSON_C),)
>> +SYSLOG_NG_CONF_OPTS += --disable-json
>> +endif
>
> Ditto.
>
>> +define SYSLOG_NG_FIXUP_CONFIG
>> +     $(TARGET_MAKE_ENV) $(MAKE) -C $(@D) \
>> +             DESTDIR=$(TARGET_DIR) scl-uninstall-local
>
> This seems a bit weird. What needs to be uninstalled ?

There are a bunch of configuration files installed by default. Some of
which rely on "optional" features (json was the one that stopped
syslog-ng from starting). Technically since I'm installing a custom
config file they won't do any harm but then they're just sitting there
in the file system doing nothing.

>
>> +     $(INSTALL) -D -m 0644 package/syslog-ng/syslog-ng.conf \
>> +             $(TARGET_DIR)/etc/syslog-ng.conf
>> +endef
>> +
>> +SYSLOG_NG_POST_INSTALL_TARGET_HOOKS = SYSLOG_NG_FIXUP_CONFIG
>> +
>> +$(eval $(autotools-package))
>
> Thanks!
>
> Thomas
> --
> Thomas Petazzoni, CTO, Free Electrons
> Embedded Linux, Kernel and Android engineering
> http://free-electrons.com
Thomas Petazzoni Oct. 14, 2015, 8:01 a.m. UTC | #3 
Dear Chris Packham,

On Wed, 14 Oct 2015 20:58:49 +1300, Chris Packham wrote:

> > This seems a bit weird. What needs to be uninstalled ?
> 
> There are a bunch of configuration files installed by default. Some of
> which rely on "optional" features (json was the one that stopped
> syslog-ng from starting). Technically since I'm installing a custom
> config file they won't do any harm but then they're just sitting there
> in the file system doing nothing.

OK. Can you simply copy/paste this explanation in a comment above the
fixup commands?

Thanks!

Thomas
diff mbox

Patch

diff --git a/package/Config.in b/package/Config.in
index 8e3c64a..e191af7 100644
--- a/package/Config.in
+++ b/package/Config.in
@@ -1518,6 +1518,9 @@  endif
 if BR2_PACKAGE_BUSYBOX_SHOW_OTHERS
 	source "package/sysklogd/Config.in"
 endif
+if BR2_PACKAGE_BUSYBOX_SHOW_OTHERS
+	source "package/syslog-ng/Config.in"
+endif
 	source "package/systemd/Config.in"
 if BR2_PACKAGE_BUSYBOX_SHOW_OTHERS
 	source "package/sysvinit/Config.in"
diff --git a/package/syslog-ng/Config.in b/package/syslog-ng/Config.in
new file mode 100644
index 0000000..185a8e2
--- /dev/null
+++ b/package/syslog-ng/Config.in
@@ -0,0 +1,18 @@ 
+config BR2_PACKAGE_SYSLOG_NG
+	bool "syslog-ng"
+	select BR2_PACKAGE_EVENTLOG
+	select BR2_PACKAGE_LIBGLIB2
+	select BR2_PACKAGE_PCRE
+	select BR2_PACKAGE_OPENSSL
+	depends on BR2_USE_WCHAR # glib2
+	depends on BR2_TOOLCHAIN_HAS_THREADS
+	depends on BR2_USE_MMU # fork()
+	help
+	  syslog-ng is an enhanced log daemon, supporting a wide range of input
+	  and output methods: syslog, unstructured text, queueing, SQL & NoSQL
+
+	  https://syslog-ng.org/
+
+comment "syslog-ng needs a toolchain w/ wchar, threads"
+	depends on BR2_USE_MMU
+	depends on !BR2_USE_WCHAR || !BR2_TOOLCHAIN_HAS_THREADS
diff --git a/package/syslog-ng/S01logging b/package/syslog-ng/S01logging
new file mode 100644
index 0000000..3fa7107
--- /dev/null
+++ b/package/syslog-ng/S01logging
@@ -0,0 +1,36 @@ 
+#!/bin/sh
+
+start() {
+  echo -n "Starting syslog-ng daemon: "
+  start-stop-daemon -S -q -p /var/run/syslog-ng.pid --exec /usr/sbin/syslog-ng
+  [ $? = 0 ] && echo "OK" || echo "FAIL"
+}
+
+stop() {
+  echo -n "Stopping syslog-ng daemon: "
+  start-stop-daemon -K -q -p /var/run/syslog-ng.pid
+  [ $? = 0 ] && echo "OK" || echo "FAIL"
+}
+
+restart() {
+  stop
+  sleep 1
+  start
+}
+
+case "$1" in
+  start)
+    start
+    ;;
+  stop)
+    stop
+    ;;
+  restart|reload)
+    restart
+    ;;
+  *)
+    echo "Usage: $0 {start|stop|restart}"
+    exit 1
+esac
+
+exit $?
diff --git a/package/syslog-ng/syslog-ng.conf b/package/syslog-ng/syslog-ng.conf
new file mode 100644
index 0000000..0b4a860
--- /dev/null
+++ b/package/syslog-ng/syslog-ng.conf
@@ -0,0 +1,16 @@ 
+@version: 3.7
+
+source s_sys {
+	file("/proc/kmsg" program_override("kernel"));
+	unix-stream ("/dev/log");
+	internal();
+};
+
+destination d_all {
+	file("/var/log/messages");
+};
+
+log {
+	source(s_sys);
+	destination(d_all);
+};
diff --git a/package/syslog-ng/syslog-ng.hash b/package/syslog-ng/syslog-ng.hash
new file mode 100644
index 0000000..761ac84
--- /dev/null
+++ b/package/syslog-ng/syslog-ng.hash
@@ -0,0 +1,2 @@ 
+# Locally computed
+sha1 494418ca185d912e2296dccac4ca1b38924159ff syslog-ng-3.7.1.tar.gz
diff --git a/package/syslog-ng/syslog-ng.mk b/package/syslog-ng/syslog-ng.mk
new file mode 100644
index 0000000..da58bba
--- /dev/null
+++ b/package/syslog-ng/syslog-ng.mk
@@ -0,0 +1,55 @@ 
+################################################################################
+#
+# syslog-ng
+#
+################################################################################
+
+SYSLOG_NG_VERSION = 3.7.1
+SYSLOG_NG_SOURCE = syslog-ng-$(SYSLOG_NG_VERSION).tar.gz
+SYSLOG_NG_SITE = https://github.com/balabit/syslog-ng/releases/download/syslog-ng-$(SYSLOG_NG_VERSION)
+SYSLOG_NG_LICENSE = LGPL (syslog-ng core), GPL (modules)
+SYSLOG_NG_LICENSE_FILES = COPYING
+SYSLOG_NG_DEPENDENCIES = host-bison host-flex host-pkgconf \
+	eventlog libglib2 openssl pcre \
+	$(if $(BR2_PACKAGE_PYTHON),python) \
+	$(if $(BR2_PACKAGE_PYTHON3),python3) \
+	$(if $(BR2_PACKAGE_LIBESMTP),libesmtp) \
+	$(if $(BR2_PACKAGE_JSON_C),json-c)
+SYSLOG_NG_CONF_OPTS = --disable-manpages
+
+ifeq ($(BR2_INIT_SYSTEMD),y)
+SYSLOG_NG_CONF_OPTS += \
+	--enable-systemd \
+	--with-systemdsystemunitdir=/usr/lib/systemd/system
+SYSLOG_NG_DEPENDENCIES += systemd
+else
+SYSLOG_NG_CONF_OPTS += --disable-systemd
+endif
+
+define SYSLOG_NG_INSTALL_INIT_SYSV
+	$(INSTALL) -m 0755 -D package/syslog-ng/S01logging \
+		$(TARGET_DIR)/etc/init.d/S01logging
+endef
+
+ifeq ($(BR2_PACKAGE_PYTHON)$(BR2_PACKAGE_PYTHON3),)
+SYSLOG_NG_CONF_OPTS += --disable-python --without-python
+endif
+
+ifeq ($(BR2_PACKAGE_LIBESMTP),)
+SYSLOG_NG_CONF_OPTS += --disable-smtp
+endif
+
+ifeq ($(BR2_PACKAGE_JSON_C),)
+SYSLOG_NG_CONF_OPTS += --disable-json
+endif
+
+define SYSLOG_NG_FIXUP_CONFIG
+	$(TARGET_MAKE_ENV) $(MAKE) -C $(@D) \
+		DESTDIR=$(TARGET_DIR) scl-uninstall-local
+	$(INSTALL) -D -m 0644 package/syslog-ng/syslog-ng.conf \
+		$(TARGET_DIR)/etc/syslog-ng.conf
+endef
+
+SYSLOG_NG_POST_INSTALL_TARGET_HOOKS = SYSLOG_NG_FIXUP_CONFIG
+
+$(eval $(autotools-package))