diff options
| author | Rainer Gerhards <rgerhards@adiscon.com> | 2008-02-21 07:02:12 +0000 |
|---|---|---|
| committer | Rainer Gerhards <rgerhards@adiscon.com> | 2008-02-21 07:02:12 +0000 |
| commit | 4ff521048dbab0557c863c28321693e1f31c6a96 (patch) | |
| tree | cbc94c2c79058a2d112e8501df004bb59b5c776c /doc | |
| parent | 013073f1a6f1ed2230feaba0865d0c14212577d0 (diff) | |
| download | rsyslog-4ff521048dbab0557c863c28321693e1f31c6a96.tar.gz rsyslog-4ff521048dbab0557c863c28321693e1f31c6a96.tar.xz rsyslog-4ff521048dbab0557c863c28321693e1f31c6a96.zip | |
fixed some doc errors - thanks to Michael Biebl for pointing them out
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/v3compatibility.html | 64 |
1 files changed, 31 insertions, 33 deletions
diff --git a/doc/v3compatibility.html b/doc/v3compatibility.html index c3e0d601..4a391f97 100644 --- a/doc/v3compatibility.html +++ b/doc/v3compatibility.html @@ -1,23 +1,22 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head> -<title>Writing syslog Data to MySQL</title> -<meta name="KEYWORDS" content="syslog, mysql, syslog to mysql, howto"> -</head> -<body> + +<title>Writing syslog Data to MySQL</title><meta name="KEYWORDS" content="syslog, mysql, syslog to mysql, howto"></head><body> <h1>Compatibility notes for rsyslog v3</h1> - <P><small><i>Written by + <p><small><i>Written by <a href="http://www.gerhards.net/rainer">Rainer - Gerhards</a> (2007-12-17)</i></small></P> -<P>Rsyslog aims to be a drop-in replacement for sysklogd. However, version 3 has + Gerhards</a> (2007-12-17)</i></small></p> +<p>Rsyslog aims to be a drop-in replacement for sysklogd. However, version 3 has some considerable enhancements, which lead to some backward compatibility issues -both in regard to sysklogd and rsyslog v1 and v2.</P> -<P>Rsyslog v3 is currently under initial development. Compatibility issues may +both in regard to sysklogd and rsyslog v1 and v2.</p> +<p>Rsyslog v3 is currently under initial development. Compatibility issues may be resolved, so be sure to check back often. Also, comments and suggestions are appreciated. Feedback right in time can now have a big impact on the route we -take ;)</P> +take ;)</p> <h2>inputs</h2> <p>With v2 and below, inputs were automatically started together with rsyslog. In v3, inputs are optional! They come in the form of plug-in modules. -<font color="#FF0000"><b>At least one input module must be loaded to make +<font color="#ff0000"><b>At least one input module must be loaded to make rsyslog do any useful work.</b></font> The config file directives doc briefly lists which config statements are available by which modules.</p> <p>It is suggested that input modules be loaded in the top part of the config @@ -34,10 +33,10 @@ $ModLoad imklog.so # provides kernel logging support (previously done by rklogd) directives have been added for them. Once we implement compatibiltiy mode, these options will return, but only if running in non-v3-native mode.</p> <h2>-m command line option</h2> -<P>The -m command line option is ignored for the time being. There is no default -mark period. If you need a 20 minute mark period you need to</P> -<P><b>$ModLoad immark.so # wherever this is<br> -$MarkMessageInterval 1800 # 20 minutes</b></P> +<p>The -m command line option is ignored for the time being. There is no default +mark period. If you need a 20 minute mark period you need to</p> +<p><b>$ModLoad immark.so # wherever this is<br> +$MarkMessageInterval 1800 # 30 minutes</b></p> <h2>-r command line option</h2> <p>Is also no longer available. Use the <b>$UDPSeverRun <port></b> config file directives. You can now also set the local address the server should listen to @@ -47,7 +46,7 @@ via <b>$UDPServerAddress <ip></b> config directive.</p> <p><b>$ModLoad imudp.so<br> $UDPSeverAddress 192.0.2.1 # this MUST be before the $UDPServerRun directive!<br> $UDPServerRun 514</b></p> -<p>"$UDPServerAddress *" means listen on all local interfaces. This is the +<p>"$UDPServerAddress *" means listen on all local interfaces. This is the default if no directive is specified.</p> <p>Please note that now multiple listeners are supported. For example, you can do the following:</p> @@ -64,30 +63,30 @@ when a UDP server was started and no port was configured. Only if that failed, the IANA default of 514 was used. For TCP serves, this lookup was never done and 514 always used if no specific port was configured. For consitency, both TCP and UDP now use port 514 as default. If a lookup is desired, you need to specify it -in the "Run" directive, e.g. "<i>$UDPServerRun syslog</i>".</p> +in the "Run" directive, e.g. "<i>$UDPServerRun syslog</i>".</p> <h2>klogd</h2> -<P>klogd has (finally) been replaced by a loadable input module. To enable klogd -functionality, do</P> -<P><b>$ModLoad imklog.so</b></P> -<P>A limited set of klogd command line settings is now supported via +<p>klogd has (finally) been replaced by a loadable input module. To enable klogd +functionality, do</p> +<p><b>$ModLoad imklog.so</b></p> +<p>A limited set of klogd command line settings is now supported via rsyslog.conf. That set of configuration directives is to be expanded. So far, we -support:</P> -<P>$klogSymbolsTwice [on/off]<br> -$DebugPrintKernelSymbols [on/off] # spits *a lot* of messages at startup</P> +support:</p> +<p>$klogSymbolsTwice [on/off]<br> +$DebugPrintKernelSymbols [on/off] # spits *a lot* of messages at startup</p> <h2>Queue Modes for the Main Message Queue</h2> -<p>Either "FixedArray" or "LinkedList" is recommended. "Direct" is available, -but should not be used except for a very good reason ("Direct" disables queueing +<p>Either "FixedArray" or "LinkedList" is recommended. "Direct" is available, +but should not be used except for a very good reason ("Direct" disables queueing and will potentially lead to message loss on the input side).</p> <h1>TODO List</h1> -<P>I have decided to move the todo list for v3 also into this document. After +<p>I have decided to move the todo list for v3 also into this document. After all, it is kind of a compatibility issue ;) But, more seriously, I think this is a good place to make sure nothing is forgotten. Remember that as of now, rsyslog v3 is in its early stage of development and so there definitely are some nits -that will give you grief. This section here tells you what it is.</P> +that will give you grief. This section here tells you what it is.</p> <h2>-c option</h2> -<P>needs to be implemented. So far, only -c3 is supported. Everything else does +<p>needs to be implemented. So far, only -c3 is supported. Everything else does not change anything but just provides a warning message. In short: there is no -backwards compatibility yet.</P> +backwards compatibility yet.</p> <h2>Thread Termination</h2> <p>Thread termination in mode 1 needs to be looked at. I begin to think that it is OK if we simply cancel the thread, because we already have a different @@ -105,7 +104,7 @@ specifically exported interface functions. Right now, we do not have an ideal world and the input modules make some calls back into the core. This needs to be re-thought but is accepted for the time being.</p> <h2>No real Modules yet</h2> -<p>As already said in "Call Encapsulation", the modules look like such, but are +<p>As already said in "Call Encapsulation", the modules look like such, but are not really able to work stand alone. The worst in this regard are</p> <ul> <li>imudp/omfwd/syslogd.c</li> @@ -117,5 +116,4 @@ there are still a large number of global variables, cross-function calls and the like. This needs to be solved when we try to claim a real modular design. That's not an easy task, but, hey, aren't we up for that...? ;)</p> <p> </p> -</body> -</html> +</body></html>
\ No newline at end of file |