Skip to content

docs: pipeline: outputs: syslog: remove unreleased framing and sd preset docs - #2728

Merged
eschabell merged 1 commit into
fluent:masterfrom
eschabell:erics_out_syslog_sd_auth_cleanup
Sep 24, 2026
Merged

eschabell merged 1 commit into
fluent:masterfrom
eschabell:erics_out_syslog_sd_auth_cleanup

Conversation

@eschabell

@eschabell eschabell commented Sep 23, 2026 •

Copy link
Copy Markdown
Collaborator
- Remove the syslog_framing row from the configuration parameters
  table and delete the Message framing section.
- Remove the syslog_sd_preset row from the configuration parameters
  table and delete the Structured data preset section.
- Restore the Add structured data authentication token section, minus
  its cross-reference to the now-absent preset section. The Lua filter
  is the only approach available in released versions.

Neither syslog_framing nor syslog_sd_preset is present in v5.1.2 or
earlier; both landed on fluent-bit master after that tag. Re-add both,
and drop the Lua authentication token example, in the release that
carries them.

Refs #2727

Signed-off-by: Eric D. Schabell eric@schabell.org

Summary by CodeRabbit

  • Documentation
    • Removed documentation for Syslog message framing and structured data preset options, including their configuration details and validation behavior.

…set docs

    - Remove the syslog_framing row from the configuration parameters
      table and delete the Message framing section.
    - Remove the syslog_sd_preset row from the configuration parameters
      table and delete the Structured data preset section.
    - Restore the Add structured data authentication token section, minus
      its cross-reference to the now-absent preset section. The Lua filter
      is the only approach available in released versions.

  Neither syslog_framing nor syslog_sd_preset is present in v5.1.2 or
  earlier; both landed on fluent-bit master after that tag. Re-add both,
  and drop the Lua authentication token example, in the release that
  carries them.

  Refs fluent#2727

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell
eschabell requested review from a team and patrick-stephens as code owners September 23, 2026 06:58
@coderabbitai

coderabbitai Bot commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 04cb599e-bf40-416a-a78a-0b2b30283357

📥 Commits

Reviewing files that changed from the base of the PR and between 886153e and 709e2f8.

📒 Files selected for processing (1)
  • pipeline/outputs/syslog.md
💤 Files with no reviewable changes (1)
  • pipeline/outputs/syslog.md

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

The Syslog output documentation removes the syslog_framing and syslog_sd_preset configuration descriptions and related sections. The structured data authentication token section remains, without its cross-reference to the removed preset section.

Changes

Syslog output documentation

Layer / File(s) Summary
Remove framing and preset documentation
pipeline/outputs/syslog.md
The configuration table and explanatory sections no longer describe message framing or structured data presets. The authentication token section no longer links to the removed preset section.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 709e2

No issue requiring a fix before merge is established by the supplied context.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the removal of unreleased Syslog framing and structured data preset documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@eschabell

Copy link
Copy Markdown
Collaborator Author

@sigJoe please review this PR.

@sigJoe

sigJoe commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

@eschabell LGTM, but I'm not a maintainer and cannot formally review or approve. I'm just a user with emotional investment in this particular feature

@eschabell
eschabell merged commit 4eb96ee into fluent:master Sep 24, 2026
8 checks passed
@eschabell
eschabell deleted the erics_out_syslog_sd_auth_cleanup branch September 24, 2026 10:25
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Sep 24, 2026
eschabell added a commit that referenced this pull request Sep 26, 2026
…age (#2729)

- Remove the Syslog output octet counting framing entry. PR #2728
    removed syslog_framing from pipeline/outputs/syslog.md as unreleased,
    leaving this entry pointing at a parameter no page documents.
  - Gate the GCS total_file_size upload trigger as v5.1.3 and greater.
    The GCS output ships in v5.1, but the size trigger is not in v5.1.2.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants