- fixed typos, corrected small text issues, and adjusted minor wording in messageparser.rst and multi_ruleset.rst.
- removing second 'be' & changing the verb form from activate to activates.
Only updates to documentation files (.rst, .md, .txt) for minor fixes. No source code or runtime behavior is affected.
Work towards full completion of the module’s interface as it exits PoC.
The new name senderid (formerly: template) matches intent (identify a
sender, not an output format) and avoids confusion. Also make state
persistence safer via atomic writes.
Merged a bit pre-completion in order to get a static analyzer fix
into the main code base. Some additional cleanup PR will follow.
State is much cleaner now than in PoC.
Impact: Configs must use senderid=; statefile is now required. Tests
and docs updated.
Before/After: action(... template="name") -> action(... senderid="name").
Technical details:
- Replace the config parameter and instance field; drop legacy template
parsing in parseSelectorAct. The module now reads only senderid=.
- Enforce required statefile (descriptor + runtime) and cache a temp
path "<statefile>.tmp" to ensure rename() is atomic. Provide a
one-time fallback build if the cache is missing (e.g., reload flow).
- Add built-in template "StdOmSenderTrack-senderid" yielding
"%fromhost-ip%" and use it as the default senderid template.
- Improve memory ownership (free cached temp path/default template) and
keep existing locking/queue semantics unchanged.
- Update tests to use senderid= and prune PoC doc note accordingly.
see also: https://github.com/rsyslog/rsyslog/issues/5599
Split monolithic templates doc into hub and ten reference pages.
Normalize parameter casing to lowerCamelCase and modernize cross references.
Add summary include blocks and table navigation.
AI-Agent: ChatGPT
Make omprog docs easier to navigate and link while improving structure
for AI tooling and programmatic ingestion. This aids both humans and
assistants in finding a single parameter quickly with stable anchors.
BEFORE: All action parameters lived inline in modules/omprog.rst.
AFTER: Each parameter has its own reference page; omprog.rst shows a
list-table with concise summaries and a hidden toctree.
Technically, move each action parameter into
doc/source/reference/parameters/omprog-*.rst with stable anchors
(param-omprog-* and omprog.parameter.action.*), a summary block,
metadata (type/default/introduced), usage snippets, and legacy
directive mappings. The module page now pulls per-parameter summaries
via include directives and adds a hidden toctree for discovery.
Cross-references were aligned, legacy names preserved (e.g.
$ActionOMProgBinary), and a non-normative note recommends camelCase
for readability. No runtime or API/ABI changes; documentation only.
With help from AI coding Agents: codex, Gemini
see also: https://github.com/rsyslog/rsyslog/issues/5933
This turns the AI-First vision from words into verifiable practice.
It documents how we apply AI responsibly and shows the checks that
protect users, contributors, and releases.
Before: high-level narrative with few proofs.
After: structured principles plus Golden Path, Guardrails, Safeguards,
and CI gates users can verify.
The page is renamed to "AI-First (Human-Controlled)" and reorganized
with Sphinx anchors, index terms, and meta fields for better retrieval.
It adds Golden Path guidance (low-friction, good-default workflows) and
explicit Guardrails (style, structure, commit/PR templates, provenance).
It then lists concrete Safeguards that actually gate PRs and releases:
multi-distro builds, sanitizers, distcheck, coverage, CodeQL, and
selective workflows, including file paths to GitHub Actions. Buildbot
is noted for extended checks. A "Visible Artifacts" section shows how
contributors can observe the process (assistants, reviewer bot, docs
metadata). Roles, operational rules, and a change log round out the
page. No runtime or ABI changes.
This update aims to improve trust and maintainability by making the
responsible AI approach inspectable and reproducible across time.
replace outdated container docs with descriptions of user-focused images and development/CI containers; update install instructions to point to new content.
AI-Agent: ChatGPT
Add html_baseurl to Sphinx config; set to
'https://www.rsyslog.com/doc/'.
Sphinx will add a canonical link per page, reducing duplicate
content in search and consolidating ranking.
The URL matches the production docs root (trailing slash kept). No
behavior change for local/offline builds.
These cause mayor confusion for rsyslog users. Ensure they know
the need to go to the source.
This is probabaly only an interim solution until we have found
better ways to address the core issue.
- omkafka.rst: add “Set SASL password from an environment variable”
section with two paths:
* v8.2508.0+: inline `${VAR}` with adjacency via backticks
(`echo sasl.password=${KAFKA_PASSWORD}`)
* pre-8.2508.0: pre-compose `SASL_PWDPARAM` and echo that
- Clarify security notes (env files, /proc visibility) and add anchor
label :ref:`omkafka-sasl-password-from-env`
- constant_strings.rst: restructure and expand
* document `${VAR}` support, unbraced `$VAR` termination rules, and
adjacency to static text (v8.2508.0)
* keep scope explicit: only `echo`/`cat`, no `$(...)`
* add clear examples and use `rsyslog` lexer for code blocks
* add compatibility guidance for older versions
* add note: backticks can toggle boolean flags such as `config.enabled`
- Motivation: addresses confusion seen in omkafka SASL cases (e.g. #5827)
No behavioral changes to code; documentation only.
- remove duplicate case-insensitivity note\n- clarify AddtlFrameDelimiter description\n- document module+input scope and usage for flowControl, keepAlive, and related parameters\n\nAI-Agent: ChatGPT
This implements brace-style env vars inside backticks with `echo` and
fixes termination of unbraced `$VAR`. Most importantly, variables can
now be adjacent to static text (e.g., `foo${ENV}bar`), which previously
did not work and caused confusion. This aligns behavior with common
bash expectations.
Why
- Users expect `${VAR}` and `$VAR!` to expand while keeping punctuation.
- Concatenations like `foo${ENV}bar` are common and should be valid.
What
- Add support for braced variables `${VAR}` with proper `}` handling.
- For unbraced `$VAR`, stop the name at the first non `[A-Za-z0-9_]`
char and emit that char (e.g., `!`, `.`) as literal output.
- Improve error handling for overlong env var names.
- Keep other shell features (e.g., `$(pwd)`) unsupported by design.
Docs
- Update `constant_strings.rst` to document `${VAR}`, the new
termination rules, and examples including `foo${ENV}bar` and `$VAR!`.
Tests
- Add `rscript_backticks_braces_envvar.sh` for `${VAR}` support.
- Add `rscript_backticks_static_text.sh` for `$VAR!` and adjacency.
- Convert `rscript_backticks_empty_envvar-vg.sh` to non-VG variant and
adjust `tests/Makefile.am`.
Compatibility
- Backward compatible. Changes affect only previously broken edge cases.
Misc
- Refresh lexer copyright years.
Explain that TTL settings only affect reverse lookups for inbound messages. Forward lookups for outbound connections rely on the system resolver and are not cached. Remove ChangeLog entry per project policy.
AI-Agent: ChatGPT
Add "Concurrency & Locking" to dev_action_threads.rst:
multiple workers per action; WID is per-worker; shared pData must be
mutex/rwlock-protected; direct mode still needs module-side serialization
for inherently serial resources.
Introduce a new developer-oriented documentation page:
File: doc/source/development/dev_action_threads.rst
Content:
- End-to-end overview of the rsyslog queue engine (producers → rulesets → actions)
- Terminology
- Mermaid flowchart for thread and queue topology
- State diagram for watermarks/backpressure
- Sequence diagram for action-queue lifecycle
- Error handling (retry/suspend) and shutdown behavior
- Queue types and selection guidance
- Key queue parameters and cross-references
Motivation:
Provide a single, high-signal reference for contributors to understand the queue engine and action worker model, with visualizations to aid comprehension.
Update dev_queue.rst with note about outdated content and reference to dev_action_threads
Co-authored-by: alorbach <alorbach@adiscon.com>
Refactored omelasticsearch.rst by moving each parameter description
into its own file under doc/source/reference/parameters/, one per
parameter. Each new page contains:
- Standardized metadata (Name, Scope, Type, Default, Required?, Introduced)
- Concise summary block for inclusion in the overview table
- Verified and clarified type information
- Usage examples for module/action contexts
- Legacy or alternate name mappings where applicable
Updated omelasticsearch.rst to present a list-table with :ref: links
and inline summaries for all parameters, plus a hidden toctree linking
to the new reference pages.
This change brings omelasticsearch documentation in line with the
structured parameter format adopted for other modules, improving
maintainability, readability, and navigation for both human users and
AI systems.
No functional changes; documentation only.
Refactored pmrfc3164.rst to move individual parameter descriptions into
dedicated files under doc/source/reference/parameters/, one per parameter.
Each new page contains:
- Consistent metadata (Name, Scope, Type, Default, Required?, Introduced)
- Concise summary blocks for inclusion in overview tables
- Corrected and clarified type info (boolean/string)
- Usage examples for parser configuration
- Legacy/alternate name mappings
pmrfc3164.rst now presents parameters via a list-table with :ref: links
and inline summaries, plus a hidden toctree for the new reference pages.
This brings pmrfc3164 documentation in line with the structured parameter
format used in other modules, improving maintainability, readability,
and navigation.
No functional changes; documentation only.
Refactored imjournal.rst to move detailed parameter descriptions into
individual files under doc/source/reference/parameters/, one file per
parameter. Each page now includes:
- Consistent metadata (Name, Scope, Type, Default, Required?, Introduced)
- Concise summary blocks for list-table inclusion
- Updated and clarified type information (boolean/string/integer)
- Corrected legacy/obsolete name mappings
- Usage examples for module and input scopes
imjournal.rst now uses list-tables with :ref: links to these pages and
includes summaries inline for quick scanning. This aligns imjournal’s
documentation structure with other modules, improves maintainability,
and enhances reusability for AI-assisted and human navigation.
No code changes; documentation only.
With support from AI agents: Codex, Gemini
