Skip to content

docs: in_process: updates to config parameters#2330

Merged
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_in_process_updates
Jan 19, 2026
Merged

docs: in_process: updates to config parameters#2330
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_in_process_updates

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Jan 17, 2026

  • Sort configuration parameters table alphabetically
  • Change table parameter names to lowercase to match other input plugin docs

Fixes #2329

Summary by CodeRabbit

  • Documentation
    • Process input configuration keys renamed to lowercase_snake_case for consistency.
    • Configuration reference table reorganized for clearer presentation and alignment with new key names.
    • Default values and existing behavior preserved; descriptions adjusted only for naming clarity.

✏️ Tip: You can customize this high-level summary in your review settings.

@eschabell eschabell self-assigned this Jan 17, 2026
@eschabell eschabell requested review from a team as code owners January 17, 2026 17:00
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 17, 2026

📝 Walkthrough

Walkthrough

Updated the process input plugin documentation to rename configuration keys from CamelCase/mixedCase to lowercase_snake_case and reorder the table rows to match code expectations; values and descriptions remain effectively the same.

Changes

Cohort / File(s) Summary
Documentation update
pipeline/inputs/process.md
Renamed configuration keys from CamelCase/mixedCase to lowercase_snake_case (e.g., Proc_Nameproc_name, Interval_Secinterval_sec, Interval_Nsecinterval_nsec, Alertalert, Fdfd, Memmem, Threadedthreaded); reordered table rows; preserved defaults and descriptions

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested reviewers

  • cosmo0920
  • alexakreizinger

Poem

🐰
I nibbled through headers, tidy and brave,
CamelCase hopped out, snake_case I gave.
Keys all aligned in a neat little row,
Doc-burrow polished, ready to show! 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating configuration parameter documentation for the in_process input plugin, which aligns with the CamelCase to lowercase_snake_case parameter rename and reorganization.
Linked Issues check ✅ Passed The pull request fulfills all coding requirements from issue #2329: parameters are sorted alphabetically, parameter names changed to lowercase_snake_case for consistency, and Interval_NSec casing corrected in examples.
Out of Scope Changes check ✅ Passed All changes are in-scope: the modifications to pipeline/inputs/process.md consist solely of configuration parameter renaming, sorting, and case corrections as specified in issue #2329.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing touches
  • 📝 Generate docstrings

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

Requested review from one of the three of you @cosmo0920, @alexakreizinger, or @esmerel, first one wins!

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
pipeline/inputs/process.md (1)

56-63: Fix Interval_NSec casing in the classic config example.

The PR objective calls out correcting this; the example still shows Interval_NSec. If the convention is Interval_Nsec, update it here to match the rest of the docs and expected keys.

🐛 Proposed fix
-  Interval_NSec 0
+  Interval_Nsec 0
🧹 Nitpick comments (1)
pipeline/inputs/process.md (1)

15-16: Consider tightening the wording in the interval_nsec description.

“In conjunction with” is a bit wordy for docs; a shorter phrasing reads better.

♻️ Suggested edit
-| `interval_nsec` | Specifies the interval between service checks, in nanoseconds. This works in conjunction with `interval_sec`. | `0`     |
+| `interval_nsec` | Specifies the interval between service checks, in nanoseconds. Used with `interval_sec`.                      | `0`     |

  - Sort configuration parameters table alphabetically
  - Change table parameter names to lowercase to match other input plugin docs

Fixes fluent#2329

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell force-pushed the erics_in_process_updates branch from e3226fe to 4efae10 Compare January 17, 2026 17:18
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
pipeline/inputs/process.md (1)

59-63: Fix Interval_NSec casing in classic conf example.

PR objective mentions correcting this, but the example still shows Interval_NSec. If the convention is Interval_Nsec, update the example to avoid conflicting guidance.

💡 Suggested change
-  Interval_NSec 0
+  Interval_Nsec 0
🧹 Nitpick comments (1)
pipeline/inputs/process.md (1)

15-16: Optional: tighten wording.

“In conjunction with” could be shortened (e.g., “works with”) without losing meaning.

@eschabell
Copy link
Collaborator Author

Thanks for the review @cosmo0920, merging!

@eschabell eschabell merged commit 324f97e into fluent:master Jan 19, 2026
8 checks passed
@eschabell eschabell deleted the erics_in_process_updates branch January 19, 2026 15:19
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.

Update needed for input plugin process docs

2 participants