From 0754bda285f17e6fb750ce6dea1db788e9e0ccde Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Mon, 18 Feb 2008 10:52:02 +0000 Subject: documented at least a bit about the debug settings --- doc/debug.html | 39 +++++++++++++++++ doc/manual.html | 133 ++++++++++++++++++++++++++++++++++++++++---------------- 2 files changed, 134 insertions(+), 38 deletions(-) create mode 100644 doc/debug.html (limited to 'doc') diff --git a/doc/debug.html b/doc/debug.html new file mode 100644 index 00000000..ad53d94f --- /dev/null +++ b/doc/debug.html @@ -0,0 +1,39 @@ + + +Debug Support + + + +

Debug Support

+

+Rsyslog provides a number of debug aids. Some of them are activated by +adding the --enable-rtinst ./configure option ("rtinst" means runtime +instrumentation). Turning debugging on obviously costs some performance +(in some cases considerable). +

+

This is document is just being created and thus terse.

+

Signals supported

+

SIGUSR1 - turns debug messages on and off (expect this signal +to go away over time)

+

SIGUSR2 - outputs debug information (including active threads +and a call stack) for the state when SIGUSR2 was received. This is a +one-time output. Can be sent as often as the user likes.

+

Environment Variables

+

Environment variables set several debug settings. This is +intended to become the primary way to configure debugging support. +Currently are defined:

+ +

[manual index] [rsyslog site]

+

This documentation is part of the +rsyslog +project.
+Copyright © 2008 by Rainer +Gerhards and +Adiscon. +Released under the GNU GPL version 3 or higher.

+ \ No newline at end of file diff --git a/doc/manual.html b/doc/manual.html index 9b99c9b5..f73ae83a 100644 --- a/doc/manual.html +++ b/doc/manual.html @@ -1,52 +1,109 @@ - - -rsyslog documentation + +rsyslog documentation +

RSyslog - Documentation

-

Rsyslog is an enhanced syslogd -supporting, among others, MySQL, PostgreSQL, failover log destinations, syslog/tcp, -fine grain output format control, and the ability to filter on any message part. -It is quite compatible to stock -sysklogd and can be used as a drop-in replacement. Its -advanced features make it suitable for enterprise-class, -encryption protected syslog -relay chains while at the same time being very easy to setup -for the novice user.

-

Visit the rsyslog status page to obtain current -version information and ports. If you like rsyslog, you might want to lend us -a helping hand. It doesn't require a lot of time - even a single mouse click -helps. Learn how to help the rsyslog project. Due to popular demand, there is now a side-by-side comparison between rsyslog and syslog-ng.

Warning: rsyslog v3 is under active development and as of this writing has a number of backwards compatibility issues. If you have never run it, be sure to read the -rsyslog v3 compatibility document! This also applies if you upgrade from stock sysklogd - you need to make some configuration file changes.
Documentation for 3.x is currently sparse. If you need assistance, please post in the rsyslog forums!
If you do not like this, use a stable branch release!

+

Rsyslog +is an enhanced syslogd +supporting, among others, MySQL, +PostgreSQL, failover +log destinations, syslog/tcp, fine grain output format +control, and the ability to filter on any message part. +It is quite compatible to stock sysklogd and can be used as a drop-in +replacement. Its +advanced features make it suitable for enterprise-class, encryption protected syslog +relay chains while at the same time being very easy to setup for the +novice user.

+

Visit the rsyslog +status page to obtain current +version information and ports. If you like rsyslog, you might +want to lend us a helping hand. It doesn't require a lot of +time - even a single mouse click helps. Learn how to help the rsyslog project. +Due to popular demand, there is now a side-by-side comparison +between rsyslog and syslog-ng.

+

Warning: rsyslog +v3 is under active development and as of this writing has a number of +backwards compatibility issues. If you currently use v2, +be +sure to read the rsyslog v3 compatibility document! +This also applies if you upgrade from stock sysklogd - you need to make +some configuration file changes.
+Documentation for 3.x is currently sparse. If you need assistance, +please post +in the rsyslog forums!
+If you do not like this, +use a stable +branch release!

Follow the links below for the

+(somewhat outdated) +
  • configuration file +syntax (rsyslog.conf)
    • +
  • property +replacer, an important core component
    • +
  • a commented sample +rsyslog.conf +
    • +
  • rsyslog bug list
    • +
  • rsyslog +packages
    • +
  • backgrounder on +generic syslog application design
    • +
  • description of rsyslog +modules
    • +

    We have some in-depth papers on

    -

    Our rsyslog history page is for you if you would like to learn a little more -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 "why the world needs another syslogd".

    -

    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 +

    Our rsyslog history +page is for you if you would like to learn a little more +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 "why +the world needs another syslogd".

    +

    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.

    You can also browse the following online resources:

    -

    And don't forget about the rsyslog mailing list. -If you are interested in the "backstage", you may find +

    And don't forget about the rsyslog +mailing list. If you are interested in the "backstage", you +may find Rainer's -blog an interesting read (filter on syslog and rsyslog tags).

    - - +blog an +interesting read (filter on syslog and rsyslog tags).

    + \ No newline at end of file -- cgit