Kernel Log Input Module (imklog)

From 8d80f53c2b03a445d3c05046c45f8d4a4beec358 Mon Sep 17 00:00:00 2001 From: Florian Riedl Date: Fri, 19 Oct 2012 08:30:45 +0200 Subject: doc: improve module doc --- doc/imklog.html | 68 +++++++++++++++++++++++++++++++++++---------------------- 1 file changed, 42 insertions(+), 26 deletions(-) diff --git a/doc/imklog.html b/doc/imklog.html index 6ccdb5b5..b62f4f92 100644 --- a/doc/imklog.html +++ b/doc/imklog.html @@ -1,8 +1,8 @@ -Kernel Log Input Module (imklog) - +Kernel Log Input Module (imklog) + back @@ -15,7 +15,10 @@ syslog engine.

Configuration Directives:

$KLogInternalMsgFacility +
LogPath
+The path to the Kernel log. This value should only be changed if you really know what +you are doing.

+
InternalMsgFacility <facility>
The facility which messages internally generated by imklog will have. imklog generates some messages of itself (e.g. on problems, startup and @@ -26,13 +29,47 @@ 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 +
PermitNonKernelFacility [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.
+
KeepKernelTimeStamp [on/off] -- +
if the Kernel creates a timestamp for its log messages, this timestamp will be preserved. +If disabled, the time when the message is received will be used.
+
ConsoleLogLevel [number] +(former klogd -c option) -- sets the console log level. If specified, only messages with +up to the specified level are printed to the console. The default is -1, which means that +the current settings are not modified. To get this behavior, do not specify +ConsoleLogLevel in the configuration file. Note that this is a global parameter. Each time +it is changed, the previous definition is re-set. The one activate will be that one that is +active when imklog actually starts processing. In short words: do not specify this +directive more than once! +

+Caveats/Known Bugs: +
This is obviously platform specific and requires platform +drivers. +Currently, imklog functionality is available on Linux and BSD.
+
This module is not supported on Solaris and not needed there. +For Solaris kernel input, use imsolaris.
+
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.
+
+module(load="imklog") + +
Legacy Configuration Directives:
+
+
$KLogInternalMsgFacility +<facility>
+equivalent to: InternalMsgFacility
+
$KLogPermitNonKernelFacility +[on/off]
+equivalent to: PermitNonKernelFacility

$DebugPrintKernelSymbols [on/off]
Linux only, ignored on other platforms (but may be specified)
@@ -50,14 +87,7 @@ it except if you have a very good reason. If you have one, let us know because otherwise new versions will no longer support it.
Linux only, ignored on other platforms (but may be specified)
$klogConsoleLogLevel [number] -(former klogd -c option) -- sets the console log level. If specified, only messages with -up to the specified level are printed to the console. The default is -1, which means that -the current settings are not modified. To get this behavior, do not specify -$klogConsoleLogLevel in the configuration file. Note that this is a global parameter. Each time -it is changed, the previous definition is re-set. The one activate will be that one that is -active when imklog actually starts processing. In short words: do not specify this -directive more than once! -
Linux only, ignored on other platforms (but may be specified)
+
equivalent to: ConsoleLogLevel
$klogUseSyscallInterface [on/off] -- former klogd -s option
Linux only, ignored on other platforms (but may be specified)
@@ -66,20 +96,6 @@ former klogd -2 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.
-
This module is not supported on Solaris and not needed there. -For Solaris kernel input, use imsolaris.
-
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.
-
-$ModLoad imklog -
[rsyslog.conf overview] [manual index] [rsyslog site]

This documentation is part of the -- cgit