Deployed 492fed58 to dev with MkDocs 1.6.1 and mike 2.1.3

This commit is contained in:
github-actions[bot]
2025-11-20 15:11:57 +00:00
parent a5e786edf8
commit 5faace3a69
2 changed files with 188 additions and 5 deletions
File diff suppressed because one or more lines are too long
+187 -4
View File
@@ -1266,9 +1266,64 @@
</span>
</a>
<nav class="md-nav" aria-label="Acting as a Log Server">
</li>
<li class="md-nav__item">
<a href="#advanced-filtering" class="md-nav__link">
<span class="md-ellipsis">
Advanced Filtering
</span>
</a>
<nav class="md-nav" aria-label="Advanced Filtering">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pattern-matching" class="md-nav__link">
<span class="md-ellipsis">
Pattern Matching
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#advanced-severity-comparison" class="md-nav__link">
<span class="md-ellipsis">
Advanced Severity Comparison
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hostname-filtering" class="md-nav__link">
<span class="md-ellipsis">
Hostname Filtering
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#property-based-filtering" class="md-nav__link">
<span class="md-ellipsis">
Property-Based Filtering
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#facilities" class="md-nav__link">
<span class="md-ellipsis">
@@ -1937,9 +1992,64 @@
</span>
</a>
<nav class="md-nav" aria-label="Acting as a Log Server">
</li>
<li class="md-nav__item">
<a href="#advanced-filtering" class="md-nav__link">
<span class="md-ellipsis">
Advanced Filtering
</span>
</a>
<nav class="md-nav" aria-label="Advanced Filtering">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pattern-matching" class="md-nav__link">
<span class="md-ellipsis">
Pattern Matching
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#advanced-severity-comparison" class="md-nav__link">
<span class="md-ellipsis">
Advanced Severity Comparison
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hostname-filtering" class="md-nav__link">
<span class="md-ellipsis">
Hostname Filtering
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#property-based-filtering" class="md-nav__link">
<span class="md-ellipsis">
Property-Based Filtering
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#facilities" class="md-nav__link">
<span class="md-ellipsis">
@@ -2182,8 +2292,81 @@ this to work you need a static IP address, here we use 10.0.0.1/24.</p>
<a id="__codelineno-8-6" name="__codelineno-8-6" href="#__codelineno-8-6"></a>admin@example:/&gt;
</code></pre></div>
<p>See the above <a href="#log-to-file">Log to File</a> section on how to set up
filtering of received logs to local files. Please note, filtering based
on property, e.g., hostname, is not supported yet.</p>
filtering of received logs to local files. Advanced filtering based
on hostname and message properties is also available, see the next
section for details.</p>
<h2 id="advanced-filtering">Advanced Filtering<a class="headerlink" href="#advanced-filtering" title="Permanent link"></a></h2>
<p>The syslog subsystem supports several advanced filtering options that
allow fine-grained control over which messages are logged. These can
be combined with facility and severity filters to create sophisticated
logging rules.</p>
<h3 id="pattern-matching">Pattern Matching<a class="headerlink" href="#pattern-matching" title="Permanent link"></a></h3>
<p>Messages can be filtered using regular expressions (POSIX extended regex)
on the message content. This is useful when you want to log only messages
containing specific keywords or patterns:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>admin@example:/config/&gt; edit syslog actions log-file file:errors
<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a>admin@example:/config/syslog/…/file:errors/&gt; set pattern-match "ERROR|CRITICAL|FATAL"
<a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a>admin@example:/config/syslog/…/file:errors/&gt; set facility-list all severity info
<a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a>admin@example:/config/syslog/…/file:errors/&gt; leave
<a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a>admin@example:/&gt;
</code></pre></div>
<p>This will log all messages containing ERROR, CRITICAL, or FATAL.</p>
<h3 id="advanced-severity-comparison">Advanced Severity Comparison<a class="headerlink" href="#advanced-severity-comparison" title="Permanent link"></a></h3>
<p>By default, severity filtering uses "equals-or-higher" comparison,
meaning a severity of <code>error</code> will match error, critical, alert, and
emergency messages. You can change this behavior:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>admin@example:/config/&gt; edit syslog actions log-file file:daemon-errors
<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a>admin@example:/config/syslog/…/file:daemon-errors/&gt; set facility-list daemon
<a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a>admin@example:/config/syslog/…/daemon/&gt; set severity error
<a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a>admin@example:/config/syslog/…/daemon/&gt; set advanced-compare compare equals
<a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a>admin@example:/config/syslog/…/daemon/&gt; leave
<a id="__codelineno-10-6" name="__codelineno-10-6" href="#__codelineno-10-6"></a>admin@example:/&gt;
</code></pre></div>
<p>This will log only <code>error</code> severity messages, not higher severities.</p>
<p>You can also block specific severities:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>admin@example:/config/syslog/…/daemon/&gt; set advanced-compare action block
</code></pre></div>
<p>This will exclude <code>error</code> messages from the log.</p>
<h3 id="hostname-filtering">Hostname Filtering<a class="headerlink" href="#hostname-filtering" title="Permanent link"></a></h3>
<p>When acting as a log server, you can filter messages by hostname. This
is useful for directing logs from different devices to separate files:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>admin@example:/config/&gt; edit syslog actions log-file file:router1
<a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a>admin@example:/config/syslog/…/file:router1/&gt; set hostname-filter router1
<a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a>admin@example:/config/syslog/…/file:router1/&gt; set facility-list all severity info
<a id="__codelineno-12-4" name="__codelineno-12-4" href="#__codelineno-12-4"></a>admin@example:/config/syslog/…/file:router1/&gt; leave
<a id="__codelineno-12-5" name="__codelineno-12-5" href="#__codelineno-12-5"></a>admin@example:/&gt;
</code></pre></div>
<p>Multiple hostnames can be added to the filter list.</p>
<h3 id="property-based-filtering">Property-Based Filtering<a class="headerlink" href="#property-based-filtering" title="Permanent link"></a></h3>
<p>For more advanced filtering, you can match on specific message properties
using various comparison operators:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>admin@example:/config/&gt; edit syslog actions log-file file:myapp
<a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a>admin@example:/config/syslog/…/file:myapp/&gt; edit property-filter
<a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a>admin@example:/config/syslog/…/property-filter/&gt; set property programname
<a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a>admin@example:/config/syslog/…/property-filter/&gt; set operator isequal
<a id="__codelineno-13-5" name="__codelineno-13-5" href="#__codelineno-13-5"></a>admin@example:/config/syslog/…/property-filter/&gt; set value myapp
<a id="__codelineno-13-6" name="__codelineno-13-6" href="#__codelineno-13-6"></a>admin@example:/config/syslog/…/property-filter/&gt; leave
<a id="__codelineno-13-7" name="__codelineno-13-7" href="#__codelineno-13-7"></a>admin@example:/&gt;
</code></pre></div>
<p>Available properties:
- <code>msg</code>: Message body
- <code>msgid</code>: RFC5424 message identifier
- <code>programname</code>: Program/tag name
- <code>hostname</code>: Source hostname
- <code>source</code>: Alias for hostname
- <code>data</code>: RFC5424 structured data</p>
<p>Available operators:
- <code>contains</code>: Substring match
- <code>isequal</code>: Exact equality
- <code>startswith</code>: Prefix match
- <code>regex</code>: Basic regular expression
- <code>ereregex</code>: Extended regular expression (POSIX ERE)</p>
<p>The comparison can be made case-insensitive:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>admin@example:/config/syslog/…/property-filter/&gt; set case-insensitive true
</code></pre></div>
<p>Or negated to exclude matching messages:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a>admin@example:/config/syslog/…/property-filter/&gt; set negate true
</code></pre></div>
<h3 id="facilities">Facilities<a class="headerlink" href="#facilities" title="Permanent link"></a></h3>
<table>
<thead>