mirror of
https://github.com/rsyslog/rsyslog.git
synced 2025-12-17 09:20:41 +01:00
93 lines
4.7 KiB
HTML
93 lines
4.7 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head>
|
|
<meta http-equiv="Content-Language" content="en"><title>Kernel Log Input Module (imklog)</title>
|
|
|
|
</head>
|
|
<body>
|
|
<a href="rsyslog_conf_modules.html">back</a>
|
|
|
|
<h1>Kernel Log Input Module</h1>
|
|
<p><b>Module Name: imklog</b></p>
|
|
<p><b>Author: </b>Rainer Gerhards
|
|
<rgerhards@adiscon.com></p>
|
|
<p><b>Description</b>:</p>
|
|
<p>Reads messages from the kernel log and submits them to the
|
|
syslog engine.</p>
|
|
<p><b>Configuration Directives</b>:</p>
|
|
<ul>
|
|
<li><strong>$KLogInternalMsgFacility
|
|
<facility></strong><br>
|
|
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.</li>
|
|
<li><span style="font-weight: bold;">$KLogPermitNonKernelFacility
|
|
[on/<span style="font-style: italic;">off</span>]<br>
|
|
</span>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.<span style="font-weight: bold;"></span></li>
|
|
<li><span style="font-weight: bold;"></span>$DebugPrintKernelSymbols
|
|
[on/<b>off</b>]<br>
|
|
Linux only, ignored on other platforms (but may be specified)</li>
|
|
<li><b>$klogLocalIPIF</b> [interface name] - (available since 5.9.6) - if provided, the IP of the specified
|
|
interface (e.g. "eth0") shall be used as fromhost-ip for imklog-originating messages.
|
|
If this directive is not given OR the interface cannot be found (or has no IP address),
|
|
the default of "127.0.0.1" is used.
|
|
</li>
|
|
<li>$klogSymbolLookup [on/<b>off</b>] --
|
|
disables imklog kernel symbol translation (former klogd -x option). NOTE that
|
|
this option is counter-productive on recent kernels (>= 2.6) because the
|
|
kernel already does the symbol translation and this option breaks the information.<br>
|
|
<b>This option is scheduled for removal, probably with version 4.x.</b> Do not use
|
|
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.<br>
|
|
Linux only, ignored on other platforms (but may be specified)</li>
|
|
<li><b>$klogConsoleLogLevel</b> [<i>number</i>]
|
|
(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!
|
|
<br><b>Linux only</b>, ignored on other platforms (but may be specified)</li>
|
|
<li><b>$klogUseSyscallInterface</b> [on/<b>off</b>]
|
|
-- former klogd -s option<br>
|
|
Linux only, ignored on other platforms (but may be specified)</li>
|
|
<li>$klogSymbolsTwice [on/<b>off</b>] --
|
|
former klogd -2 option<br>
|
|
Linux only, ignored on other platforms (but may be specified)<br style="font-weight: bold;">
|
|
</li>
|
|
</ul>
|
|
<b>Caveats/Known Bugs:</b>
|
|
<p>This is obviously platform specific and requires platform
|
|
drivers.
|
|
Currently, imklog functionality is available on Linux and BSD.</p>
|
|
<p>This module is <b>not supported on Solaris</b> and not needed there.
|
|
For Solaris kernel input, use <a href="imsolaris.html">imsolaris</a>.</p>
|
|
<p><b>Sample:</b></p>
|
|
<p>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.<br>
|
|
</p>
|
|
<textarea rows="15" cols="60">$ModLoad imklog
|
|
</textarea>
|
|
<p>[<a href="rsyslog_conf.html">rsyslog.conf overview</a>]
|
|
[<a href="manual.html">manual index</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
|
|
<p><font size="2">This documentation is part of the
|
|
<a href="http://www.rsyslog.com/">rsyslog</a>
|
|
project.<br>
|
|
Copyright © 2008-2009 by <a href="http://www.gerhards.net/rainer">Rainer
|
|
Gerhards</a> and
|
|
<a href="http://www.adiscon.com/">Adiscon</a>.
|
|
Released under the GNU GPL version 3 or higher.</font></p>
|
|
</body></html>
|