From 34d051c27a0e92535c9d0dad6705ecd8bf5355f8 Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Wed, 6 Nov 2013 11:46:38 +0100 Subject: doc: add v8 compatibility document --- doc/Makefile.am | 5 +++-- doc/manual.html | 20 +++++++++++--------- doc/v8compatibility.html | 39 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 53 insertions(+), 11 deletions(-) create mode 100644 doc/v8compatibility.html diff --git a/doc/Makefile.am b/doc/Makefile.am index 867a63b7..f7a9efe0 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -121,6 +121,9 @@ html_files = \ v3compatibility.html \ v4compatibility.html \ v5compatibility.html \ + v6compatibility.html \ + v7compatibility.html \ + v8compatibility.html \ im3195.html \ netstream.html \ ns_gtls.html \ @@ -157,8 +160,6 @@ html_files = \ rsconf1_omfileforcechown.html \ rsyslog_queue_pointers.jpeg \ rsyslog_queue_pointers2.jpeg \ - v6compatibility.html \ - v7compatibility.html \ rsyslog_conf_basic_structure.html \ rsyslog_conf_sysklogd_compatibility.html \ imkmsg.html \ diff --git a/doc/manual.html b/doc/manual.html index 3e3625d9..7ca40491 100644 --- a/doc/manual.html +++ b/doc/manual.html @@ -27,16 +27,18 @@ 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.

-

If you are upgrading from rsyslog v2 or stock sysklogd, -be sure to read the rsyslog v3 compatibility notes, -and if you are upgrading from v3, read the -rsyslog v4 compatibility notes, -if you upgrade from v4, read the -rsyslog v5 compatibility notes, and -if you upgrade from v5, read the -rsyslog v6 compatibility notes. +If you upgrade from v7, read the +rsyslog v8 compatibility notes. if you upgrade from v6, read the rsyslog v7 compatibility notes. +if you upgrade from v5, read the +rsyslog v6 compatibility notes. +if you upgrade from v4, read the +rsyslog v5 compatibility notes. +if you upgrade from v3, read the +rsyslog v4 compatibility notes. +

If you are upgrading from rsyslog v2 or stock sysklogd, +be sure to read the rsyslog v3 compatibility notes,

Rsyslog will work even if you do not read the doc, but doing so will definitely improve your experience.

Follow the links below for the

@@ -44,7 +46,7 @@ if you do not read the doc, but doing so will definitely improve your experience
  • troubleshooting rsyslog problems
  • configuration file format (rsyslog.conf)
  • a regular expression checker/generator tool for rsyslog
    • -
  • property replacer, an important core component
    • +
  • property replacer, an important core component
  • rsyslog bug list
  • understanding rsyslog message parsers
  • backgrounder on generic syslog application design
    • diff --git a/doc/v8compatibility.html b/doc/v8compatibility.html new file mode 100644 index 00000000..aedc755f --- /dev/null +++ b/doc/v8compatibility.html @@ -0,0 +1,39 @@ + +Compatibility notes for rsyslog v8 + + +

    Compatibility Notes for rsyslog v8

    +This document describes things to keep in mind when moving from v7 to v8. 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 v7 and want to use v8 without hassle. +

    Version 8 offers a completely rewritten core rsyslog engine. This resulted in +a number of changes that are visible to users and (plugin) developers. +Most importantly, pre-v8 plugins do not longer work and need to +be updated to support the new calling interfaces. If you developed a plugin, +be sure to review the developer section below. +

    +

    What Developers need to Know

    +

    output plugin interface

    +

    To support the new core engine, the output interface has been considerably +changed. It is suggested to review some of the project-provided plugins for +full details. In this doc, we describe the most important changes from a high +level perspective. +

    RS_RET_SUSPENDED is no longer supported when creating an action instance +

    This means a plugin must not try to establish any connections or the like +before any of its processing entry points (like beginTransaction or doAction) +is called. This was generally also the case von v7, but was not enforced in +all cases. In v8, creating action creation fails if anything but RS_RET_OK +is returned. + + +rsyslog BSD blocks info +page for more information and how to upgrade your config. +

    [manual index] [rsyslog site]

    + +

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

    + -- cgit v1.2.3