File: //usr/share/doc/rsyslog/html/index.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to Rsyslog — rsyslog 8.2006.0 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/rsyslog.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '8.2006.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation" href="installation/index.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="installation/index.html" title="Installation"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">rsyslog 8.2006.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="welcome-to-rsyslog">
<h1>Welcome to Rsyslog<a class="headerlink" href="#welcome-to-rsyslog" title="Permalink to this headline">¶</a></h1>
<p><a class="reference external" href="http://www.rsyslog.com/">Rsyslog</a> is a <strong>r</strong>ocket-fast <strong>sys</strong>tem for <strong>log</strong> processing.
It offers high-performance, great security features and a modular design.
While it started as a regular syslogd, rsyslog has evolved into a kind of
<strong>swiss army knife of logging</strong>, being able to</p>
<ul class="simple">
<li>accept inputs from a wide variety of sources,</li>
<li>transform them,</li>
<li>and output the results to diverse destinations.</li>
</ul>
<p>Rsyslog has a strong enterprise focus but also scales down to small
systems.
It supports, among others, <a class="reference internal" href="tutorials/database.html"><span class="doc">MySQL</span></a>,
<a class="reference internal" href="tutorials/database.html"><span class="doc">PostgreSQL</span></a>,
<a class="reference internal" href="tutorials/failover_syslog_server.html"><span class="doc">failover log destinations</span></a>,
ElasticSearch, syslog/tcp transport, fine grain output format control,
high precision timestamps,
queued operations and the ability to filter on any message part.</p>
<div class="section" id="manual">
<h2>Manual<a class="headerlink" href="#manual" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation/packages.html">Installing rsyslog from Package</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation/rsyslog_docker.html">Using Rsyslog Docker Containers</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation/install_from_source.html">Installing rsyslog from Source</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation/build_from_repo.html">Installing rsyslog from the source repository</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/index.html">Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/conf_formats.html">Configuration Formats</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/converting_to_new_format.html">Converting older formats to <code class="docutils literal"><span class="pre">advanced</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/sysklogd_format.html">sysklogd format</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/basic_structure.html">Basic Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/templates.html">Templates</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/properties.html">rsyslog Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/property_replacer.html">The Property Replacer</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/filters.html">Filter Conditions</a></li>
<li class="toctree-l2"><a class="reference internal" href="rainerscript/index.html">RainerScript</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/actions.html">Actions</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/input.html">Input</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/parser.html">Parser</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/timezone.html">timezone</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/examples.html">Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/index_directives.html">Legacy Configuration Directives</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/rsyslog_statistic_counter.html">rsyslog statistic counter</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/modules/index.html">Modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/output_channels.html">Output Channels</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/droppriv.html">Dropping privileges in rsyslog</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/ipv6.html">Notes on IPv6 Handling in Rsyslog</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/cryprov_gcry.html">libgcrypt Log Crypto Provider (gcry)</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/dyn_stats.html">Dynamic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/lookup_tables.html">Lookup Tables</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="containers/index.html">rsyslog and containers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="containers/container_features.html">Container-Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="containers/docker_specifics.html">docker specifics</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting/index.html">Troubleshooting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="troubleshooting/index.html#typical-problems">Typical Problems</a></li>
<li class="toctree-l2"><a class="reference internal" href="troubleshooting/index.html#general-procedure">General Procedure</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq/index.html">FAQ</a><ul>
<li class="toctree-l2"><a class="reference internal" href="faq/difference_queues.html">What is the difference between the main_queue and a queue with a ruleset tied to an input?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="concepts/index.html">Concepts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="concepts/queues.html">Understanding rsyslog Queues</a></li>
<li class="toctree-l2"><a class="reference internal" href="concepts/janitor.html">The Janitor Process</a></li>
<li class="toctree-l2"><a class="reference internal" href="concepts/messageparser.html">Message parsers in rsyslog</a></li>
<li class="toctree-l2"><a class="reference internal" href="concepts/multi_ruleset.html">Multiple Rulesets in rsyslog</a></li>
<li class="toctree-l2"><a class="reference internal" href="concepts/netstrm_drvr.html">NetStream Drivers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples/index.html">Example Use Cases</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/high_performance.html">Receiving massive amounts of messages with high performance</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/index.html">Tutorials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials/tls_cert_summary.html">Encrypting Syslog Traffic with TLS (SSL)</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/tls.html">Encrypting Syslog Traffic with TLS (SSL) [short version]</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/database.html">Writing syslog messages to MySQL, PostgreSQL or any other supported Database</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/high_database_rate.html">Handling a massive syslog database insert rate with Rsyslog</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/reliable_forwarding.html">Reliable Forwarding of syslog Messages with Rsyslog</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/recording_pri.html">Recording the Priority of Syslog Messages</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/failover_syslog_server.html">Failover Syslog Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/log_rotation_fix_size.html">Log rotation with rsyslog</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/gelf_forwarding.html">GELF forwarding in rsyslog</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/log_sampling.html">Log Sampling</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/random_sampling.html">Random sampling</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/hash_sampling.html">Hash-based Sampling</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="development/index.html">Development</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development/config_data_model.html">The rsyslog config data model</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/config_data_model.html#objects">Objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/debugging.html">Debugging</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/dev_codestyle.html">rsyslog code style</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/dev_oplugins.html">Writing Rsyslog Output Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/dev_queue.html">The rsyslog queue object</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/dev_testbench.html">writing rsyslog tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/generic_design.html">Generic design of a syslogd</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="historical/index.html">Historical Documents</a><ul>
<li class="toctree-l2"><a class="reference internal" href="historical/php_syslog_ng.html">Using php-syslog-ng with rsyslog</a></li>
<li class="toctree-l2"><a class="reference internal" href="historical/stunnel.html">SSL Encrypting Syslog with Stunnel</a></li>
<li class="toctree-l2"><a class="reference internal" href="historical/multi_ruleset_legacy_format_samples.html">Legacy Format Samples for Multiple Rulesets</a></li>
<li class="toctree-l2"><a class="reference internal" href="historical/module_devel.html">Developing rsyslog modules (outdated)</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="reference">
<h2>Reference<a class="headerlink" href="#reference" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="history.html">RSyslog - History</a></li>
<li class="toctree-l1"><a class="reference internal" href="licensing.html">Licensing</a></li>
<li class="toctree-l1"><a class="reference internal" href="how2help.html">How you can Help</a></li>
<li class="toctree-l1"><a class="reference internal" href="community.html">Community Resources</a></li>
<li class="toctree-l1"><a class="reference internal" href="features.html">RSyslog - Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="proposals/index.html">Proposals</a></li>
<li class="toctree-l1"><a class="reference internal" href="whitepapers/index.html">Rsyslog Whitepapers</a></li>
<li class="toctree-l1"><a class="reference internal" href="free_support.html">Free Services for Rsyslog</a></li>
<li class="toctree-l1"><a class="reference internal" href="compatibility/index.html">Compatibility</a></li>
</ul>
</div>
</div>
<div class="section" id="sponsors-and-community">
<h2>Sponsors and Community<a class="headerlink" href="#sponsors-and-community" title="Permalink to this headline">¶</a></h2>
<p>Please visit the rsyslog <a class="reference external" href="http://www.rsyslog.com/sponsors">Sponsor’s Page</a> to honor the project sponsors or
become one yourself! We are very grateful for any help towards the project
goals.</p>
<p>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
<a class="reference internal" href="how2help.html"><span class="doc">How you can Help</span></a>.</p>
</div>
<div class="section" id="contributing-to-the-docs">
<h2>Contributing to the docs<a class="headerlink" href="#contributing-to-the-docs" title="Permalink to this headline">¶</a></h2>
<p>This documentation is hosted on <a class="reference external" href="https://github.com/rsyslog/rsyslog-doc">github</a>. If you find something to be
improved, please feel free to fork and file a patch request with your
improvements. There is also a Button ‘Edit in GitHub’ on every documentation
page beginning with the main <a class="reference external" href="https://www.rsyslog.com/doc/v8-stable/">docs page</a> that allows easy access.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p>Help with configuring/using <code class="docutils literal"><span class="pre">Rsyslog</span></code>:</p>
<ul class="last simple">
<li><a class="reference external" href="http://lists.adiscon.net/mailman/listinfo/rsyslog">Mailing list</a> - best route for general questions</li>
<li>GitHub: <a class="reference external" href="https://github.com/rsyslog/rsyslog/">rsyslog source project</a> - detailed questions, reporting issues
that are believed to be bugs with <code class="docutils literal"><span class="pre">Rsyslog</span></code></li>
<li>Stack Exchange (<a class="reference external" href="https://stackexchange.com/filters/327462/rsyslog">View</a>, <a class="reference external" href="https://serverfault.com/questions/ask?tags=rsyslog">Ask</a>)
- experimental support from rsyslog community</li>
</ul>
</div>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p>Contributing to <code class="docutils literal"><span class="pre">Rsyslog</span></code>:</p>
<ul class="last simple">
<li>Source project: <a class="reference external" href="https://github.com/rsyslog/rsyslog/blob/master/README.md">rsyslog project README</a>.</li>
<li>Documentation: <a class="reference external" href="https://github.com/rsyslog/rsyslog-doc/blob/master/README.md">rsyslog-doc project README</a></li>
</ul>
</div>
<p>Copyright 2008-2020 <a class="reference external" href="https://rainer.gerhards.net/">Rainer Gerhards</a>
(<a class="reference external" href="https://www.rainer-gerhards.de/grossrinderfeld/">Großrinderfeld</a>),
and Others.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to Rsyslog</a><ul>
<li><a class="reference internal" href="#manual">Manual</a></li>
<li><a class="reference internal" href="#reference">Reference</a></li>
<li><a class="reference internal" href="#sponsors-and-community">Sponsors and Community</a></li>
<li><a class="reference internal" href="#contributing-to-the-docs">Contributing to the docs</a></li>
</ul>
</li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="installation/index.html"
title="next chapter">Installation</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.rst.txt"
rel="nofollow">Show Source</a></li>
<li><a href="https://github.com/rsyslog/rsyslog-doc/edit/master/source/index.rst"
rel="nofollow">Edit on GitHub</a></li>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="installation/index.html" title="Installation"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">rsyslog 8.2006.0 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
</div>
</body>
</html>