Task · OPN-0048

Troubleshooting docs for the push receivers (syslog/Zenarmor/NetFlow)

Description

docs/troubleshooting.md covers only the polling collectors; an operator whose receiver gets nothing has no entry point. Add a push-receiver section pointing at logs_rejected_total{reason} / logs_shipped_total and the per-stage parse metrics, cross-linked from the three receiver pages. Also add “nothing arrives” headings to zenarmor-receiver.md and flow.md matching syslog-receiver.md’s pattern (the OPNsense-side Reporting-NetFlow step is the classic misconfiguration).

Acceptance Criteria

Definition of Done

Implementation Plan

Add receiver-first troubleshooting keyed to the actual shipped/rejected/parse metrics, add nothing-arrives sections and reciprocal links across the three receiver pages, then validate docs generation without changing generated regions by hand.

Implementation Notes

Wave 1 staged WIP adds receiver-first troubleshooting using the shipped/rejected/parse/drop metrics, nothing-arrives sections, and reciprocal receiver-page links. docs-check and integrated just check passed; post-correction L14 verified the metrics and links. Not landed because the shared code-bearing batch lacks a complete CodeRabbit review. Resume: obtain the review, commit this documentation task explicitly, integrate current origin/main, rerun just check, push, and verify exact-SHA CI.

Landed receiver-first troubleshooting, nothing-arrives sections, and reciprocal links in 3090b8cffabe39f2241fffd6340dc773277b8632. CodeRabbit was skipped because this was documentation-only.

Final Summary

Added push-receiver troubleshooting keyed to the real shipped, rejected, parse, and drop metrics. docs-check and just check passed; exact-head CI run 33583442198 succeeded at 3090b8cffabe39f2241fffd6340dc773277b8632.

View the source file on GitHub