From b9198d251218f13803cf121c4ef5f69a0e850d24 Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Tue, 15 Apr 2008 09:08:46 +0200 Subject: improved doc for imklog --- doc/Makefile.am | 3 +++ doc/imklog.html | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++ doc/rsyslog_conf.html | 17 +++---------- 3 files changed, 76 insertions(+), 13 deletions(-) create mode 100644 doc/imklog.html diff --git a/doc/Makefile.am b/doc/Makefile.am index aa4e8a7d..7055cbc4 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -32,6 +32,9 @@ html_files = \ imfile.html \ imtcp.html \ imgssapi.html \ + imrelp.html \ + imuxsock.html \ + imgklog.html \ professional_support.html \ queues.html \ queueWorkerLogic.dia \ diff --git a/doc/imklog.html b/doc/imklog.html new file mode 100644 index 00000000..92c1881a --- /dev/null +++ b/doc/imklog.html @@ -0,0 +1,69 @@ + + +Kernel Log Input Module (imklog) + + + +

Kernel Log Input Module

Module Name: imklog

Author: Rainer Gerhards +<rgerhards@adiscon.com>

Description:

Reads messages from the kernel log and submits them to the +syslog engine.

Configuration Directives:

$KLogInternalMsgFacility +<facility>
+The facility which messages internally generated by imklog will have. +imklog generates some messages of itself (e.g. on problems, startup and +shutdown) and these do not stem from the kernel. Historically, under +Linux, these too have "kern" facility. Thus, on Linux platforms the +default is "kern" while on others it is "syslogd". You usually do not +need to specify this configuratin directive - it is included primarily +for few limited cases where it is needed for good reason. Bottom line: +if you don't have a good idea why you should use this setting, do not +touch it.
$KLogPermitNonKernelFacility +[on/off]
+At least under BSD the kernel log may contain entries +with non-kernel facilities. This setting controls how those are +handled. The default is "off", in which case these messages are +ignored. Switch it to on to submit non-kernel messages to rsyslog +processing.
$DebugPrintKernelSymbols +(imklog) [on/off]
+Linux only, ignored on other platforms (but may be specified)
$klogSymbolLookup (imklog) [on/off] -- +former klogd -x option
+Linux only, ignored on other platforms (but may be specified)
$klogUseSyscallInterface (imklog) [on/off] +-- former klogd -2 option
+Linux only, ignored on other platforms (but may be specified)
$klogSymbolsTwice (imklog) [on/off] -- +former klogd -s option
+Linux only, ignored on other platforms (but may be specified)
+

+Caveats/Known Bugs: +

This is obviously platform specific and requires platform +drivers. +Currently, imklog functionality is available on Linux and BSD.

Sample:

The following sample pulls messages from the kernel log. All +parameters are left by default, which is usually a good idea. Please +note that loading the plugin is sufficient to activate it. No directive +is needed to start pulling kernel messages.
+

+ +

[rsyslog.conf overview] +[manual index] [rsyslog site]

+ \ No newline at end of file diff --git a/doc/rsyslog_conf.html b/doc/rsyslog_conf.html index 8967f671..9325f73c 100644 --- a/doc/rsyslog_conf.html +++ b/doc/rsyslog_conf.html @@ -1,7 +1,5 @@ -rsyslog.conf file - - +rsyslog.conf file

rsyslog.conf configuration file

This document is currently being enhanced. Please @@ -49,7 +47,7 @@ plugin for plain tcp syslog

imgssapi - input plugin for plain tcp and GSS-enable syslog

immark - support for mark messages
-
imklog - kernel logging
+
imklog - kernel logging

imuxsock - unix sockets, including the system log socket
@@ -126,7 +124,7 @@ worker threads, default 1, recommended 1
$AllowedSender

$ControlCharacterEscapePrefix

$DebugPrintCFSyslineHandlerList
-
$DebugPrintKernelSymbols (imklog) [on/off]
+
$DebugPrintModuleList

$DebugPrintTemplateList

$DirCreateMode
@@ -143,14 +141,7 @@ worker threads, default 1, recommended 1
$GssForwardServiceName

$GssListenServiceName

$GssMode
-
$IncludeConfig
-
$klogSymbolLookup (imklog) [on/off] -- -former klogd -x option
-
$klogUseSyscallInterface (imklog) [on/off] --- former klogd -2 option
-
$klogSymbolsTwice (imklog) [on/off] -- -former klogd -s option
-
$MainMsgQueueCheckpointInterval <number>
+
$IncludeConfig
MainMsgQueueCheckpointInterval <number>

$MainMsgQueueDequeueSlowdown <number> [number is timeout in microseconds (1000000us is 1sec!), default 0 (no delay). Simple rate-limiting!]
-- cgit