From 601393acd7fcd4446b57314cb070cfd17abda2ee Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Thu, 18 Oct 2007 16:17:32 +0000 Subject: added doc fixes provided by Michael Biebl - thanks --- ChangeLog | 1 + doc/Makefile.am | 3 +++ doc/bugs.html | 4 ++-- doc/contributors.html | 2 +- doc/features.html | 2 +- doc/generic_design.html | 12 +++++------ doc/history.html | 16 +++++++------- doc/how2help.html | 10 ++++----- doc/install.html | 10 ++++----- doc/ipv6.html | 6 +++--- doc/man_rsyslogd.html | 10 ++++----- doc/modules.html | 16 +++++++------- doc/rsconf1_allowedsender.html | 4 ++-- doc/rsconf1_controlcharacterescapeprefix.html | 4 ++-- doc/rsconf1_droptrailinglfonreception.html | 4 ++-- doc/rsconf1_escapecontrolcharactersonreceive.html | 4 ++-- doc/rsconf1_filecreatemode.html | 4 ++-- doc/rsconf1_mainmsgqueuesize.html | 6 +++--- doc/rsconf1_moddir.html | 2 +- doc/rsconf1_modload.html | 4 ++-- doc/rsyslog_conf.html | 26 +++++++++++------------ doc/rsyslog_recording_pri.html | 4 ++-- doc/status.html | 2 +- doc/syslog-protocol.html | 12 +++++------ doc/version_naming.html | 10 ++++----- 25 files changed, 91 insertions(+), 87 deletions(-) diff --git a/ChangeLog b/ChangeLog index 41641d2d..2737af8b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -8,6 +8,7 @@ Version 1.19.10 (rgerhards), 2007-10-15 - updated rsyslogd doc set man page; now in html format - undid creation of a separate thread for the main loop -- this did not turn out to be needed or useful, so reduce complexity once again. +- added doc fixes provided by Michael Biebl - thanks --------------------------------------------------------------------------- Version 1.19.9 (rgerhards), 2007-10-12 - now packaging system which again contains all components in a single diff --git a/doc/Makefile.am b/doc/Makefile.am index ed6dc2c8..74e1be69 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -7,6 +7,8 @@ html_files = \ install.html \ ipv6.html \ manual.html \ + man_rsyslogd.html \ + modules.html \ property_replacer.html \ rsyslog_conf.html \ rsyslog_mysql.html \ @@ -39,6 +41,7 @@ html_files = \ rsconf1_includeconfig.html \ rsconf1_mainmsgqueuesize.html \ rsconf1_modload.html \ + rsconf1_moddir.html \ rsconf1_repeatedmsgreduction.html \ rsconf1_resetconfigvariables.html \ rsconf1_umask.html diff --git a/doc/bugs.html b/doc/bugs.html index 41404e51..8f775600 100644 --- a/doc/bugs.html +++ b/doc/bugs.html @@ -29,12 +29,12 @@ single-threaded mode rsyslogd offers great performance (just think that stock sysklogd has always been using a single thread, only).

forwarding remotely received messages

Sysklogd does not forward remotely received messages to other network -destionation except when the -h option is given. This code is currently defunct. +destination except when the -h option is given. This code is currently defunct. No matter if -h is specified or not, messages are ALWAYS forwarded. It is currently under review if the sysklogd's functionality is actually needed. Please see my blog -post on this topic for futher detail.

+post on this topic for further detail.

EQUALLY-NAMED TEMPLATES

If multiple templates with the SAME name are created, all but the first definition is IGNORED. So you can NOT (yet) replace a diff --git a/doc/contributors.html b/doc/contributors.html index ebbf1a5d..713c3299 100644 --- a/doc/contributors.html +++ b/doc/contributors.html @@ -10,7 +10,7 @@ Unfortunately, I have begun this page in July of 2007, long after the project started. I try to extract all past contributor information from CVS, readme's, code etc - but I may fail. If you contributed and do not find yourself listed below, please accept my sincere apologies and drop me a line.

Please also note that I will do the checks for past contibutors once the +

Please also note that I will do the checks for past contributors once the current very busy development phase is over, so it may take a few weeks to fully populate this file.

Contributors are listed in alphabetical order. If I know an Alias only, that diff --git a/doc/features.html b/doc/features.html index f451c857..6f2e7e89 100644 --- a/doc/features.html +++ b/doc/features.html @@ -59,7 +59,7 @@ at some time moved back to the sourceforge tracker.

create a plug-in-interface - we are very close to this. A neat interface is already used internally for output modules and the MySQL module already - works as a plug-in. However, no interface defintion is yet formally + works as a plug-in. However, no interface definition is yet formally published.
implement native email-functionality in selector (probably best done as a plug-in)
port it to more *nix variants (eg AIX and HP UX) - this needs volunteers with access to those machines and diff --git a/doc/generic_design.html b/doc/generic_design.html index 03a55fae..74dbd807 100644 --- a/doc/generic_design.html +++ b/doc/generic_design.html @@ -56,7 +56,7 @@ knowing the generic architecture.
Generic Syslog Application Architecture
- A "syslog application" is an application whos purpose is the +
- A "syslog application" is an application whose purpose is the processing of syslog messages. It may be part of a larger application with a broader purpose. An example: a database application might come with its own syslog send subsystem and not @@ -69,7 +69,7 @@ syslog messages.
- Payload Orginators ("PLOrig") are the orginal creators of payload. +
- Payload Originators ("PLOrig") are the original creators of payload. Typically, these are application programs.
- A "Remote PLOrig" is a payload originator residing in a different application than the syslog application itself. That application @@ -114,7 +114,7 @@ another syslog application.
- A "RelEng Ext" is an extension that processes syslog information as it enters or exits a RelayEng. An example of such a component might be a relay cryptographically signing received syslog -messages. Such a function might be useful to guarantee authenticy +messages. Such a function might be useful to guarantee authenticity starting from a given point inside a relay chain.
- A "CollectorEng" is a collector engine. At this component, syslog information leaves the syslog system and is translated into some @@ -124,7 +124,7 @@ defined to be of native syslog type.
- A "GWO" is an outbound gateway. An example of this might be the forwarding of syslog information via SNMP or SMTP. Please note @@ -132,13 +132,13 @@ that when a GWO directly connects to a GWI on a different syslog application, no native exchange of syslog information takes place. Instead, the native protocol of these gateways (e.g. SNMP) is used. The syslog information is embedded inside that protocol. -Depending on protocol and gatway implementation, some of the +Depending on protocol and gateway implementation, some of the native syslog information might be lost.
- A "Store" is any way to persistently store the extracted syslog information, e.g. to the file system or to a data base.
- "Disc" means the discarding of messages. Operators often find it useful to discard noise messages and so most syslog applications
  contain a way to do that.
- The ellipsis after "Disc" indicates that there are potentially avariety of different other ways to consume syslog information.
- The ellipsis after "Disc" indicates that there are potentially a variety of different other ways to consume syslog information.
- There may be multiple instances of each of the described components in a single syslog application.
- A syslog application is made up of all or some of the above diff --git a/doc/history.html b/doc/history.html index 48a64892..cd432293 100644 --- a/doc/history.html +++ b/doc/history.html @@ -11,11 +11,11 @@ MySQL databases and fully configurable output formats (including great timestamp Rsyslog was initiated by Rainer Gerhards. If you are interested to learn why Rainer initiated the project, you may want to read his blog posting on "why -the world neeeds another syslogd".
  Rsyslog has +the world needs another syslogd".
  Rsyslog has been forked in 2004 from the sysklogd standard package. The goal of 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 +syslog daemon while retaining drop-in replacement capabilities to stock syslogd. By "reliable", we mean support for reliable transmission modes like TCP or RFC 3195 (syslog-reliable). We do NOT imply that the sysklogd package is unreliable.
  
  The name "rsyslog" stems back to the @@ -26,7 +26,7 @@ Instead, it contained enhanced configurability and other enhancements 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 there we were, with -a rsyslod that covers a lot of enhancements, but not a single one +a rsyslogd 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"). @@ -72,14 +72,14 @@ very busy time with many great additions.
  In July 2007, 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...
  Also in July 2007 (and beginning of -August), Rainer remodled the output part of rsyslog. It got a clean object model +August), Rainer remodeled 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.
  In August 2007 -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 +community involvement grew more and more. Also, more packages appeared. We were +quite happy about that. To facilitate user contributions, we set up a wiki 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, +2.0.0 release. With its appearance, the pace of changes was deliberately reduced, in order to allow it to mature (see Rainers's blog post on this topic, written a bit early, but covering the essence).
  Be sure to visit Rainer's syslog block @@ -91,4 +91,4 @@ Don't be shy to post to either the blog or the
- the rsyslog change log
- \ No newline at end of file + diff --git a/doc/how2help.html b/doc/how2help.html index 5c612e1f..0caa5a3a 100644 --- a/doc/how2help.html +++ b/doc/how2help.html @@ -7,8 +7,8 @@
You like rsyslog and would like to lend us a helping hand? This page tells you how easy it is to help a little bit. You can contribute to the project even with a single mouse click! If you could pick a single item from the -whishlist, that would be awfully helpful!
-
This is our whishlist:
+wish list, that would be awfully helpful!
+
This is our wish list:
- let others know how great rsyslog is
  - rate us at freshmeat.net @@ -21,7 +21,7 @@ whishlist, that would be awfully helpful!
  - let us know about rsyslog - we are eager for feedback
    - tell us what you like and what you not like - so that we can include that into development
    - tell us what you use rsyslog for - esepcially if you have high +
    - tell us what you use rsyslog for - especially if you have high traffic volume or an otherwise "uncommon" deployment. We are looking for case studies and experience how rsyslog performs in unusual scenarios.
    - allow us to post your thoughts and experiences as a "user story" on @@ -31,7 +31,7 @@ whishlist, that would be awfully helpful!
    - if you know how to create packages (rpm, deb, ...)
      - we would very much appreciate your help with package creation. We know that it is important to have good binary packages for a product to - spread widely. Yet, we do not have the knowledge to do it all ourselfs. + spread widely. Yet, we do not have the knowledge to do it all ourselves. Drop Rainer a note if you could help us out.
      @@ -56,4 +56,4 @@ whishlist, that would be awfully helpful!
      might do!
      - \ No newline at end of file + diff --git a/doc/install.html b/doc/install.html index fb9e8933..bee136ce 100644 --- a/doc/install.html +++ b/doc/install.html @@ -48,7 +48,7 @@ seconds. If an error message comes up, most probably a part of your build environment is not installed. Check with step 1 in those cases.
      
      Step 4 - Install
      
      Again, that is quite easy. All it takes is a "make install". That will copy -the rsyslogd and the man pages to the relavant directories.
      +the rsyslogd and the man pages to the relevant directories.
      
      Step 5 - Configure rsyslogd
      
      In this step, you tell rsyslogd what to do with received messages. If you are upgrading from stock syslogd, /etc/syslog.conf is probably a good starting @@ -65,7 +65,7 @@ you need to disable the stock syslogd. To do this, you typically must change your rc.d startup scripts.
      
      For example, under Debian this must be done as follows: The default runlevel is 2. We modify the init scripts for -runlevel 2 - in parctice, you need to do this for all run levels you will ever +runlevel 2 - in practice, you need to do this for all run levels you will ever use (which probably means all). Under /etc/rc2.d there is a S10sysklogd script (actually a symlink). Change the name to _S10sysklogd (this keeps the symlink in place, but will prevent further execution - effectively disabling it).
      @@ -106,8 +106,8 @@ that), you need to make sure that klogd is restarted after rsyslogd is restarted So it might be a good idea to put a klogd reload-or-restart command right after the rsyslogd command in your daily script. This can save you lots of troubles.
      
      Done
      -
      This concludes the steps neccesary to install rsyslogd. Of course, it is -always a good idea to test everything thouroughly. At a minimalist level, you +
      This concludes the steps necessary to install rsyslogd. Of course, it is +always a good idea to test everything thoroughly. At a minimalist level, you should do a reboot and after that check if everything has come up correctly. Pay attention not only to running processes, but also check if the log files (or the database) are correctly being populated.
      @@ -153,4 +153,4 @@ comments or bug sighting reports are very welcome. Please http://www.gnu.org/copyleft/fdl.html.
      - \ No newline at end of file + diff --git a/doc/ipv6.html b/doc/ipv6.html index f5a049c5..67c8e1fc 100644 --- a/doc/ipv6.html +++ b/doc/ipv6.html @@ -12,7 +12,7 @@ your way somewhat easier.
      
      First of all, you can restrict rsyslog to using IPv4 or IPv6 addresses only by specifying the -4 or -6 command line option (now guess which one does what...). If you do not provide any command line option, rsyslog uses IPv4 and -IPv6 adresses concurrently. In practice, that means the listener binds to both +IPv6 addresses concurrently. In practice, that means the listener binds to both addresses (provided they are configured). When sending syslog messages, rsyslog uses IPv4 addresses when the receiver can be reached via IPv4 and IPv6 addresses if it can be reached via IPv6. If it can be reached on either IPv4 and v6, @@ -20,10 +20,10 @@ rsyslog leaves the choice to the socket layer. The important point to know is that it uses whatever connectivity is available to reach the destination.
      
      There is one subtle difference between UDP and TCP. With the new IPv4/v6 ignorant code, rsyslog has potentially different ways to reach -destinations. The socket layer returns all of these pathes in a sorted array. +destinations. The socket layer returns all of these paths in a sorted array. For TCP, rsyslog loops through this array until a successful TCP connect can be made. If that happens, the other addresses are ignored and messages are sent via -the succesfully-connected socket.
      +the successfully-connected socket.
      
      For UDP, there is no such definite success indicator. Sure, the socket layer may detect some errors, but it may not notice other errors (due to the unreliable nature of UDP). By default, the UDP sender also tries one entry after diff --git a/doc/man_rsyslogd.html b/doc/man_rsyslogd.html index fab309db..d18fd88a 100644 --- a/doc/man_rsyslogd.html +++ b/doc/man_rsyslogd.html @@ -35,7 +35,7 @@ RSYSLOGD(8) Linux System Administration RSYSLOGD(8) insure that rsyslogd follows its default, standard BSD behavior. Of course, some configuration file changes are necessary in order to sup- port the template system. However, rsyslogd should be able to use a - standard syslog.conf and act like the orginal syslogd. However, an + standard syslog.conf and act like the original syslogd. However, an original syslogd will not work correctly with a rsyslog-enhanced con- figuration file. At best, it will generate funny looking file names. The second important concept to note is that this version of rsyslogd @@ -56,11 +56,11 @@ RSYSLOGD(8) Linux System Administration RSYSLOGD(8) OPTIONS - -A When sending UDP messages, there are potentially multiple pathes + -A When sending UDP messages, there are potentially multiple paths to the target destination. By default, rsyslogd only sends to the first target it can successfully send to. If -A is given, messages are sent to all targets. This may improve reliability, - but may also cause message duplicaton. This option should + but may also cause message duplication. This option should enabled only if it is fully understood. -4 Causes rsyslogd to listen to IPv4 addresses only. If neither -4 @@ -352,7 +352,7 @@ RSYSLOGD(8) Linux System Administration RSYSLOGD(8) replayed. As the messages are transmitted in clear-text, an attacker might use the information obtained from the packets for malicious things. Also, an attacker might reply recorded messages or spoof a - senderâ€™s IP address, which could lead to a wrong preception of system + senderâ€™s IP address, which could lead to a wrong perception of system activity. Be sure to think about syslog network security before enabling it. @@ -406,7 +406,7 @@ RSYSLOGD(8) Linux System Administration RSYSLOGD(8) BUGS Please review the file BUGS for up-to-date information on known bugs - and annouyances. + and annoyances. Further Information Please visit http://www.rsyslog.com/doc for additional information, diff --git a/doc/modules.html b/doc/modules.html index df2d4409..92887508 100644 --- a/doc/modules.html +++ b/doc/modules.html @@ -23,7 +23,7 @@ However, this goal is not yet reached and all modules must be statically linked.
      Module "generation"
      
      There is a lot of plumbing that is always the same in all modules. For example, the interface definitions, answering function pointer queries and such. -To get rid of these laborous things, I generate most of them automatically from +To get rid of these laborious things, I generate most of them automatically from a single file. This file is named module-template.h. It also contains the current best description of the interface "specification".
      
      One thing that can also be achieved with it is the capability to cope with a @@ -32,7 +32,7 @@ Currently, it is far from being finished. As I moved the monolithic code to modules, I needed (and still need) to make many "non-clean" code hacks, just to get it working. These things are now gradually being removed. However, this requires frequent changes to the interfaces, as things move in and out while -working torwards a clean interface. All the interim is necessary to reach the +working towards a clean interface. All the interim is necessary to reach the goal. This volatility of specifications is the number one reasons I currently advise against implementing your own modules (hint: if you do, be sure to use module-template.h and be prepared to fix newly appearing and disappearing data @@ -40,7 +40,7 @@ elements).
      
      Naming Conventions
      
      Source
      
      Output modules, and only output modules, should start with a file name of -"om" (e.g. "omfile.c", "omshell.c"). Similarily, input modules will use "im" and +"om" (e.g. "omfile.c", "omshell.c"). Similarly, input modules will use "im" and filter modules "fm". The third character shall not be a hyphen.
      
      Module Security
      
      Modules are directly loaded into rsyslog's address space. As such, any module @@ -51,19 +51,19 @@ security is to run only code that you know you can trust.
      
      To minimize the security risks associated with modules, rsyslog provides only the most minimalistic access to data structures to its modules. For that reason, the output modules do not receive any direct pointers to the selector_t -structure, the syslogd action structurs and - most importantly - the msg +structure, the syslogd action structures and - most importantly - the msg structure itself. Access to these structures would enable modules to access data that is none of their business, creating a potential security weakness.
      
      Not having access to these structures also simplifies further queueing and error handling cases. As we do not need to provide e.g. full access to the msg object itself, we do not need to serialize and cache it. Instead, strings needed by the module are created by syslogd and then the final result is provided to -the module. That, for example, means that in a queueed case $NOW is the actual +the module. That, for example, means that in a queued case $NOW is the actual timestamp of when the message was processed, which may be even days before it being dequeued. Think about it: If we wouldn't cache the resulting string, $NOW -would be the actual date if the action were suspened and messages queued for +would be the actual date if the action were suspended and messages queued for some time. That could potentially result in big confusion.
      -
      It is thought that if an output modlue actually needs access to the while msg +
      It is thought that if an output module actually needs access to the while msg object, we will (then) introduce a way to serialize it (e.g. to XML) in the property replacer. Then, the output module can work with this serialized object. The key point is that output modules never deal directly with msg objects (and @@ -92,4 +92,4 @@ no Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be viewed at http://www.gnu.org/copyleft/fdl.html.
      - \ No newline at end of file + diff --git a/doc/rsconf1_allowedsender.html b/doc/rsconf1_allowedsender.html index 619b71e4..4a980b89 100644 --- a/doc/rsconf1_allowedsender.html +++ b/doc/rsconf1_allowedsender.html @@ -13,7 +13,7 @@
      "$AllowedSender" is the directive - it must be written exactly as shown and the $ must start at the first column of the line. "" is either "UDP" or "TCP". It must immediately be followed by the comma, else you will receive an error message. "ip[/bits]" is a machine or network ip address as in "192.0.2.0/24" or "127.0.0.1". If the "/bits" part is omitted, a single host is assumed (32 bits or mask 255.255.255.255). "/0" is not allowed, because that would match any sending system. If you intend to do that, just remove all $AllowedSender directives. If more than 32 bits are requested with IPv4, they are adjusted to 32. For IPv6, the limit is 128 for obvious reasons. Hostnames, with and without wildcards, may also be provided. If so, the result of revers DNS resolution is used for filtering. Multiple allowed senders can be specified in a comma-delimited list. Also, multiple $AllowedSender lines can be given. They are all combined into one UDP and one TCP list. Performance-wise, it is good to specify those allowed senders with high traffic volume before those with lower volume. As soon as a match is found, no further evaluation is necessary and so you can save CPU cycles.
      
      Rsyslogd handles allowed sender detection very early in the code, nearly as the first action after receiving a message. This keeps the access to potential vulnerable code in rsyslog at a minimum. However, it is still a good idea to impose allowed sender limitations via firewalling.
      
      WARNING: by UDP design, rsyslogd can not identify a spoofed sender address in UDP syslog packets. As such, a malicious person could spoof the address of an allowed sender, send such packets to rsyslogd and rsyslogd would accept them as being from the faked sender. To prevent this, use syslog via TCP exclusively. If you need to use UDP-based syslog, make sure that you do proper egress and ingress filtering at the firewall and router level.
      -
      Rsyslog also detects some kind of malicious reverse DNS entries. In any case, using DNS names adds an extra layer of vulnerability. We recommend to stick with hard-coded IP addresses whereever possible.
      +
      Rsyslog also detects some kind of malicious reverse DNS entries. In any case, using DNS names adds an extra layer of vulnerability. We recommend to stick with hard-coded IP addresses wherever possible.
      
      Sample:
      
      $AllowedSender UDP, 127.0.0.1, 192.0.2.0/24, [::1]/128, *.example.net, somehost.example.com
      @@ -25,4 +25,4 @@ Copyright © 2007 by Rainer Gerhard Adiscon. Released under the GNU GPL version 2 or higher.
      - \ No newline at end of file + diff --git a/doc/rsconf1_controlcharacterescapeprefix.html b/doc/rsconf1_controlcharacterescapeprefix.html index 23bf5c61..6dab1e2e 100644 --- a/doc/rsconf1_controlcharacterescapeprefix.html +++ b/doc/rsconf1_controlcharacterescapeprefix.html @@ -8,7 +8,7 @@
      Default: \
      
      Description:
      
      This option specifies the prefix character to be used for control character escaping (see option $EscapeControlCharactersOnReceive). By default, it is '\', which is backwards-compatible with sysklogd. Change it to '#' in order to be compliant to the value that is somewhat suggested by Internet-Draft syslog-protocol.
      -
      IMPORTANT: do not use the ' character. This is reserved and will most probably be used in the future as a character delimiter. For the same reason, the syntax of this directive will probably change in furture releases.
      +
      IMPORTANT: do not use the ' character. This is reserved and will most probably be used in the future as a character delimiter. For the same reason, the syntax of this directive will probably change in future releases.
      
      Sample:
      
      $EscapeControlCharactersOnReceive # # as of syslog-protocol
      @@ -20,4 +20,4 @@ Copyright © 2007 by Rainer Gerhard Adiscon. Released under the GNU GPL version 2 or higher.
      - \ No newline at end of file + diff --git a/doc/rsconf1_droptrailinglfonreception.html b/doc/rsconf1_droptrailinglfonreception.html index e0054ccd..1e3aa8af 100644 --- a/doc/rsconf1_droptrailinglfonreception.html +++ b/doc/rsconf1_droptrailinglfonreception.html @@ -7,7 +7,7 @@
      Type: global configuration directive
      
      Default: on
      
      Description:
      -
      Syslog messages frequently have the line feed character (LF) as the last character of the message. In allmost all cases, this LF should not really become part of the message. However, recent IETF syslog standardization recommends against modifying syslog messages (e.g. to keep digital signatures valid). This option allows to specify if trailing LFs should be dropped or not. The default is to drop them, which is consistent with what sysklogd does.
      +
      Syslog messages frequently have the line feed character (LF) as the last character of the message. In almost all cases, this LF should not really become part of the message. However, recent IETF syslog standardization recommends against modifying syslog messages (e.g. to keep digital signatures valid). This option allows to specify if trailing LFs should be dropped or not. The default is to drop them, which is consistent with what sysklogd does.
      
      Sample:
      
      $DropTrailingLFOnRecption on
      @@ -19,4 +19,4 @@ Copyright © 2007 by Rainer Gerhard Adiscon. Released under the GNU GPL version 2 or higher.
      - \ No newline at end of file + diff --git a/doc/rsconf1_escapecontrolcharactersonreceive.html b/doc/rsconf1_escapecontrolcharactersonreceive.html index f273b85a..a8855119 100644 --- a/doc/rsconf1_escapecontrolcharactersonreceive.html +++ b/doc/rsconf1_escapecontrolcharactersonreceive.html @@ -7,7 +7,7 @@
      Type: global configuration directive
      
      Default: on
      
      Description:
      -
      This directive instructs rsyslogd to replace control characters during reception of the message. The intent is to provide a way to stop non-printable messages from entering the syslog system as whole. If this option is truned on, all control-characters are converted to a 3-digit octal number and be prefixed with the $ControlCharacterEscapePrefix character (being '\' by default). For example, if the BEL character (ctrl-g) is included in the message, it would be converted to "\007". To be compatible to sysklogd, this option must be turned on.
      +
      This directive instructs rsyslogd to replace control characters during reception of the message. The intent is to provide a way to stop non-printable messages from entering the syslog system as whole. If this option is turned on, all control-characters are converted to a 3-digit octal number and be prefixed with the $ControlCharacterEscapePrefix character (being '\' by default). For example, if the BEL character (ctrl-g) is included in the message, it would be converted to "\007". To be compatible to sysklogd, this option must be turned on.
      
      Warning:
      - turning on this option most probably destroys non-western character sets @@ -26,4 +26,4 @@ Copyright © 2007 by Rainer Gerhard Adiscon. Released under the GNU GPL version 2 or higher.
        - \ No newline at end of file + diff --git a/doc/rsconf1_filecreatemode.html b/doc/rsconf1_filecreatemode.html index b6498cd7..7c6f1713 100644 --- a/doc/rsconf1_filecreatemode.html +++ b/doc/rsconf1_filecreatemode.html @@ -14,7 +14,7 @@
        $FileCreateMode 0600
        
        This sample lets rsyslog create files with read and write access only for the users it runs under.
        
        The following sample is deemed to be a complete rsyslog.conf: -
        $umask 0000 # make sure nothing interfers with the following +
        $umask 0000 # make sure nothing interferes with the following definitions *.* /var/log/file-with-0644-default $FileCreateMode 0600 @@ -32,4 +32,4 @@ Copyright © 2007 by Rainer Gerhard Adiscon. Released under the GNU GPL version 2 or higher.
        - \ No newline at end of file + diff --git a/doc/rsconf1_mainmsgqueuesize.html b/doc/rsconf1_mainmsgqueuesize.html index b9501e09..acf88e94 100644 --- a/doc/rsconf1_mainmsgqueuesize.html +++ b/doc/rsconf1_mainmsgqueuesize.html @@ -7,9 +7,9 @@ Type: global configuration directive Default: 10000 Description: -This allows to specify the maximum size of the message queue. This directive is only available when rsyslogd has been compiled with multithreading support. In this mode, receiver and output modules are de-coupled via an in-memory queue. This queue buffers messages when the output modules are not capable to process them as fast as they are received. Once the queue size is exhausted, messages will be dropped. The slower the output (e.g. MySQL), the larger the queue should be. Buffer space for the actual queue entries is allocated on an as-needed basis. Please keep in mind that a very large queue may exhaust available system memory and swap space. Keep this in mind when configuring the max size. The actual size of a message depends largely on its content and the orginator. As a rule of thumb, typically messages should not take up more then roughtly 1k (this is the memory structure, not what you see in a network dump!). For typical linux messages, 512 bytes should be a good bet. Please also note that there is a minimal amout of memory taken for each queue entry, no matter if it is used or not. This is one pointer value, so on 32bit systems, it should typically be 4 bytes and on 64bit systems it should typically be 8 bytes. For example, the default queue size of 10,000 entries needs roughly 40k fixed overhead on a 32 bit system. +This allows to specify the maximum size of the message queue. This directive is only available when rsyslogd has been compiled with multithreading support. In this mode, receiver and output modules are de-coupled via an in-memory queue. This queue buffers messages when the output modules are not capable to process them as fast as they are received. Once the queue size is exhausted, messages will be dropped. The slower the output (e.g. MySQL), the larger the queue should be. Buffer space for the actual queue entries is allocated on an as-needed basis. Please keep in mind that a very large queue may exhaust available system memory and swap space. Keep this in mind when configuring the max size. The actual size of a message depends largely on its content and the originator. As a rule of thumb, typically messages should not take up more then roughly 1k (this is the memory structure, not what you see in a network dump!). For typical linux messages, 512 bytes should be a good bet. Please also note that there is a minimal amount of memory taken for each queue entry, no matter if it is used or not. This is one pointer value, so on 32bit systems, it should typically be 4 bytes and on 64bit systems it should typically be 8 bytes. For example, the default queue size of 10,000 entries needs roughly 40k fixed overhead on a 32 bit system. Sample: -$MainMsgQueueSize 100000 # 100,000 may be a value to handle bursty traffic +$MainMsgQueueSize 100000 # 100,000 may be a value to handle burst traffic [rsyslog.conf overview] [manual index] [rsyslog site] @@ -19,4 +19,4 @@ Copyright © 2007 by Rainer Gerhard Adiscon. Released under the GNU GPL version 2 or higher. - \ No newline at end of file + diff --git a/doc/rsconf1_moddir.html b/doc/rsconf1_moddir.html index 36f6701e..ced07dc9 100644 --- a/doc/rsconf1_moddir.html +++ b/doc/rsconf1_moddir.html @@ -10,7 +10,7 @@ Description: Provides the default directory in which loadable modules reside. This may be used to specify an alternate location that is not based on the system default. -If the system default is used, there is no need to specify this directive. Plese +If the system default is used, there is no need to specify this directive. Please note that it is vitally important to end the path name with a slash, else module loads will fail. Sample: diff --git a/doc/rsconf1_modload.html b/doc/rsconf1_modload.html index 397e6757..c9b42941 100644 --- a/doc/rsconf1_modload.html +++ b/doc/rsconf1_modload.html @@ -12,7 +12,7 @@ The plug-in must obey the rsyslog module API. Currently, only MySQL is available as a plugin, but others may create their own. A plug-in must be loaded BEFORE any configuration file lines that reference it. Modules must be present in the system default destination for rsyslog -modules. You can also set the direcotry via the +modules. You can also set the directory via the $ModDir directive. If a full path name is specified, the module is loaded from that path. The default module directory is ignored in that case. @@ -28,4 +28,4 @@ Copyright © 2007 by Rainer Gerhard Adiscon. Released under the GNU GPL version 2 or higher. - \ No newline at end of file + diff --git a/doc/rsyslog_conf.html b/doc/rsyslog_conf.html index 06e0efbe..266a6dcb 100644 --- a/doc/rsyslog_conf.html +++ b/doc/rsyslog_conf.html @@ -117,7 +117,7 @@ the wrong one, you are still vulnerable to sql injection. Please note that the database writer *checks* that the sql option is present in the template. If it is not present, the write database action is disabled. This -is to guard you against accidential forgetting it and then becoming vulnerable +is to guard you against accidental forgetting it and then becoming vulnerable to SQL injection. The sql option can also be useful with files - especially if you want to import them into a database on another machine for performance reasons. However, do NOT use it if you do not have a real need for it - among @@ -157,7 +157,7 @@ this is the "file" part of selector lines (and this is why we are not output channel syntax will stay after the next review). There is a difference, though: selector channels both have filter conditions (currently facility and severity) as well as the output destination. Output channels define -the output defintion, only. As of this build, they can only be used to write to +the output definition, only. As of this build, they can only be used to write to files - not pipes, ttys or whatever else. If we stick with output channels, this will change over time. In concept, an output channel includes everything needed to know about an @@ -189,7 +189,7 @@ line includes the channel name plus an $ sign in front of it. A sample might be: *.* $mychannel In its current form, output channels primarily provide the ability to size-limit -an output file. To do so, specify a maximum size. When this size is reachead, +an output file. To do so, specify a maximum size. When this size is reached, rsyslogd will execute the action-on-max-size command and then reopen the file and retry. The command should be something like a log rotation script or a similar thing. @@ -234,13 +234,13 @@ in BSD syslogd is not supported by rsyslogd. By default, no hostname or program is set. Selectors Selectors are the traditional way of filtering syslog messages. They -have been kept in rsyslog with their orginal syntax, because it is well-known, +have been kept in rsyslog with their original syntax, because it is well-known, highly effective and also needed for compatibility with stock syslogd configuration files. If you just need to filter based on priority and facility, you should do this with selector lines. They are not second-class -citicens in rsyslog and offer the best performance for this job. +citizens in rsyslog and offer the best performance for this job. The selector field itself again consists of two parts, a facility and a -priority, separated by a period (``.''). Both parts are case insenstive and can +priority, separated by a period (``.''). Both parts are case insensitive and can also be specified as decimal numbers, but don't do that, you have been warned. Both facilities and priorities are described in rsyslog(3). The names mentioned below correspond to the similar LOG_-values in /usr/include/rsyslog.h. The facility is one of the following keywords: auth, authpriv, cron, daemon, @@ -302,7 +302,7 @@ brief, the syntax is as follows: isequal Compares the "value" string provided and the property contents. These two values must be exactly equal to match. The difference to - contains is that contains searchs for the value anywhere inside the + contains is that contains searches for the value anywhere inside the property value, whereas all characters must be identical for isequal. As such, isequal is most useful for fields like syslogtag or FROMHOST, where you probably know the exact contents. @@ -386,7 +386,7 @@ filters. An example would be *.=crit rger & root & /var/log/critmsgs -These three lines send critical messages to the usrs rger and root and also + These three lines send critical messages to the user rger and root and also store them in /var/log/critmsgs. Using multiple actions per selector is convenient and also offers a performance benefit. As the filter needs to be evaluated only once, there is less computation required to process the @@ -477,10 +477,10 @@ separated by commas. The following options are right now defined: make an awful lot of sense. There is hardly a difference between level 1 and 9 for typical syslog messages. You can expect a compression gain between 0% and 30% for typical messages. Very chatty messages may - compress up to 50%, but this is seldomly seen with typicaly traffic. + compress up to 50%, but this is seldom seen with typically traffic. Please note that rsyslogd checks the compression gain. Messages with 60 bytes or less will never be compressed. This is because compression gain - is pretty unlikely and we prefer to save CPU cycles. Messags over that + is pretty unlikely and we prefer to save CPU cycles. Messages over that size are always compressed. However, it is checked if there is a gain in compression and only if there is, the compressed message is transmitted. Otherwise, the uncompressed messages is transmitted. This saves the @@ -510,7 +510,7 @@ separated by commas. The following options are right now defined: primary reason for that is that it seems technically impossible to provide compatibility between some of those changes. So you should take this note very serious. It is not something we do not *like* to do (and - may change our mind if enough pepole beg...), it is something we most + may change our mind if enough people beg...), it is something we most probably *can not* do for technical reasons (aka: you can beg as much as you like, it won't change anything...). The most important implication is that compressed syslog messages via @@ -591,7 +591,7 @@ discarded. No further processing of it occurs. Discard has primarily been added to filter out messages before carrying on any further processing. For obvious reasons, the results of "discard" are depending on where in the configuration file it is being used. Please note that once a message has been discarded there -is no way to retrive it in later configuration file lines. +is no way to retrieve it in later configuration file lines. Discard can be highly effective if you want to filter out some annoying messages that otherwise would fill your log files. To do that, place the discard actions early in your log files. This often plays well with property-based @@ -649,7 +649,7 @@ self-explanatory. If not, please see www.monitorware.com/rsyslog/ for advise.Please note that the samples are split across multiple lines. A template MUST NOT actually be split across multiple lines. -A template that resambles traditional syslogd file output: +A template that resembles traditional syslogd file output: $template TraditionalFormat,"%timegenerated% %HOSTNAME% %syslogtag%%msg:::drop-last-lf%\n" diff --git a/doc/rsyslog_recording_pri.html b/doc/rsyslog_recording_pri.html index c84d47fa..48852ca2 100644 --- a/doc/rsyslog_recording_pri.html +++ b/doc/rsyslog_recording_pri.html @@ -18,7 +18,7 @@ written to a log file. facility indicates where the message originated from (e.g. kernel, mail subsystem) while the severity provides a glimpse of how important the message might be (e.g. error or informational). Be careful with these values: they are -in no way consistent accross applications (especially severity). However, they +in no way consistent across applications (especially severity). However, they still form the basis of most filtering in syslog.conf. For example, the directive (aka "selector line) @@ -131,4 +131,4 @@ no Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be viewed at http://www.gnu.org/copyleft/fdl.html. - \ No newline at end of file + diff --git a/doc/status.html b/doc/status.html index fe563859..99c552a4 100644 --- a/doc/status.html +++ b/doc/status.html @@ -19,7 +19,7 @@ security advisory). Thankfully, a number of folks have begin to build packages and help port rsyslog to other platforms. As such, the platform list is now -maintened inside the rsyslog wiki. Platform maintainers perhaps have posted +maintained inside the rsyslog wiki. Platform maintainers perhaps have posted extra information there. If you do platform-specific work, feel free to add information to the wiki. Additional information diff --git a/doc/syslog-protocol.html b/doc/syslog-protocol.html index 5305d812..72de5c27 100644 --- a/doc/syslog-protocol.html +++ b/doc/syslog-protocol.html @@ -14,7 +14,7 @@ highly volatile. It may change from release to release. So while it provides some advantages in the real world, users are cautioned against using it right now. If you do, be prepared that you will probably need to update all of your rsyslogds with each new release. If you try it anyhow, please provide feedback -as that would be most benefitial for us. +as that would be most beneficial for us. Currently supported message format Due to recent discussion on syslog-protocol, we do not follow any specific revision of the draft but rather the candidate ideas. The format supported @@ -59,12 +59,12 @@ SP MSG as is and stuffed it into the MSG part. Please note that I think this will be a route that other implementors would take, too.
      - A minimal parser is easy to implement. It took me roughly 2 hours to add - it to rsyslogd. This includes the time for restructering the code to be able + it to rsyslogd. This includes the time for restructuring the code to be able to parse both legacy syslog as well as syslog-protocol. The parser has some restrictions, though
        STRUCTURED-DATA field is extracted, but not validated. Structured data "[test ]]" is not caught as an error. Nor are any other errors caught. For - my needs with this syslogd, that level of structued data processing is + my needs with this syslogd, that level of structured data processing is probably sufficient. I do not want to parse/validate it in all cases. This is also a performance issue. I think other implementors could have the same view. As such, we should not make validation a requirement. @@ -89,7 +89,7 @@ SP MSG
        we could do against this. This questions the usefulness of the TRUNCATE bit. Eventually, I could look at the UDP headers and see that it is a fragment. I have looked at a network sniffer log of the conversation. This looks like - two totally-independant messages were sent by the sender stack. + two totally-independent messages were sent by the sender stack.
        The maximum message size is currently being configured via a preprocessor #define. It can easily be set to 2K or 4K, but more than 4K is not possible because of UDP stack limitations. Eventually, this can be @@ -116,7 +116,7 @@ SP MSG
        midnight in the old year. I think this is acceptable. However, I can not assign a high-precision timestamp, at least it is somewhat off if I take the timestamp from message reception on the local socket. An alternative might - be to ígnore the timestamp present and instead use that one when the message + be to ignore the timestamp present and instead use that one when the message is pulled from the local socket (I am talking about IPC, not the network - just a reminder...). This is doable, but eventually not advisable. It looks like this needs to be resolved via a configuration option.
        @@ -174,7 +174,7 @@ SP MSG
        
        These are my personal conclusions and suggestions. Obviously, they must be discussed ;)
        
        -
        NUL should be disallowd in MSG
        +
        NUL should be disallowed in MSG
        
        As it is not possible to definitely know the character encoding of the application-provided message, MSG should not be specified to use UTF-8 exclusively. Instead, it is suggested that any encoding may be used but diff --git a/doc/version_naming.html b/doc/version_naming.html index 31fe056e..a685f5ff 100644 --- a/doc/version_naming.html +++ b/doc/version_naming.html @@ -5,7 +5,7 @@
        Version Naming
        
        This document briefly outlines the strategy for naming versions. It applies -to versions 1.0.0 and above. Versions below that are all instable and have a +to versions 1.0.0 and above. Versions below that are all unstable and have a different naming schema.
        
        Please note that version naming is currently being changed. There is a blog @@ -14,20 +14,20 @@ post about future rsyslog versions.
        been added. This is expected to happen quite infrequently.
        
        The minor version number is incremented whenever there is "sufficient need" (at the discretion of the developers). There is a notable difference between -stable and instable branches. The stable branch always has a minor +stable and unstable branches. The stable branch always has a minor version number in the range from 0 to 9. It is expected that the stable branch will receive bug and security fixes only. So the range of minor version numbers should be quite sufficient.
        -
        For the instable branch, minor version numbers always start at 10 and +
        For the unstable branch, minor version numbers always start at 10 and are incremented as needed (again, at the discretion of the developers). Here, new minor versions include both fixes as well as new features (hopefully most of the time). They are expected to be released quite often.
        
        The patch level (third number) is incremented whenever a really minor thing must be added to an existing version. This is expected to happen quite infrequently.
        -
        In general, the instable branch carries all new development. Once it +
        In general, the unstable branch carries all new development. Once it concludes with a sufficiently-enhanced, quite stable version, a new major stable version is assigned.
        - \ No newline at end of file + -- cgit

forwarding remotely received messages

EQUALLY-NAMED TEMPLATES

Step 4 - Install

Step 5 - Configure rsyslogd

Done

Module "generation"

Naming Conventions

Source

Module Security

Selectors

Additional information

Currently supported message format

Version Naming