diff options
| -rw-r--r-- | doc/features.html | 9 | ||||
| -rw-r--r-- | doc/history.html | 73 | ||||
| -rw-r--r-- | doc/manual.html | 7 | ||||
| -rw-r--r-- | doc/status.html | 17 |
4 files changed, 61 insertions, 45 deletions
diff --git a/doc/features.html b/doc/features.html index 466b99cb..725c3d7d 100644 --- a/doc/features.html +++ b/doc/features.html @@ -31,7 +31,8 @@ is going on, you can also subscribe to the <a href="http://lists.adiscon.net/mai messages<li>control of whether the local hostname or the hostname of the origin of the data is shown as the hostname in the output<li>ability to preserve the original hostname in NAT environments and relay chains - <li>ability to limit the allowed network senders<li>powerful BSD-style
hostname and program name blocks for easy multi-host support<li>
multi-threaded<li>very
experimental and volatile support for <a href="syslog-protocol.html">syslog-protocol</a>
compliant messages (it is volatile because standardization is currently
underway and this is a proof-of-concept implementation to aid this effort)<li> + <li>ability to limit the allowed network senders<li>powerful BSD-style
hostname and program name blocks for easy multi-host support<li>
multi-threaded (<a href="http://rgerhards.blogspot.com/2007/08/why-is-rsyslog-multi-threaded-and-is-it.html">is + this important? why?</a>)<li>very
experimental and volatile support for <a href="syslog-protocol.html">syslog-protocol</a>
compliant messages (it is volatile because standardization is currently
underway and this is a proof-of-concept implementation to aid this effort)<li> experimental support for syslog-transport-tls based framing on syslog/tcp connections<li> a copy of klogd.c has been included under the name of rklogd for those Linux @@ -62,9 +63,11 @@ at some time moved back to the sourceforge tracker.</p> knowledge<li>provide an on-disk queue for syslog messages; should be combined with reliable delivery to the next hop<li>support for native SSL enryption of plain tcp syslog sessions. This will most probably happen based on syslog-transport-tls.<li>even more enhanced multi-threading, - with a message queue for each selector line (when implementing this, search + with a message queue for each action (when implementing this, search for CHECKMULTIQUEUE comments in the source - they already contain hints of - what to look at).<li>pcre filtering - maybe (depending on feedback) - simple regex already + what to look at). Some detail information on this can already be found in + <a href="http://rgerhards.blogspot.com/2007/08/syslog-worker-pools-future-hardware-and.html"> + Rainer's blog</a>.<li>pcre filtering - maybe (depending on feedback) - simple regex already partly added. So far, this seems sufficient so that there is no urgent need to do pcre<li>support for
<a href="http://www.monitorware.com/Common/en/glossary/rfc3195.php">RFC 3195</a>
as a sender - this is currently unlikely to happen, because there is no real demand for it. Any work on RFC 3195 has been suspend until we see some real diff --git a/doc/history.html b/doc/history.html index 02dec93c..48a64892 100644 --- a/doc/history.html +++ b/doc/history.html @@ -8,54 +8,52 @@ <b>Rsyslog is a GPL-ed, enhanced syslogd. Among others, it offers support for reliable syslog over TCP, writing to MySQL databases and fully configurable output formats (including great timestamps).</b> -Rsyslog was initiated by Rainer Gerhards. It has -been forked from the <a href="http://www.infodrom.org/projects/sysklogd/">sysklogd standard package</a>. +Rsyslog was initiated by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a>. +If you are interested to learn why Rainer initiated the project, you +may want to read his blog posting on "<a href="http://rgerhards.blogspot.com/2007/08/why-does-world-need-another-syslogd.html">why +the world neeeds another syslogd</a>".<p>Rsyslog has +been forked in <b>2004</b> from the <a href="http://www.infodrom.org/projects/sysklogd/">sysklogd standard package</a>. The goal of the -rsyslog project is to provide a more configurable and reliable -syslog deamon while retaining drop-in replacement capabilities for stock syslogd. By "reliable", we mean support for reliable transmission -modes like TCP or <a href="http://www.monitorware.com/Common/en/glossary/rfc3195.php">RFC 3195</a> (syslog-reliable). -We do NOT imply that the sysklogd package is unreliable. In fact, the -opposite is the case and we assume that for the time being the well-used -sysklogd package offers better program reliability than our -brand-new modifications to it. - -</p><p>The name "rsyslog" stems back to the +rsyslog project is to provide a feature-richer and reliable +syslog deamon while retaining drop-in replacement capabilities to stock syslogd. By "reliable", we mean support for reliable transmission +modes like TCP or <a href="http://www.monitorware.com/Common/en/glossary/rfc3195.php">RFC 3195</a> +(syslog-reliable). We do NOT imply that the sysklogd package is unreliable.</p> +<p>The name "rsyslog" stems back to the planned support for syslog-reliable. Ironically, the initial release of rsyslog did NEITHER support syslog-reliable NOR tcp based syslog. -Instead, it contains enhanced configurability and other enhancements -(like database support). The reason for this is that full support for -RFC 3195 would require even more changes and especially fundamental architectural +Instead, it contained enhanced configurability and other enhancements +(like database support). The reason for this is that full support for RFC 3195 would require even more changes and especially fundamental architectural changes. Also, questions asked on the loganalysis list and at other places indicated that RFC3195 is NOT a prime priority for users, but -rather better control over the output format. So here we are, with +rather better control over the output format. So there we were, with a rsyslod that covers a lot of enhancements, but not a single one of these that made its name ;) Since version 0.9.2, receiving syslog messages via plain tcp is finally supported, a bit later sending via TCP, too. Starting with 1.11.0, RFC 3195 is finally support at the receiving side (a.k.a. "listener"). Support for sending via RFC 3195 is still due. Anyhow, rsyslog has come much -closer to what it name promises.</p><p> -The next enhancement scheduled is support for the new syslog-protocol -internet draft format, not the least to see how easy/complicated it is -to implement. We already know that some subleties of syslog-protocol will -require at least one considerable architectural change to the syslogd -and this might delay things a little. Our immediate goal is to receive -feedback and get the bugs out of the current release. Only after that -we intend to advance the code and introduce new features. -</p><p> -The database support was included so that our web-based syslog interface -can be used. This is another open source project which can be found +closer to what it name promises.</p> +<p> +The database support was initially included so that our web-based syslog +interface could be used. This is another open source project which can be found under <a href="http://www.phplogcon.org">http://www.phplogcon.org</a>. We highly recommend having a look at it. It might not work for you if you expect thousands of messages per second (because your database won't be able to provide adequate performance), but in many cases it is a very handy analysis and troubleshooting tool. +In the mean time, of course, lots of people have found many applications for +writing to databases, so the prime focus is no longer on phpLogcon. + </p> <p>Rsyslogd supports an enhanced syslog.conf file format, and also works with the standard syslog.conf. In theory, it should be possible to simply replace the syslogd binary with the one that comes with rsyslog. Of course, in order to use any of the new features, you must re-write your syslog.conf. To learn how to do this, please review our commented <a href="sample.conf.php">sample.conf</a> -file. It outlines the enhancements over stock syslogd. +file. It outlines the enhancements over stock syslogd. Discussion has often +arisen of whether having an "old syslogd" logfile format is good or evil. So +far, this has not been solved (but Rainer likes the idea of a new format), so we +need to live with it for the time being. It is planned to be reconsidered in the +3.x release time frame. <p>If you are interested in the <a href="http://en.wikipedia.org/wiki/IHE">IHE</a> environment, you might be interested to hear that rsyslog supports message with sizes of 32k and more. This feature has been tested, but by default is turned off @@ -65,14 +63,29 @@ will find easy and precise instructions on what you need to change (it's just one line of code!). Please note that RFC 3195/COOKED supports 1K message sizes only. It'll probably support longer messages in the future, but it is our believe that using larger messages with current RFC 3195 is a violation of the -standard.<p>In <b>June 2007</b>, Peter Vrabec from Red Hat helped us to create +standard.<p>In <b>February 2007</b>, 1.13.1 was released and served for quite a +while as a stable reference. Unfortunately, it was not later released as stable, +so the stable build became quite outdated.<p>In <b>June 2007</b>, Peter Vrabec from Red Hat helped us to create RPM files for Fedora as well as supporting IPv6. There also seemed to be some interest from the Red Hat community. This interest and new ideas resulted in a very busy time with many great additions.<p>In <b>July 2007</b>, Andrew Pantyukhin added BSD ports files for rsyslog and liblogging. We were strongly encouraged by this too. It looks like rsyslog is getting more and more momentum. -Let's see what comes next...<p>Be sure to visit Rainer's <a href="http://rgerhards.blogspot.com/">syslog block</a> -to get some more insight into the development of rsyslog and syslog in general.</p> +Let's see what comes next...<p>Also in <b>July 2007</b> (and beginning of +August), Rainer remodled the output part of rsyslog. It got a clean object model +and is now prepared for a plug-in architecture. During that time, some base +ideas for the overall new object model appeared.<p>In <b>August 2007</b> +community involvment grew more and more. Also, more packages appeared. We were +quite happy about that. To facilitate user contributíons, we set up a +<a href="http://wiki.rsyslog.com/">wiki</a> on August 10th, 2007. Also in August +2007, rsyslog 1.18.2 appeared, which is deemed to be quite close to the final +2.0.0 release. With its appearance, the pace of changes was deliberatly reduced, +in order to allow it to mature (see Rainers's +<a href="http://rgerhards.blogspot.com/2007/07/pace-of-changes-in-rsyslog.html"> +blog post</a> on this topic, written a bit early, but covering the essence).<p>Be sure to visit Rainer's <a href="http://rgerhards.blogspot.com/">syslog block</a> +to get some more insight into the development and futures of rsyslog and syslog in general. +Don't be shy to post to either the blog or the +<a href="http://www.rsyslog.com/PNphpBB2.phtml">rsyslog forums</a>.</p> <h2>Some useful links</h2> <ul> <li><a href="http://www.rsyslog.com/Topic4.phtml">the rsyslog change log</a></li> diff --git a/doc/manual.html b/doc/manual.html index e154bfd3..3496c85c 100644 --- a/doc/manual.html +++ b/doc/manual.html @@ -5,7 +5,7 @@ <body>
<h1>RSyslog - Documentation</h1>
<p><b><a href="http://www.rsyslog.com/">Rsyslog</a> is an enhanced syslogd
-supporting, among others, <a href="rsyslog_mysql.html">MySQL</a>, syslog/tcp,
+supporting, among others, <a href="rsyslog_mysql.html">MySQL</a>,
<a href="http://wiki.rsyslog.com/index.php/FailoverSyslogServer">failover log
destinations</a>, syslog/tcp,
fine grain output format control, and the ability to filter on any message part.</b>
It is quite compatible to stock
sysklogd and can be used as a drop-in replacement. Its <a href="features.html">
@@ -33,12 +33,13 @@ helps. Learn <a href="how2help.html">how to help the rsyslog project</a>.</p> <a href="rsyslog084-freebsd5.4.txt">Syslog-to-SQL with rsyslog-0.8.4 on FreeBSD 5.4</a>
(which unfortunately is a bit outdated now).</p>
<p>Our <a href="history.html">rsyslog history</a> page is for you if you would like to learn a little more
-on why there is an rsyslog at all.</p>
+on why there is an rsyslog at all. If you are interested why you should care
about rsyslog at all, you may want to read Rainer's essay on "<a href="http://rgerhards.blogspot.com/2007/08/why-does-world-need-another-syslogd.html">why
the world needs another syslogd</a>".</p>
<p>Documentation is added continuously. Please note that the documentation here
matches only the current version of rsyslog. If you use an older version, be sure
to use the doc that came with it.</p>
<p><b>You can also browse the following online resources:</b></p>
<ul>
+<li>the <a href="http://wiki.rsyslog.com/">rsyslog wiki</a>, a community
resource</li>
<li><a href="http://www.rsyslog.com/module-Static_Docs-view-f-manual.html.phtml">rsyslog online documentation</a></li>
<li><a href="http://www.rsyslog.com/Topic3.phtml">rsyslog FAQ</a></li>
<li><a href="http://www.rsyslog.com/PNphpBB2.phtml">rsyslog discussion forum</a></li>
@@ -47,7 +48,7 @@ to use the doc that came with it.</p> </ul>
<p>And don't forget about the <a href="http://lists.adiscon.net/mailman/listinfo/rsyslog">rsyslog mailing list</a>.
If you are interested in the "backstage", you may find
-<a href="http://www.adiscon.com/en/people/rainer-gerhards.php">Rainer</a>'s
+<a href="http://www.gerhards.net/rainer">Rainer</a>'s
<a href="http://rgerhards.blogspot.com/">blog</a> an interesting read (filter on
syslog and rsyslog tags).</p>
</body>
</html>
diff --git a/doc/status.html b/doc/status.html index f05e321c..77fa50cd 100644 --- a/doc/status.html +++ b/doc/status.html @@ -16,13 +16,12 @@ because they contain a SQL injection vulnerability</b></font> (<a href="http://www.rsyslog.com/Article35.phtml">read security advisory</a>).</p> <h2>Platforms</h2> -<ul> - <li>Linux [tested on Red Hat & Debian]</li> - <li>BSD [tested on -FreeBSD and a quick Test on NetBSD, 0.8.4 only]</li> - <li>[Solaris] - some folks have used it there, but its still not officially - supported...</li> -</ul> +<p>Thankfully, a number of folks have begin to build packages and help port +rsyslog to other platforms. As such, +<a href="http://wiki.rsyslog.com/index.php/Platforms">the platform list is now +maintened inside the rsyslog wiki</a>. Platform maintainers perhaps have posted +extra information there. If you do platform-specific work, feel free to add +information to the wiki.</p> <h2>Additional information</h2> <p><b>Currently supported features are listed on the <a href="features.html">rsyslog features page</a>.</b></p> <ul> @@ -34,10 +33,10 @@ FreeBSD and a quick Test on NetBSD, 0.8.4 only]</li> http://www.rsyslog.com/Topic4.phtml</a>. </li> <li>Online documentation is available at <a href="http://www.rsyslog.com/doc">http://www.rsyslog.com/doc</a>.</li> - <li>You may also find <a href="http://blog.gerhards.net/">Rainer's blog</a> an interesting read.</li> + <li>You may also find <a href="http://rgerhards.blogspot.com/">Rainer's blog</a> an interesting read.</li> </ul> <p>The project was initiated in 2004 by -<a href="http://www.adiscon.com/en/people/rainer-gerhards.php">Rainer Gerhards</a> +<a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> and is currently being maintained by him. See the <a href="history.html">history page</a> for more background information.</p> </body> |