Added new flow-accounting options - #2175
Conversation
- Removed the options which are not available and added new options
📝 WalkthroughSummary by CodeRabbit
WalkthroughChangesFlow-accounting documentation
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/configuration/system/flow-accounting.md`:
- Around line 114-123: Wrap the prose descriptions under the netflow
active-timeout and inactive-timeout directives so no line exceeds 80 characters,
while keeping the directive opener lines unchanged. Remove the trailing
whitespace on the affected inactive-timeout text.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Central YAML (inherited), Organization UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 6dfd4dcb-8d00-43a4-8a86-650696aa0149
📒 Files selected for processing (1)
docs/configuration/system/flow-accounting.md
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
ansible/ansible(manual)
📜 Review details
⏰ Context from checks skipped due to timeout. (2)
- GitHub Check: Mergify Merge Protections
- GitHub Check: Summary
⚠️ CI failures not shown inline (5)
GitHub Actions: AI Validation / validate: Added new flow-accounting options
Conclusion: failure
##[group]Removing auth
Removing SSH command configuration
[command]/usr/bin/git config --local --name-only --get-regexp core\.sshCommand
[command]/usr/bin/git submodule foreach --recursive sh -c "git config --local --name-only --get-regexp 'core\.sshCommand' && git config --local --unset-all 'core.sshCommand' || :"
Removing HTTP extra header
[command]/usr/bin/git config --local --name-only --get-regexp http\.https\:\/\/github\.com\/\.extraheader
[command]/usr/bin/git submodule foreach --recursive sh -c "git config --local --name-only --get-regexp 'http\.https\:\/\/github\.com\/\.extraheader' && git config --local --unset-all 'http.https://github.com/.extraheader' || :"
Removing includeIf entries pointing to credentials config files
[command]/usr/bin/git config --local --name-only --get-regexp ^includeIf\.gitdir:
includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/.vyos-1x/.git.path
includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/.vyos-1x/.git/worktrees/*.path
includeif.gitdir:/github/workspace/.vyos-1x/.git.path
includeif.gitdir:/github/workspace/.vyos-1x/.git/worktrees/*.path
[command]/usr/bin/git config --local --get-all includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/.vyos-1x/.git.path
/home/runner/work/_temp/git-credentials-9f88a6aa-5835-435f-ad57-94eaff450496.config
[command]/usr/bin/git config --local --unset includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/.vyos-1x/.git.path /home/runner/work/_temp/git-credentials-9f88a6aa-5835-435f-ad57-94eaff450496.config
[command]/usr/bin/git config --local --get-all includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/.vyos-1x/.git/worktrees/*.path
/home/runner/work/_temp/git-credentials-9f88a6aa-5835-435f-ad57-94eaff450496.config
[command]/usr/bin/git config --local --unset includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/.vyos-1x/.git/worktrees/*.path /home/runne...
GitHub Actions: AI Validation / prepare: Added new flow-accounting options
Conclusion: failure
##[group]Run set -euo pipefail
�[36;1mset -euo pipefail�[0m
�[36;1m# Fetch the base branch explicitly by refname to avoid ambiguity with�[0m
�[36;1m# same-named tags (e.g., a `rolling` tag), then diff against FETCH_HEAD.�[0m
�[36;1mgit fetch --no-tags --depth=1 origin "refs/heads/rolling"�[0m
�[36;1mBASE="FETCH_HEAD"�[0m
�[36;1m# --diff-filter=ACMRT excludes Deleted entries so the bundling�[0m
�[36;1m# loop below (`git show HEAD:<path>`) doesn't try to extract�[0m
�[36;1m# blobs for files that no longer exist in the merge ref.�[0m
�[36;1m# Deletions still appear in diff-md.patch (full diff) but not�[0m
�[36;1m# in changed-md.txt (which drives the bundling step).�[0m
�[36;1mgit diff "$BASE...HEAD" --name-only --diff-filter=ACMRT -z -- ':(glob)docs/**/*.md' > changed-md.z�[0m
�[36;1mgit diff "$BASE...HEAD" --name-only --diff-filter=ACMRT -z -- ':(glob)docs/**/*.rst' > changed-rst.z�[0m
�[36;1m# Reject paths containing line-disrupting control bytes (LF, CR,�[0m
�[36;1m# other 0x01-0x1F + 0x7F) before generating the newline-delimited�[0m
�[36;1m# *.txt manifests. NUL itself can't appear in a git pathname�[0m
�[36;1m# (it's the on-disk tree-entry terminator), so it stays out of�[0m
�[36;1m# the rejection class and remains the legitimate record delimiter�[0m
�[36;1m# for `git diff -z` — `grep -z` honors that contract.�[0m
�[36;1m#�[0m
�[36;1m# POSIX filesystems generally allow LF/CR in filenames and git�[0m
�[36;1m# stores them fine; the hazard is purely in our line-delimited�[0m
�[36;1m# downstream tooling. Without this guard, `tr '\0' '\n'` on a�[0m
�[36;1m# path like `docs/foo\nbar.md` would split it into two logical�[0m
�[36;1m# lines — downstream consumers reading line-by-line would miss�[0m
�[36;1m# validation coverage on the real file (or worse, act on a�[0m
�[36;1m# synthetic path). Fail fast at this seam.�[0m
�[36;1m#�[0m
�[36;1m# An earlier `tr -d '\0\n\r' | grep [\x00-\x1F\x7F]` form�[0m
�[36;1m# stripped the very bytes it was m...
GitHub Actions: AI Validation / validate: Added new flow-accounting options
Conclusion: failure
##[group]Run set -euo pipefail
�[36;1mset -euo pipefail�[0m
�[36;1mTARGET="rolling"�[0m
�[36;1mMAPPED=$(jq -r --arg b "$TARGET" '.[$b] // empty' reviewer/branches.json)�[0m
�[36;1mif [ -z "$MAPPED" ]; then�[0m
�[36;1m echo "::error::Docs branch '$TARGET' is not configured for AI validation. Add it to branches.json in vyos-docs-opus-reviewer (known: $(jq -c 'keys' reviewer/branches.json))."�[0m
GitHub Actions: AI Validation / 1_prepare.txt: Added new flow-accounting options
Conclusion: failure
##[group]Run set -euo pipefail
�[36;1mset -euo pipefail�[0m
�[36;1m# Fetch the base branch explicitly by refname to avoid ambiguity with�[0m
�[36;1m# same-named tags (e.g., a `rolling` tag), then diff against FETCH_HEAD.�[0m
�[36;1mgit fetch --no-tags --depth=1 origin "refs/heads/rolling"�[0m
�[36;1mBASE="FETCH_HEAD"�[0m
�[36;1m# --diff-filter=ACMRT excludes Deleted entries so the bundling�[0m
�[36;1m# loop below (`git show HEAD:<path>`) doesn't try to extract�[0m
�[36;1m# blobs for files that no longer exist in the merge ref.�[0m
�[36;1m# Deletions still appear in diff-md.patch (full diff) but not�[0m
�[36;1m# in changed-md.txt (which drives the bundling step).�[0m
�[36;1mgit diff "$BASE...HEAD" --name-only --diff-filter=ACMRT -z -- ':(glob)docs/**/*.md' > changed-md.z�[0m
�[36;1mgit diff "$BASE...HEAD" --name-only --diff-filter=ACMRT -z -- ':(glob)docs/**/*.rst' > changed-rst.z�[0m
�[36;1m# Reject paths containing line-disrupting control bytes (LF, CR,�[0m
�[36;1m# other 0x01-0x1F + 0x7F) before generating the newline-delimited�[0m
�[36;1m# *.txt manifests. NUL itself can't appear in a git pathname�[0m
�[36;1m# (it's the on-disk tree-entry terminator), so it stays out of�[0m
�[36;1m# the rejection class and remains the legitimate record delimiter�[0m
�[36;1m# for `git diff -z` — `grep -z` honors that contract.�[0m
�[36;1m#�[0m
�[36;1m# POSIX filesystems generally allow LF/CR in filenames and git�[0m
�[36;1m# stores them fine; the hazard is purely in our line-delimited�[0m
�[36;1m# downstream tooling. Without this guard, `tr '\0' '\n'` on a�[0m
�[36;1m# path like `docs/foo\nbar.md` would split it into two logical�[0m
�[36;1m# lines — downstream consumers reading line-by-line would miss�[0m
�[36;1m# validation coverage on the real file (or worse, act on a�[0m
�[36;1m# synthetic path). Fail fast at this seam.�[0m
�[36;1m#�[0m
�[36;1m# An earlier `tr -d '\0\n\r' | grep [\x00-\x1F\x7F]` form�[0m
�[36;1m# stripped the very bytes it was m...
GitHub Actions: AI Validation / 0_validate.txt: Added new flow-accounting options
Conclusion: failure
##[group]Run set -euo pipefail
�[36;1mset -euo pipefail�[0m
�[36;1mTARGET="rolling"�[0m
�[36;1mMAPPED=$(jq -r --arg b "$TARGET" '.[$b] // empty' reviewer/branches.json)�[0m
�[36;1mif [ -z "$MAPPED" ]; then�[0m
�[36;1m echo "::error::Docs branch '$TARGET' is not configured for AI validation. Add it to branches.json in vyos-docs-opus-reviewer (known: $(jq -c 'keys' reviewer/branches.json))."�[0m
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.md
📄 CodeRabbit inference engine (AGENTS.md)
docs/**/*.md: Canonical docs pages must be written as MyST Markdown (.md); edit existing pages in.mdonly and never use the oldmd-prefix for new pages.
Use{cfgcmd},{opcmd}, and{cmdincludemd}fenced directives in MyST pages for VyOS command coverage; do not replace them with plaintextorbashfences.
Use MyST ATX headings (#,##,###, etc.) in canonical pages; the RST heading hierarchy does not apply to.mdsources.
In MyST pages, prefer single backticks for inline code; double backticks are reserved for embedded RST contexts.
Use% stop_vyoslinterand% start_vyoslintercomment markers in top-level MyST content to suppress real IPs or other allowed long-line exceptions, and keep them paired.
In MyST pages, write TODO markers as{todo}fenced directives.
Files:
docs/configuration/system/flow-accounting.md
docs/{_include/*.txt,**/*.md}
📄 CodeRabbit inference engine (AGENTS.md)
Keep documentation lines within 80 characters unless the content is inside a code block or fenced/preformatted block.
Files:
docs/configuration/system/flow-accounting.md
🧠 Learnings (13)
📚 Learning: 2026-05-06T20:48:49.689Z
Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1902
File: CLAUDE.md:71-71
Timestamp: 2026-05-06T20:48:49.689Z
Learning: In vyos/vyos-documentation, the 80-character line-length rule documented under Source conventions / Formatting applies only to documentation source files located under docs/ (e.g., docs/**/*.rst and docs/**/*.md). The rule is enforced by the vyoslinter (doc-linter.py from vyos/.github) when reviewing changed files via lint-doc.yml, and only for files within docs/**. Do not suggest hard-wrapping CLAUDE.md (repo-root documentation) because GitHub renders and reflows content. For CLAUDE.md, reviews should not enforce the 80-char wrapping; apply the rule only to files matching **/docs/**/*.{rst,md}.
Applied to files:
docs/configuration/system/flow-accounting.md
📚 Learning: 2026-05-06T20:48:57.970Z
Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1902
File: CLAUDE.md:91-93
Timestamp: 2026-05-06T20:48:57.970Z
Learning: The 80-character line limit applies only to documentation sources under docs/** (RST/MD). Do not enforce this limit on repo-root Markdown files like CLAUDE.md or README.md. The vyoslinter (doc-linter.py, run via lint-doc.yml from vyos/.github) lints only changed files within docs/**; root files are excluded. GitHub renders root Markdown with viewport-width reflow, so hard-wrapping these files reduces readability without tooling benefit.
Applied to files:
docs/configuration/system/flow-accounting.md
📚 Learning: 2026-05-06T20:48:50.446Z
Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1902
File: CLAUDE.md:64-64
Timestamp: 2026-05-06T20:48:50.446Z
Learning: Enforce the 80-character line-length limit only for documentation source files under docs/ (docs/**/*.md and docs/**/*.rst rendered by Sphinx and linted by vyoslinter via lint-doc.yml). Do not flag line-length issues in repository-root Markdown files such as CLAUDE.md or README.md, which GitHub renders with viewport-width reflow. This applies to all files within docs/ that are part of the documentation source.
Applied to files:
docs/configuration/system/flow-accounting.md
📚 Learning: 2026-05-06T20:48:54.578Z
Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1902
File: CLAUDE.md:80-84
Timestamp: 2026-05-06T20:48:54.578Z
Learning: Enforce the 80-character line-length limit only for documentation source files under docs/ (docs/**/*.rst and docs/**/*.md). Do not flag repo-root files like CLAUDE.md or README.md, since they are rendered by GitHub and not subject to this rule. The doc-linter (doc-linter.py via lint-doc.yml) only lints docs/**, so CI checks won't flag root files for line length.
Applied to files:
docs/configuration/system/flow-accounting.md
📚 Learning: 2026-05-06T20:49:00.044Z
Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1902
File: CLAUDE.md:108-108
Timestamp: 2026-05-06T20:49:00.044Z
Learning: Limit the 80-character line length check and vyoslinter (doc-linter.py) enforcement to documentation source files under docs/**/*.{rst,md}. Do not apply or flag line-length issues in repo-root files like CLAUDE.md or README.md, which are rendered directly by GitHub and are not linted by lint-doc.yml. This pattern narrows checks to Sphinx source docs and prevents false positives in non-doc files.
Applied to files:
docs/configuration/system/flow-accounting.md
📚 Learning: 2026-05-06T20:48:53.302Z
Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1902
File: CLAUDE.md:79-79
Timestamp: 2026-05-06T20:48:53.302Z
Learning: Limit line length to 80 characters only for documentation sources under the docs directory (docs/**/*.rst and docs/**/*.md). This is enforced by the vyoslinter doc-linter.py (from the vyos/.github repo) via lint-doc.yml on changed files under docs/**. Do not flag line-length violations in repository-root Markdown files like CLAUDE.md or README.md, as they are rendered by GitHub and reflow in the UI.
Applied to files:
docs/configuration/system/flow-accounting.md
📚 Learning: 2026-05-06T20:49:10.359Z
Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1902
File: CLAUDE.md:142-142
Timestamp: 2026-05-06T20:49:10.359Z
Learning: In vyos/vyos-documentation, the 80-character line limit and vyoslinter enforcement apply only to documentation source files under docs/**/*.rst and docs/**/*.md that Sphinx renders. Repo-root files such as CLAUDE.md and README.md are outside the linter's scope (lint-doc.yml runs on docs/**) and are rendered by GitHub with automatic paragraph reflow — do not flag line-length violations in these files.
Applied to files:
docs/configuration/system/flow-accounting.md
📚 Learning: 2026-05-06T20:49:15.361Z
Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1902
File: CLAUDE.md:163-163
Timestamp: 2026-05-06T20:49:15.361Z
Learning: In vyos/vyos-documentation, enforce the 80-character line-length limit (Source conventions / Formatting) only for Sphinx documentation source files under docs/**/*.rst and docs/**/*.md. The lint-doc.yml workflow runs the doc-linter (doc-linter.py) and checks only docs/** changed files. Files in the repository root (e.g., CLAUDE.md, README.md) are rendered by GitHub and are not subject to this rule; do not flag line-length violations in those files.
Applied to files:
docs/configuration/system/flow-accounting.md
📚 Learning: 2026-05-08T07:01:22.978Z
Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1878
File: docs/troubleshooting/connectivity.rst:0-0
Timestamp: 2026-05-08T07:01:22.978Z
Learning: For the VyOS documentation (MyST-based docs), MyST directive opener lines must keep the entire directive arguments on a single line. This includes MyST fenced-directive openers like ```{opcmd} ... ``` and the RST-equivalent form .. opcmd:: ... when ported/used in MyST. Because the MyST parser does not support wrapped/continued directive arguments across multiple lines, do not raise/keep review warnings suggesting line wrapping for these directive opener lines due to line-length (even if they exceed 80 characters).
Applied to files:
docs/configuration/system/flow-accounting.md
📚 Learning: 2026-05-08T07:01:22.978Z
Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1878
File: docs/troubleshooting/connectivity.rst:0-0
Timestamp: 2026-05-08T07:01:22.978Z
Learning: In vyos/vyos-documentation, do not raise line-length (>80 chars) review findings for MyST directive opener lines (the directive “opener” that uses MyST directive syntax such as `{cfgcmd}` / `{opcmd}` fence/openers). CI does not enforce the 80-character limit for these specific opener lines, and existing documentation contains longer opener lines that pass lint.
Applied to files:
docs/configuration/system/flow-accounting.md
📚 Learning: 2026-05-13T22:16:06.198Z
Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 2021
File: docs/automation/terraform/terraformvyos.md:14-14
Timestamp: 2026-05-13T22:16:06.198Z
Learning: In the vyos/vyos-documentation repo, when a PR is a byte-for-byte documentation port of an existing file from the rolling branch to a release branch (e.g., circinus, sagitta), keep the port content identical to the production-tested rolling source. For these ports, do not raise new review findings for documentation issues that are already present in the rolling source (for example, markdownlint MD059 like non-descriptive link text such as `[link]`/`[install]`). Instead, defer those existing issues to a rolling-side cleanup PR (e.g., `#2024`) and then backport the cleanup via Mergify.
Applied to files:
docs/configuration/system/flow-accounting.md
📚 Learning: 2026-05-13T22:43:41.056Z
Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 2024
File: docs/automation/terraform/terraformvyos.md:0-0
Timestamp: 2026-05-13T22:43:41.056Z
Learning: In docs/**/*.md, for Markdown reference definition lines of the form `[label]: <URL>`, if the line cannot be shortened to <= 80 characters (because the URL itself is near/at the limit), suppress the vyoslinter warning by wrapping only that reference definition with a `% stop_vyoslinter` / `% start_vyoslinter` block. If the reference definition can fit within 80 characters, leave it outside any suppression block.
Applied to files:
docs/configuration/system/flow-accounting.md
📚 Learning: 2026-06-05T19:21:44.474Z
Learnt from: LiudmylaNad
Repo: vyos/vyos-documentation PR: 2066
File: docs/configuration/protocols/traffic-engineering.md:0-0
Timestamp: 2026-06-05T19:21:44.474Z
Learning: In the vyos/vyos-documentation MyST documentation pages, when writing CLI example invocations directly under a `{cfgcmd}` directive, use `none` fenced code blocks for those examples. Do not change these example blocks to `{opcmd}` or `{cfgcmd}`—`{opcmd}` is reserved for operational-mode commands, and the surrounding `{cfgcmd}` directive already documents the target command. Plain `none` blocks for these CLI examples are intentional and correct.
Applied to files:
docs/configuration/system/flow-accounting.md
🔍 Remote MCP vyos.dev
Relevant task context
-
T9122, “system flow-accounting: NetFlow export ignores the configured VRF (regression after pmacct → ipt_NETFLOW migration)” is currently inprogress. Its description says the pmacct→ipt_NETFLOW migration broke
set system flow-accounting vrf <name>behavior, and it explicitly calls out that docs should statevrfbinds NetFlow export to that VRF whilesource-interfaceoverrides the bind device and must be in the VRF. -
T9036, “ipt-NETFLOW: support VRF” says flow accounting previously supported VRF and requests restoring that support in ipt-NETFLOW.
-
The
vyatta-netflowproject is archived and described as the Vyatta configuration/operational templates and scripts for the netflow/sflow system (pmacct).
🔇 Additional comments (2)
docs/configuration/system/flow-accounting.md (2)
11-12: LGTM!Also applies to: 43-47, 71-86, 182-182
49-52: 🎯 Functional CorrectnessVerify the VRF binding contract before changing this documentation.
The available context does not establish whether
source-interfacemust belong to the configured flow-accounting VRF or howvrf <name>affects NetFlow routing. Confirm this from VyOS configuration validation before documenting export binding behavior.
| ```{cfgcmd} set system flow-accounting netflow active-timeout \<value\> | ||
|
|
||
| Specifies the interval at which Netflow data will be sent to a collector. As | ||
| per default, Netflow data will be sent every 60 seconds. | ||
| Specifies the duration, in seconds, that an active flow is maintained before it is exported. | ||
| By default, active flows are exported after 1800 seconds (30 minutes). | ||
| ``` | ||
|
|
||
| ```{cfgcmd} set system flow-accounting netflow inactive-timeout \<value\> | ||
|
|
||
| You may also additionally configure timeouts for different types of | ||
| connections. | ||
| Specifies the duration, in seconds, that an inactive flow is retained before it is exported. A flow is considered inactive if no new packets are observed for the configured interval. | ||
| By default, inactive flows are exported after 15 seconds. This parameter defaults to a value of 15. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Wrap timeout descriptions to 80 characters.
Lines 116 and 122 exceed the documentation line-length limit; line 122 also contains trailing whitespace. Keep the MyST directive openers unchanged, but wrap the prose body lines.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/configuration/system/flow-accounting.md` around lines 114 - 123, Wrap
the prose descriptions under the netflow active-timeout and inactive-timeout
directives so no line exceeds 80 characters, while keeping the directive opener
lines unchanged. Remove the trailing whitespace on the affected inactive-timeout
text.
Sources: Coding guidelines, Learnings
Change Summary
Made the changes as per the new flow-accounting implemtation
Related Task(s)
Related PR(s)
Backport
Yes, 1.5
Checklist: