Development

• System Architecture
  • Architectural Patterns
    • Microkernel (Core vs. Plugins)
  • Data Flow Pipeline
  • Component Map
  • The Object System
  • See Also
• rsyslog coding practices reference
  • Purpose and scope
  • Placement and navigation
  • Referencing from sibling libraries
  • Entry format
  • Organizing topics
  • Contribution workflow
  • Practice catalog
    • Pattern: document contracts for externalized helpers
      • Assert + safe fallback (defensive design-by-contract)
    • Antipattern: undocumented IPv4-in-IPv6 tail helper
    • Error Logging with errno
    • Defensive Coding and Assertions
  • AI agent integration
  • Discoverability and expected pickup
  • Adaptation for sibling libraries
• The rsyslog config data model
• Objects
  • Variables/Properties
  • Flat Elements
    • Global Parameters
    • Modules
    • Inputs
    • Rulesets
  • Hierarchical Elements
    • Execution Statements
    • Expression Evaluation
    • Control-of-Flow Statements
  • Note on Queue Objects
• Debugging
  • Debugging with tests
  • Memory debugging
    • Valgrind
    • Address sanitizer
• Action Threads and Queue Engine (Developer-Oriented)
  • Overview
  • Terminology
  • Thread and Queue Topology
  • Concurrency & Locking
  • Message Processing Lifecycle (Action Queue)
  • Backpressure and Flow Control
  • Error Handling, Retry, Suspend
  • Queue Types and Selection
  • Key Parameters (see ../rainerscript/queue_parameters)
  • Sequence and Error Paths
  • Developer Notes
  • Cross-References
• rsyslog code style
• Writing Rsyslog Output Plugins
  • Getting Started and Samples
  • Special Topics
    • Threading
    • Getting Message Data
    • Batching of Messages
    • Output Plugin Transaction Interface
  • Open Issues
    • Licensing
• The rsyslog queue object
  • Some definitions
  • Implementation Details
    • Disk-Assisted Mode
    • DA Run Mode Initialization
    • DA Run Mode Shutdown
    • Queue Destruction
• writing rsyslog tests
• Documentation Reference Section Structure Guidelines
  • Overview
  • Directory Layout
  • Module Page (<module>.rst)
  • Parameter Files (reference/parameters/<module>-<param>.rst)
  • Anchors & Cross-References
  • Rules for Examples
  • Validation
  • TOC Integration
• Documentation Style Guide
  • General Principles
  • File Structure and TOC
  • Headings
  • Text Formatting
  • Cross-Referencing
  • Sections
  • Legacy Content
  • Licensing & Legal
  • Examples and Code
  • Maintenance
  • Metadata and JSON-LD
• Developer Overview: rsyslog Engine
  • Overview
  • Key Components
  • Queue Types
  • Concurrency Model
  • Concurrency Handling in Detail
  • Queue Flow (Mermaid Diagram)
  • Backpressure & Flow Control
  • Error Handling
  • Cross-References
• Generic design of a syslogd
• Internal tooling

---

Support: rsyslog Assistant | GitHub Discussions | GitHub Issues: rsyslog source project

Contributing: Source & docs: rsyslog source project

© 2008–2026 Rainer Gerhards and others. Licensed under the Apache License 2.0.