rsyslog/rsyslog
1
0
Fork 0
mirror of https://github.com/rsyslog/rsyslog.git synced 2026-08-24 19:24:14 +02:00
Code Issues Packages Projects Releases Wiki Activity
rsyslog/plugins/omkafka/AGENTS.md
Rainer Gerhards 2f4ebd9a99 core: streamline agent instructions with modular skills 
Modernize the rsyslog contribution workflow for AI agents to
improve policy compliance and reduce instruction verbosity.

Impact: Repository-wide reduction in AGENTS.md bloat.

Before: Fragmented and redundant procedural instructions in AGENTS.md.
After: Modular skills in .agent/skills/ with streamlined subtree guides.

This change encapsulates build, test, documentation, module authoring,
and commit policies into reusable skills. It introduces:
- A specialized AI memory lifecycle auditor.
- A boilerplate snippets library.
- The 'rsyslog_doc_dist' skill for doc/Makefile.am synchronization.
- YAML frontmatter 'triggers' for automatic skill activation.

The workflow is further optimized to skip redundant builds after stylistc
code formatting, ensuring faster iteration for AI-led development.

AI-Agent: Antigravity 2026-01
2026-01-23 13:52:13 +01:00

904 B
Raw Blame History

AGENTS.md – omkafka output module

Workflow & Skills

AI agents working on omkafka MUST follow the standardized skills in .agent/skills/:

  • Build: Use rsyslog_build (requires --enable-omkafka).
  • Test: Use rsyslog_test.
    • Policy: Skip heavy integration tests (e.g., ./tests/omkafka.sh) in sandboxes as they require a local Kafka cluster.
  • Doc: Use rsyslog_doc.
  • Module: Use rsyslog_module and keep MODULE_METADATA.yaml current.

Module Specifics

  • Dependencies: Ships events via librdkafka.
  • Diagnostics: impstats exposes counters (submitted, failed, retry).
  • Review: Changes to shared Kafka helpers in runtime/ must be coordinated with imkafka.