18f9611d3e
Signed-off-by: Joachim Nilsson <troglobit@gmail.com> |
||
---|---|---|
docs | ||
example | ||
lib | ||
man | ||
src | ||
test | ||
.gitignore | ||
.travis.yml | ||
autogen.sh | ||
ChangeLog.md | ||
configure.ac | ||
COPYING | ||
klogd.service.in | ||
Makefile.am | ||
README.md | ||
syslog.conf | ||
syslogd.service.in |
.--. .--. .--.
.-----.--.--.-----| |--| :-----.-----.--| |
|__ --| | |__ --| <| | _ | _ | _ | RFC3164 :: syslogd for Linux
|_____|___ |_____|__|__|__|_____|___ |_____| RFC5424 :: w/NetBSD syslogp()
|_____| |_____|
Aug 24 05:14:15 192.0.2.1 myproc[8710]: Kilroy was here.
2019-11-04T00:50:15.001234+01:00 troglobit myproc 8710 - - Kilroy was here.
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 and a
syslog.h
header file replacement, two system log daemons, syslogd
and klogd
(optional), and one 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 optional klogd
daemon, enabled with configure --with-klogd
,
supports the GLIBC klogctl()
API to read kernel log messages and can
also decode EIP addresses on Linux Oops, provided a System.map
file.
The syslogd
daemon can run stand-alone without klogd
, this is the
default.
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:
- Support for
include /etc/syslog.d/*.conf
, 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
- Includes timestamp and hostname, RFC3164 style, in remote logging
- Support for sending RFC5424 style remote syslog messages
- Support for sending messages to a custom port on a remote server
- Includes a
logger
tool with RFC5424 capabilities (msgid
etc.) - Includes a 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 --localstatedir=/var
$ make -j5
$ sudo make install-strip
You may want to remove the --prefix=/usr
option.
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-directoryMakefile.am
are key filesconfigure
andMakefile.in
are generated fromautogen.sh
, they are not stored in GIT but automatically generated for the release tarballsMakefile
is generated byconfigure
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!
Origin & References
This is the continuation of the original sysklogd by Dr. G.W. Wettstein and Martin Schulze. Currently maintained, and heavily updated, 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.