Skip to content

docs: outputs: flowcounter: general doc updates and cleanup#2432

Merged
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_out_flowcounter_updates
Mar 17, 2026
Merged

docs: outputs: flowcounter: general doc updates and cleanup#2432
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_out_flowcounter_updates

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Mar 17, 2026

  • Lowercase Key column entries
  • Add missing event_based parameter
  • Sort config param table alphabetically
  • Remove redundant intro sentence
  • Add missing period to unit description

Applies to #2412

Summary by CodeRabbit

  • Documentation
    • Updated flowcounter configuration parameters: standardized Unit and Workers to lowercase (unit, workers) and introduced a new event_based parameter to enable time bucketing using event timestamps.

  - Lowercase Key column entries
  - Add missing event_based parameter
  - Sort config param table alphabetically
  - Remove redundant intro sentence
  - Add missing period to unit description

  Applies to fluent#2412

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Mar 17, 2026
@eschabell eschabell requested a review from a team as a code owner March 17, 2026 08:51
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0 labels Mar 17, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 17, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 84eee254-4083-4b94-959a-fc1ef3bf4687

📥 Commits

Reviewing files that changed from the base of the PR and between 9691fb1 and f88467b.

📒 Files selected for processing (1)
  • pipeline/outputs/flowcounter.md

📝 Walkthrough

Walkthrough

This PR updates the flowcounter output plugin documentation by renaming configuration parameters from CamelCase (Unit, Workers) to lowercase variants (unit, workers) and introduces a new event_based parameter enabling time bucketing based on event timestamps.

Changes

Cohort / File(s) Summary
Flowcounter Output Plugin Configuration
pipeline/outputs/flowcounter.md
Renamed configuration keys to lowercase (Unit → unit, Workers → workers), added new event_based parameter for event timestamp-based time bucketing, and updated parameter descriptions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 Lowercase letters hop with grace,
Configuration finds its rightful place,
Workers and units, now so neat,
Event timestamps make the flow complete!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: outputs: flowcounter: general doc updates and cleanup' accurately describes the main changes—documentation updates to the flowcounter output configuration, including parameter updates and formatting improvements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

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 and usage tips.

@eschabell
Copy link
Collaborator Author

@coderabbitai review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 17, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@eschabell
Copy link
Collaborator Author

@cosmo0920 and @patrick-stephens ready for review!

@eschabell eschabell merged commit d8946ad into fluent:master Mar 17, 2026
8 checks passed
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Mar 18, 2026
@eschabell eschabell deleted the erics_out_flowcounter_updates branch March 18, 2026 13:10
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.

2 participants