diff options
| author | Rainer Gerhards <rgerhards@adiscon.com> | 2011-10-27 09:56:54 +0200 |
|---|---|---|
| committer | Rainer Gerhards <rgerhards@adiscon.com> | 2011-10-27 09:56:54 +0200 |
| commit | 272f0a5b3d285a1ecff01d216254c95863b0d444 (patch) | |
| tree | 8ee70648ac83411b221443902d9e8e18ce6a614f /doc/v6compatibility.html | |
| parent | e7701775553a60efb050b0df497bb4df5df46d62 (diff) | |
| parent | 16dc3aab3db9b8db4cb4fc8d241d4cd5d5362b8a (diff) | |
| download | rsyslog-272f0a5b3d285a1ecff01d216254c95863b0d444.tar.gz rsyslog-272f0a5b3d285a1ecff01d216254c95863b0d444.tar.bz2 rsyslog-272f0a5b3d285a1ecff01d216254c95863b0d444.zip | |
Merge branch 'beta'
Conflicts:
ChangeLog
configure.ac
doc/manual.html
doc/v6compatibility.html
Diffstat (limited to 'doc/v6compatibility.html')
| -rw-r--r-- | doc/v6compatibility.html | 37 |
1 files changed, 34 insertions, 3 deletions
diff --git a/doc/v6compatibility.html b/doc/v6compatibility.html index 7c99ab63..e682c56b 100644 --- a/doc/v6compatibility.html +++ b/doc/v6compatibility.html @@ -4,14 +4,45 @@ <body> <h1>Compatibility Notes for rsyslog v6</h1> <p><small><i>Written by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> -(2011-07-13)</i></small></p> +(2011-10-27)</i></small></p> <p> This document describes things to keep in mind when moving from v5 to v6. It does not list enhancements nor does it talk about compatibility concerns introduced by earlier versions (for this, see their respective compatibility documents). Its focus is primarily on what you need to know if you used a previous version and want to use the -current one without hassle. Note that versions prior to 6.3.3 did not have any notable compatibility -concerns. So all said here is for 6.3.3 and above. +current one without hassle. +<p>Version 6 offers a better config language and some other improvements. +As the config system has many ties into the rsyslog engine AND all plugins, +the changes are somewhat intrusive. Note, however, that core processing has +not been changed much in v6 and will not. So once the configuration is loaded, +the stability of v6 is quite comparable to v5. +</p> +<h2>Property "pri-text"</h2> +<p>Traditionally, this property did not only return the textual form +of the pri ("local0.err"), but also appended the numerical value to it +("local0.err<133>"). This sounds odd and was left unnoticed for some years. +In October 2011, this odd behaviour was brought up on the rsyslog mailing list +by Gregory K. Ruiz-Ade. Code review showed that the behaviour was intentional, +but no trace of what the intention was when it was introduced could be found. +The documentation was also unclear, it said no numerical value was present, +but the samples had it. We agreed that the additional numerical value is +of disadvantage. We also guessed that this property is very rarely being used, +otherwise the problem should have been raised much earlier. However, we +didn't want to change behaviour in older builds. So v6 was set to clean up +the situation. In v6, text-pri will always return the textual part only +("local0.err") and the numerical value will not be contained any longer inside +the string. If you actually need that value, it can fairly easily be added +via the template system. +<p><b>If you have used this property previously and relied on the numerical +part, you need to update your rsyslog configuration files.</b> +<h2>Plugin ABI</h2> +<p>The plugin interface has considerably been changed to support the new +config language. All plugins need to be upgraded. This usually does not require +much coding. However, if the new config language shall be supported, more +changes must be made to plugin code. All project-supported plugins have been +upgraded, so this compatibility issue is only of interest for you if you have +custom plugins or use some user-contributed plugins from the rsyslog project +that are not maintained by the project itself (omoracle is an example). <h2>RainerScript based rsyslog.conf</h2> <p>A better config format was the main release target for rsyslog v6. It comes in the flavor of so-called RainerScript |