mirror of
https://github.com/rsyslog/rsyslog.git
synced 2026-08-24 19:24:14 +02:00
8fe4a208d1
Why: Documentation examples can drift from accepted configuration syntax. The old hand-copied test approach checked fixtures instead of the rendered documentation source. Impact: Marked documentation samples are syntax-checked in docs CI and report coverage through the docs-samples Codecov flag. Before/After: Before, doc examples relied on manual review or copied tests. After, marked RST rsyslog blocks are extracted and checked by rsyslogd -C -N1. Technical Overview: Add a documentation sample validator that scans doc/source for rsyslog-doc-sample markers and validates the following rsyslog code block with the built rsyslogd. Support metadata for plugin requirements and generated prepend/append fixture lines. Wire the documentation workflow to build an instrumented rsyslogd, run the validator, generate lcov output, and upload Codecov coverage under the docs-samples flag. Register the validator and its tests in the documentation dist list. Extend local validation planning to build and run the validator when marked documentation samples are present. With the help of AI-Agents: OpenAI Codex
44 lines
730 B
ReStructuredText
44 lines
730 B
ReStructuredText
.. _prop-message-msg:
|
|
.. _properties.message.msg:
|
|
|
|
msg
|
|
===
|
|
|
|
.. index::
|
|
single: properties; msg
|
|
single: msg
|
|
|
|
.. summary-start
|
|
|
|
Returns the MSG part of the processed syslog message.
|
|
|
|
.. summary-end
|
|
|
|
This property belongs to the **Message Properties** group.
|
|
|
|
:Name: msg
|
|
:Category: Message Properties
|
|
:Type: string
|
|
|
|
Description
|
|
-----------
|
|
The MSG part of the message (aka "the message").
|
|
|
|
Usage
|
|
-----
|
|
.. _properties.message.msg-usage:
|
|
|
|
.. rsyslog-doc-sample: validate-config
|
|
|
|
.. code-block:: rsyslog
|
|
|
|
template(name="example" type="list") {
|
|
property(name="msg")
|
|
}
|
|
|
|
action(type="omfile" file="/dev/null" template="example")
|
|
|
|
See also
|
|
--------
|
|
See :doc:`../../configuration/properties` for the category overview.
|