Go to file
Joachim Nilsson c6c696a722 Slight formatting changes for GitHub license detection
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2019-12-07 11:07:21 +01:00
docs Remove files that are no longer needed 2019-11-15 10:08:14 +01:00
example Relicense example code/readme/makefile as public domain 2019-11-08 13:43:37 +01:00
lib Fix #3: Don't guess PID file location, use configure --runstatedir 2019-11-24 18:52:31 +01:00
man Relicense configure.ac and Makefile.am's under 3-clause BSD 2019-12-07 10:57:47 +01:00
src Relicense configure.ac and Makefile.am's under 3-clause BSD 2019-12-07 10:57:47 +01:00
test test: Increase run time for -- MARK -- test 2019-12-06 18:13:55 +01:00
.gitignore Remove klogd from the sysklogd project 2019-12-07 10:31:06 +01:00
.travis.yml Travis-CI: Fix build w/o messing up example code build 2019-11-13 17:54:35 +01:00
autogen.sh Relocate files to man/ and src/ and change to GNU configure & build 2018-08-02 22:52:40 +02:00
ChangeLog.md Update ChangeLog with license change 2019-12-07 11:05:02 +01:00
configure.ac Relicense configure.ac and Makefile.am's under 3-clause BSD 2019-12-07 10:57:47 +01:00
LICENSE Slight formatting changes for GitHub license detection 2019-12-07 11:07:21 +01:00
Makefile.am Relicense project under the 3-clause BSD license 2019-12-07 11:04:00 +01:00
README.md Update README with the removal of klogd 2019-12-07 10:31:06 +01:00
syslog.conf Update example syslog.conf with relevant and modern defaults 2019-11-03 12:19:37 +01:00
syslogd.service.in syslogd: Adopt FreeBSD -F instead of -n to run in foreground 2019-11-13 17:08:47 +01:00

                  .--.  .--.              .--.
.-----.--.--.-----|  |--|  :-----.-----.--|  |
|__ --|  |  |__ --|    <|  |  _  |  _  |  _  |    RFC3164 :: syslogd for Linux
|_____|___  |_____|__|__|__|_____|___  |_____|    RFC5424 :: w/NetBSD syslogp()
      |_____|                    |_____|

<23>Aug 24 05:14:15 192.0.2.1 myproc[8710]: Kilroy was here.
<23>1 2019-11-04T00:50:15.001234+01:00 troglobit myproc 8710 - - Kilroy was here.

BSD Badge License Badge Travis Status Coverity Status

Table of Contents

Introduction

This is the continuation of the original Debian/Ubuntu syslog daemon, updated with full RFC3164 and RFC5424 support from NetBSD and FreeBSD. The package includes the libsyslog.{a,so} library with a syslog.h header replacement, the syslogd daemon, and a command line tool called logger.

libsyslog and syslog/syslog.h, derived directly from NetBSD, expose syslogp() and other new features available only in RFC5424:

The syslogd daemon is an enhanced version of the standard Berkeley utility program, updated with DNA from FreeBSD. It is responsible for providing logging of messages received from programs and facilities on the local host as well as from remote hosts. Although compatible with standard C-library implementations of the syslog() API (GLIBC, musl libc, uClibc), libsyslog must be used in your application to unlock the new RFC5424 syslogp() API.

The included logger tool can be used from the command line, or script, to send RFC5424 formatted messages using libsyslog to syslogd for local or remote logging.

Main differences from the original sysklogd package are:

  • The separate klogd daemon is no longer part of the sysklogd project
  • Major command line changes to syslogd, for compatibilty with *BSD
  • Supports include /etc/syslog.d/*.conf directuve, see example .conf
  • Built-in log-rotation support, with compression by default, useful for embedded systems. No need for cron and a separate log rotate daemon
  • Full RFC3164 and RFC5424 support from NetBSD and FreeBSD
  • Support for sending RFC3164 style remote syslog messages, including timestamp and hostname. Defaults to send w/o for compatibility
  • Support for sending RFC5424 style remote syslog messages
  • Support for sending messages to a custom port on a remote server
  • Support for listening to a custom port
  • Support for remote peer filtering, from FreeBSD
  • Support for disabling DNS reverse lookups for each remote log message
  • Support for FreeBSD Secure Mode
  • Includes a logger tool with RFC5424 capabilities (msgid etc.)
  • Includes a syslog library and system header replacement for logging
  • FreeBSD socket receive buffer size patch
  • Avoid blocking syslogd if console is backed up
  • Touch PID file on SIGHUP, for integration with Finit
  • GNU configure & build system to ease porting/cross-compiling
  • Support for configuring remote syslog timeout

Using -lsyslog

libsyslog is by default installed as a library with a header file:

#include <syslog/syslog.h>

The output from the pkg-config tool holds no surprises:

$ pkg-config --libs --static --cflags libsyslog
-I/usr/local/include -L/usr/local/lib -lsyslog

The prefix path /usr/local/ shown here is only the default. Use the configure script to select a different prefix when installing libsyslog.

For GNU autotools based projects, use the following in configure.ac:

# Check for required libraries
PKG_CHECK_MODULES([syslog], [libsyslog >= 2.0])

and in your Makefile.am:

proggy_CFLAGS = $(syslog_CFLAGS)
proggy_LDADD  = $(syslog_LIBS)

The distribution comes with an example program that utilizes the NetBSD API and links against libsyslog.

Build & Install

The GNU Configure & Build system use /usr/local as the default install prefix. In many cases this is useful, but this means the configuration files and cache files will also use that same prefix. Most users have come to expect those files in /etc/ and /var/run/ and configure has a few useful options that are recommended to use:

$ ./configure --prefix=/usr --sysconfdir=/etc --runstatedir=/run
$ make -j5
$ sudo make install-strip

You may want to remove the --prefix=/usr option. Most users prefer non-distro binaries in /usr/local or /opt.

Building from GIT

If you want to contribute, or just try out the latest but unreleased features, then you need to know a few things about the GNU build system:

  • configure.ac and a per-directory Makefile.am are key files
  • configure and Makefile.in are generated from autogen.sh, they are not stored in GIT but automatically generated for the release tarballs
  • Makefile is generated by configure script

To build from GIT you first need to clone the repository and run the autogen.sh script. This requires automake and autoconf to be installed on your system.

git clone https://github.com/troglobit/sysklogd.git
cd sysklogd/
./autogen.sh
./configure && make

GIT sources are a moving target and are not recommended for production systems, unless you know what you are doing!

Note: some systems may have an older, or a vanilla, version of the GNU autoconf package that does not support --runstatedir (above). Users on such systems are recommended to use --localstatedir, the $runstatedir used by sysklogd is derived from that if missing.

Origin & References

This is the continuation of the original sysklogd by Dr. G.W. Wettstein and Martin Schulze. Currently maintained, and heavily updated with the latest features from NetBSD and FreeBSD, by Joachim Nilsson. Please file bug reports, or send pull requests for bug fixes and proposed extensions at GitHub.

The project is licensed under the GPL, but the main syslogd daemon and syslogp() API:s are 3-clause BSD licensed.