Audit and fix all filter plugin docs for consistency, accuracy, and completeness.#2410
Audit and fix all filter plugin docs for consistency, accuracy, and completeness.#2410eschabell wants to merge 26 commits intofluent:masterfrom
Conversation
- Fix prose typo: kube.var.logs.containers → kube.var.log.containers - Fix YAML example typo: use_kubelet: ture → use_kubelet: true - Fix classic config code fence: ```yaml → ```text Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
…ML key case - Sort configuration parameters table alphabetically - Lowercase table keys to match source code (allowlist_key, record, remove_key, etc.) - Fix YAML example: Allowlist_key → allowlist_key Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
…n examples - Sort configuration parameters table alphabetically - Fix YAML example: Fluentbit_version_key → fluentbit_version_key, Os_name_key → os_name_key - Fix classic config example: same key case corrections - Fix classic config [OUTPUT]: name/match → Name/Match Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
- Remove spurious trailing 'e' character from first output sample - Remove trailing whitespace inside classic config code blocks (two occurrences) Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
…fix example key case - Sort configuration parameters table alphabetically - Lowercase table keys to match source code (accessible_paths, event_format, etc.) - Fix classic config: WASM_Path → Wasm_Path - Add default value for accessible_paths (. per source) Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
- Sort configuration parameters table alphabetically - Lowercase table keys to match source code (interval, print_status, rate, window) - Update prose and section heading parameter references to lowercase - Fix Vale: replace directional word 'below' with 'within' Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
…sing param, fix typos - Rename table column header: Property → Key - Sort configuration parameters table alphabetically - Add missing debug_flush parameter (bool, default false) - Fix typo in emitter_mem_buf_limit description: ' or example' → 'For example' - Fix prose: 'stacktraces' → 'stack traces' Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
- Sort table: fix emitter_name/emitter_mem_buf_limit and flush_interval order - Remove generic framework params not in plugin config_map: alias, log_level, log_supress_interval, match, match_regex - Fix YAML histogram example: duplicate bucket 1000 → 100 to match classic config Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
…ing tls.vhost - Sort tls.* parameters alphabetically: tls.ca_path before tls.debug before tls.verify - Add missing tls.vhost parameter from source Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
…e YAML keys - Remove leading space before [OUTPUT] in Example 1 classic config block - Lowercase YAML filter keys in Examples 2, 3, and 4 to match Example 1 convention Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
… log_level from examples - Sort configuration parameters table alphabetically - Fix lookup_key default: _none_ → log (matches source) - Remove log_level from YAML and classic config examples (not a plugin parameter) Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
… formatting - Sort configuration parameters table alphabetically - Fix [Input]/[Filter]/[Output] → [INPUT]/[FILTER]/[OUTPUT] in record-split example - Fix Name Lua → Name lua in inline configuration example - Fix lowercase call → Call in response-code and time-format classic config examples - Fix [Output] → [OUTPUT] in response-code and time-format examples - Fix Vale: 'should not' → 'shouldn't' Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
…aults - Rename table column header: Property → Key - Sort configuration parameters table alphabetically - Add Default column with source-verified defaults: action → warn, result_key → matched Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
…fix indentation - Sort configuration parameters table alphabetically - Add missing enable_entity parameter (bool, default false) from source - Fix YAML example: 4-space → 2-space indentation - Fix classic config example: 4-space → 2-space indentation Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
…defaults - Sort configuration parameters table alphabetically (exclude, logical_op, regex) - Lowercase table keys to match source code - Add Default column: logical_op → legacy, regex/exclude → none - Update prose references to use lowercase parameter names Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
… example - Fix typo in include_input_fields description: 'input filed' → 'input fields' - Fix default value capitalization: True → true - Fix broken command-line example: rejoin split command and separate output block Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
- Sort parameter table alphabetically (float_key, int_key, str_key, uint_key) - Add missing space before closing pipe in table rows Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
- Lowercase all parameter table keys to match source (add, cluster_metadata_only,
ecs_meta_cache_ttl, ecs_tag_prefix)
- Sort parameter table alphabetically
- Add 3 missing parameters from source: agent_endpoint_retries (default 2),
ecs_meta_host (default 127.0.0.1), ecs_meta_port (default 51678)
- Lowercase plugin-specific keys in classic config examples
- Fix missing colons in sample JSON output (ecs_task_id, resource keys)
- Fix hard line wraps in prose
- Update heading/prose references from ADD/Cluster_Metadata_Only to
add/cluster_metadata_only
Applies to fluent#2409
Signed-off-by: Eric D. Schabell <eric@schabell.org>
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDocumentation updates across many pipeline filter docs: normalized configuration keys to snake_case, added/reordered Default columns and parameters, fixed typos/formatting, and expanded the AWS metadata filter's public configuration with new keys and examples. No runtime code changes. Changes
Sequence Diagram(s)Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
There was a problem hiding this comment.
Actionable comments posted: 11
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (4)
pipeline/filters/grep.md (2)
142-144: 🛠️ Refactor suggestion | 🟠 MajorPlugin-specific keys should be lowercase in classic config examples.
Per the PR objectives, plugin-specific parameters should use lowercase keys in classic configuration format to match the parameter table (lines 13-17). The examples currently use Title_Case for
Exclude,Regex, andLogical_Op, but they should be lowercase:exclude,regex, andlogical_op.♻️ Proposed fixes for all affected examples
Example at lines 142-144:
[FILTER] Name grep Match * - Exclude $kubernetes['labels']['app'] myapp + exclude $kubernetes['labels']['app'] myappExample at lines 183-186:
[FILTER] Name grep Alias filter-iots-grep Match iots_thread.* - Regex iot_timestamp ^\d{4}-\d{2}-\d{2} + regex iot_timestamp ^\d{4}-\d{2}-\d{2}Example at lines 240-244:
[FILTER] Name grep Match * - Logical_Op or - Regex value something - Regex value error + logical_op or + regex value something + regex value errorAlso applies to: 183-186, 240-244
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@pipeline/filters/grep.md` around lines 142 - 144, The classic config examples for the grep plugin use Title_Case keys; update the plugin-specific keys in the grep examples to lowercase (e.g., change Exclude -> exclude, Regex -> regex, Logical_Op -> logical_op) so they match the parameter table and PR conventions; edit the grep examples shown (the blocks containing "Name grep" and the other two examples referenced) and replace those capitalized keys with the lowercase equivalents while leaving values and surrounding structure intact.
86-88:⚠️ Potential issue | 🟡 MinorFix casing inconsistency in classic config example.
According to the PR objectives, classic config examples should use Title_Case for framework parameters (Name, Match) while plugin-specific keys remain lowercase. This example uses all lowercase, which is inconsistent with other examples in this file (lines 142-144, 183-186, 240-244).
📝 Proposed fix for consistent casing
[FILTER] - name grep - match * + Name grep + Match * regex log aa🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@pipeline/filters/grep.md` around lines 86 - 88, The example config uses lowercase framework keys but should follow Title_Case for framework parameters: change "name" to "Name" and "match" to "Match" while keeping the plugin-specific key "regex" lowercase; update the example block that currently reads "name grep / match * / regex log aa" to use "Name" and "Match" to match other examples (retain "regex" as-is) so casing is consistent with the rest of the document.pipeline/filters/parser.md (1)
9-14:⚠️ Potential issue | 🟠 MajorUpdate parameter tables and classic config examples to use lowercase keys for consistency with YAML examples and other updated filter documentation.
This file has internal inconsistency: YAML examples already use lowercase keys (
key_name,parser,reserve_data,preserve_key), but the parameter table (lines 9-14) and classic config examples (lines 86-89, 186-190, 281-286) use Title_Case. Most other filter documentation (19 of 27 filter docs) have already been updated to use lowercase keys in parameter tables and config examples.Update the following to lowercase:
- Parameter table:
Key_Name→key_name,Parser→parser,Preserve_Key→preserve_key,Reserve_Data→reserve_data- Classic config examples: Same key names in all three locations (lines 86-89, 186-190, 281-286)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@pipeline/filters/parser.md` around lines 9 - 14, The parameter table and classic config examples use Title_Case keys but must be lowercase to match YAML examples and other docs; replace `Key_Name`→`key_name`, `Parser`→`parser`, `Preserve_Key`→`preserve_key`, and `Reserve_Data`→`reserve_data` in the parameter table and in all three classic config example blocks so the keys are consistently lowercase (`key_name`, `parser`, `preserve_key`, `reserve_data`) across parser.md (update the parameter table entries and the three classic config examples).pipeline/filters/kubernetes.md (1)
468-489:⚠️ Potential issue | 🟡 MinorKeep the classic example on the same snake_case schema.
This block still uses
Use_Kubelet/Kubelet_Portand other Title_Case plugin keys, while the table and YAML example documentuse_kubelet/kubelet_port. The page is still mixed-format after this update.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@pipeline/filters/kubernetes.md` around lines 468 - 489, The kubernetes filter example uses Title_Case plugin keys (e.g., Kube_URL, Kube_CA_File, Kube_Token_File, Use_Kubelet, Kubelet_Port, Merge_Log, Buffer_Size) while the rest of the docs use snake_case; update those keys in the kubernetes [FILTER] block to the snake_case equivalents (kube_url, kube_ca_file, kube_token_file, use_kubelet, kubelet_port, merge_log, buffer_size) so the example matches the documented schema for the kubernetes filter and stays consistent with the table/YAML examples.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@pipeline/filters/aws-metadata.md`:
- Line 20: Update the table row for the configuration key retry_interval_s so
its description explicitly states the unit in seconds (e.g., "Defines minimum
duration between retries for fetching EC2 instance tags (seconds).") — edit the
description text for retry_interval_s to include "(seconds)" or similar explicit
wording so readers cannot mistake the unit.
In `@pipeline/filters/ecs-metadata.md`:
- Line 16: Update the documentation text for the option `ecs_meta_cache_ttl` so
the first occurrence of "TTL" is expanded to "time-to-live (TTL)"; specifically,
replace "max TTL" with "maximum time-to-live (TTL)" (or similar phrasing) in the
sentence describing the in-memory hash table to satisfy Vale and clarify the
term.
In `@pipeline/filters/geoip2-filter.md`:
- Line 18: The classic example still uses `Lookup_key` and `Record` while the
table and new convention use lowercase `lookup_key`; update the classic example
to normalize casing by replacing `Lookup_key` with `lookup_key` and `Record`
with `record` (and any other occurrences) so the example matches the documented
lowercase key style and supports multiple `lookup_key` entries as described.
In `@pipeline/filters/grep.md`:
- Around line 197-199: Fix two grammatical errors in the grep.md documentation:
change the phrase "If `exclude` match" to "If `exclude` matches" (subject-verb
agreement) and change "multiple `exclude` entry" to "multiple `exclude` entries"
(correct plural). Locate the sentences containing the exact fragments "If
`exclude` match" and "multiple `exclude` entry" and replace them with the
corrected forms.
In `@pipeline/filters/lua.md`:
- Around line 329-332: The examples use capitalized plugin keys
("Script"/"Call") which violates the file's lowercase convention and will
confuse users; update the Lua filter snippets to use the lowercase keys "script"
and "call" instead (e.g., the block that defines function append_tag(tag,
timestamp, record) should be under script and call, not Script/Call), and make
the same lowercase corrections for the other classic-example blocks mentioned
(the other Lua filter snippets that mirror this pattern).
In `@pipeline/filters/multiline-stacktrace.md`:
- Around line 41-51: The classic-mode config examples below the parameter table
use lowercase `name`/`match` but the PR standard is to use `Name` and `Match`
with plugin-specific keys in lowercase (e.g. `emitter_name`, `flush_ms`, `mode`,
`multiline.parser`); update each classic snippet to capitalize the top-level
plugin keys `Name` and `Match` while keeping all plugin-specific keys (like
`emitter_name`, `emitter_storage.type`, `multiline.key_content`,
`multiline.parser`, `buffer`, `debug_flush`, `emitter_mem_buf_limit`,
`flush_ms`, `mode`) in lowercase to match the standardized casing. Ensure every
example under the table reflects this change so casing is consistent across the
page.
In `@pipeline/filters/nest.md`:
- Around line 168-179: Update the parameter table to match the renamed keys used
in the examples: replace legacy capitalized names (Operation, Wildcard,
Nest_under, etc.) with the new lowercase keys (operation, wildcard, nest_under,
nested_under) and include the other used keys add_prefix and remove_prefix;
ensure each table row/description references the exact symbol names shown in the
example (operation, wildcard, nest_under, nested_under, add_prefix,
remove_prefix) so the schema in the table matches the examples.
In `@pipeline/filters/record-modifier.md`:
- Around line 11-15: Update the example configurations and CLI samples to use
the normalized lowercase parameter names (`record`, `remove_key`,
`allowlist_key`) instead of the old-cased `Record`, `Remove_key`, and
`Allowlist_key`; search for those uppercased tokens in the file (they appear in
the fluent-bit.conf and CLI examples) and replace them with the corresponding
lowercase symbols so the examples match the table and the rest of the page.
In `@pipeline/filters/sysinfo.md`:
- Around line 14-15: Update the example value for the os_name_key to use the
correct Apple branding: replace the lowercase "macos" example with "macOS" in
the pipeline/filters/sysinfo.md entry for os_name_key so the user-facing example
reads "Linux, win64 or macOS".
In `@pipeline/filters/throttle.md`:
- Around line 11-14: The docs show lowercase config keys (`interval`, `rate`,
`window`, `print_status`) but the examples still use `Interval`/`Rate`/`Window`,
creating inconsistency; update all example snippets on this page to use the
documented lowercase keys (`interval`, `rate`, `window`, `print_status`)
(replace occurrences of `Interval`, `Rate`, `Window`, and `PrintStatus` in the
examples) and verify pasted examples match the table and default values (e.g.,
`window` default 5) so copy-paste usage is correct.
In `@pipeline/filters/wasm.md`:
- Around line 66-69: Update the example keys to use the new snake_case names to
match the renamed table: replace Wasm_Path with wasm_path, Function_Name with
function_name, and Accessible_Paths with accessible_paths (also normalize
Event_Format to event_format if the rest of the doc uses snake_case). Ensure the
YAML/example block uses wasm_path, function_name, accessible_paths so it is
consistent with the renamed table and the other Wasm docs.
---
Outside diff comments:
In `@pipeline/filters/grep.md`:
- Around line 142-144: The classic config examples for the grep plugin use
Title_Case keys; update the plugin-specific keys in the grep examples to
lowercase (e.g., change Exclude -> exclude, Regex -> regex, Logical_Op ->
logical_op) so they match the parameter table and PR conventions; edit the grep
examples shown (the blocks containing "Name grep" and the other two examples
referenced) and replace those capitalized keys with the lowercase equivalents
while leaving values and surrounding structure intact.
- Around line 86-88: The example config uses lowercase framework keys but should
follow Title_Case for framework parameters: change "name" to "Name" and "match"
to "Match" while keeping the plugin-specific key "regex" lowercase; update the
example block that currently reads "name grep / match * / regex log aa" to
use "Name" and "Match" to match other examples (retain "regex" as-is) so casing
is consistent with the rest of the document.
In `@pipeline/filters/kubernetes.md`:
- Around line 468-489: The kubernetes filter example uses Title_Case plugin keys
(e.g., Kube_URL, Kube_CA_File, Kube_Token_File, Use_Kubelet, Kubelet_Port,
Merge_Log, Buffer_Size) while the rest of the docs use snake_case; update those
keys in the kubernetes [FILTER] block to the snake_case equivalents (kube_url,
kube_ca_file, kube_token_file, use_kubelet, kubelet_port, merge_log,
buffer_size) so the example matches the documented schema for the kubernetes
filter and stays consistent with the table/YAML examples.
In `@pipeline/filters/parser.md`:
- Around line 9-14: The parameter table and classic config examples use
Title_Case keys but must be lowercase to match YAML examples and other docs;
replace `Key_Name`→`key_name`, `Parser`→`parser`, `Preserve_Key`→`preserve_key`,
and `Reserve_Data`→`reserve_data` in the parameter table and in all three
classic config example blocks so the keys are consistently lowercase
(`key_name`, `parser`, `preserve_key`, `reserve_data`) across parser.md (update
the parameter table entries and the three classic config examples).
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: fe2fc79d-9450-4aa0-acfc-7e702f7724e9
📒 Files selected for processing (20)
pipeline/filters/aws-metadata.mdpipeline/filters/checklist.mdpipeline/filters/ecs-metadata.mdpipeline/filters/expect.mdpipeline/filters/geoip2-filter.mdpipeline/filters/grep.mdpipeline/filters/kubernetes.mdpipeline/filters/log_to_metrics.mdpipeline/filters/lua.mdpipeline/filters/multiline-stacktrace.mdpipeline/filters/nest.mdpipeline/filters/nightfall.mdpipeline/filters/parser.mdpipeline/filters/record-modifier.mdpipeline/filters/rewrite-tag.mdpipeline/filters/sysinfo.mdpipeline/filters/tensorflow.mdpipeline/filters/throttle.mdpipeline/filters/type-converter.mdpipeline/filters/wasm.md
…c config keys - Fixed grammar: "If exclude match" → "matches", "multiple exclude entry" → "entries" - Capitalized Name, Match, Path, Parser, Regex in classic config blocks Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
…tion - Added "in seconds" to the retry_interval_s description to make the unit explicit Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
…o Title_Case Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
|
@cosmo0920 and @patrick-stephens if you have time to review, please note this is bigger set of changes covering the entire filters doc section update. |
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
pipeline/filters/multiline-stacktrace.md (1)
348-348:⚠️ Potential issue | 🟡 MinorCapitalize framework key
Matchon line 346, keepModelowercase for consistency.Line 348 shows
Modein Title_Case, but this is inconsistent with the established standard for this PR. The parametermodeis a plugin-specific key (documented in lowercase in the parameter table at line 49, and shown in lowercase in the YAML example at line 337). According to the PR's convention, classic config examples should use Title_Case only for framework keys likeNameandMatch, while plugin-specific keys should remain lowercase.✏️ Proposed fix for casing consistency
[FILTER] Name multiline Match * multiline.key_content log - Mode partial_message + mode partial_messageBased on learnings: In the fluent-bit-docs repository, classic fluent-bit.conf examples use Title_Case for framework keys (Name, Match) while plugin-specific keys remain lowercase (mode, multiline.key_content, multiline.parser).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@pipeline/filters/multiline-stacktrace.md` at line 348, The config example has inconsistent casing: ensure the framework key is Title_Case and plugin keys are lowercase — change the framework key to "Match" (capitalized) where it appears (reference the config example around the multiline stacktrace block and the key currently using framework casing), and make the plugin-specific key "mode" lowercase (replace any "Mode" Title_Case occurrences) so plugin keys like mode, multiline.key_content, and multiline.parser remain lowercase while framework keys like Name and Match stay Title_Case.
🧹 Nitpick comments (1)
pipeline/filters/grep.md (1)
204-206: Consider varying sentence structure for better readability.Three successive sentences begin with "If", which slightly affects readability. Consider rephrasing to improve flow.
✍️ Suggested rewording for variety
-If you want to set multiple `regex` or `exclude`, you can use `logical_op` property to use logical conjunction or disjunction. - -If `logical_op` is set, setting both `regex` and `exclude` results in an error. +You can set multiple `regex` or `exclude` entries by using the `logical_op` property for logical conjunction or disjunction. + +Note that when `logical_op` is set, specifying both `regex` and `exclude` results in an error.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@pipeline/filters/grep.md` around lines 204 - 206, Several sentences in pipeline/filters/grep.md that explain the `logical_op` behavior all start with "If", hurting readability; rephrase those three consecutive sentences to vary sentence openings and improve flow while preserving meaning — for example, start one sentence with "When `logical_op` is set," another with "Setting both `regex` and `exclude` causes an error," and use a different construction for the third — ensure you reference the same symbols (`logical_op`, `regex`, `exclude`) so the intent remains clear.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@pipeline/filters/aws-metadata.md`:
- Around line 84-96: The example Fluent Bit classic config for the aws filter
uses lowercase plugin-specific keys; update them to Title_Case to match project
convention: change imds_version, az, ec2_instance_id, ec2_instance_type,
private_ip, ami_id, account_id, hostname, vpc_id, tags_enabled to Imds_version,
Az, Ec2_instance_id, Ec2_instance_type, Private_ip, Ami_id, Account_id,
Hostname, Vpc_id, Tags_enabled in the [FILTER] Name aws block so the aws filter
example follows the same Title_Case style as other filters.
---
Duplicate comments:
In `@pipeline/filters/multiline-stacktrace.md`:
- Line 348: The config example has inconsistent casing: ensure the framework key
is Title_Case and plugin keys are lowercase — change the framework key to
"Match" (capitalized) where it appears (reference the config example around the
multiline stacktrace block and the key currently using framework casing), and
make the plugin-specific key "mode" lowercase (replace any "Mode" Title_Case
occurrences) so plugin keys like mode, multiline.key_content, and
multiline.parser remain lowercase while framework keys like Name and Match stay
Title_Case.
---
Nitpick comments:
In `@pipeline/filters/grep.md`:
- Around line 204-206: Several sentences in pipeline/filters/grep.md that
explain the `logical_op` behavior all start with "If", hurting readability;
rephrase those three consecutive sentences to vary sentence openings and improve
flow while preserving meaning — for example, start one sentence with "When
`logical_op` is set," another with "Setting both `regex` and `exclude` causes an
error," and use a different construction for the third — ensure you reference
the same symbols (`logical_op`, `regex`, `exclude`) so the intent remains clear.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 27eccaf6-6427-4bc8-acee-0202b8276ca5
📒 Files selected for processing (4)
pipeline/filters/aws-metadata.mdpipeline/filters/grep.mdpipeline/filters/multiline-stacktrace.mdpipeline/filters/sysinfo.md
✅ Files skipped from review due to trivial changes (1)
- pipeline/filters/sysinfo.md
…Case Applies to fluent#2409 Signed-off-by: Eric D. Schabell <eric@schabell.org>
Changes applied across all 20 filter docs:
FLB_CONFIG_MAP)Name/Matchin Title_Case; plugin-specific keys in lowercaseFiles changed
aws-metadata.md— add missingenable_entityparam; sort table; fix indentationchecklist.md— sort table; fixlookup_keydefault; remove non-plugin params from examplesecs-metadata.md— add missingagent_endpoint_retries,ecs_meta_host,ecs_meta_port; sort table; lowercase keysexpect.md— fix table header; sort table; add Default column with source-verified valuesgeoip2-filter.md— note thatlookup_keysupports multiple entriesgrep.md— lowercase table keys; sort table; add Default columnkubernetes.md— fix prose and YAML typos; fix code fence typelog_to_metrics.md— sort table; remove non-plugin params; fix duplicate histogram bucketlua.md— sort table; lowercase keys; fix section header casing; fix Vale contractionmultiline-stacktrace.md— fix table header; sort table; add missingdebug_flushparam; fix typosnest.md— fix leading space in classic config; lowercase YAML filter keysnightfall.md— sorttls.*params; add missingtls.vhostparamparser.md— fix trailing character typo in sample output; fix trailing whitespacerecord-modifier.md— sort table; lowercase table keysrewrite-tag.md— fixNAME→Namein classic config examplesysinfo.md— sort table; lowercase keys; fix[OUTPUT]key casingtensorflow.md— fix description typo; fix default casing; fix broken command-line examplethrottle.md— sort table; lowercase keys; fix Vale flagtype-converter.md— sort table; fix table formattingwasm.md— sort table; lowercase keys; fixWASM_Path; addaccessible_pathsdefaultFixes #2409
Summary by CodeRabbit
New Features
Documentation