in_someip: Initial input plugin documentation. by anthonypayne-GM · Pull Request #1569 · fluent/fluent-bit-docs

anthonypayne-GM · 2025-02-06T22:47:58Z

Adds the documentation for the new in_someip plugin:
fluent/fluent-bit#9570

Summary by CodeRabbit

Documentation
- Added a documentation page for the SOME/IP input plugin: overview, supported configuration options (Event and RPC), step-by-step getting‑started examples for CLI and config-file usage (YAML and .conf), and a testing walkthrough with a sample test service, representative startup logs, and example received-event payloads (including base64 examples).

Adds the documentation for the new in_someip plugin: fluent/fluent-bit#9570 Signed-off-by: Anthony Payne <anthony.payne@gm.com>

Updated in_someip documentation to include example yaml configuration. Signed-off-by: Anthony Payne <anthony.payne@gm.com>

eschabell · 2025-10-21T20:11:21Z

@esmerel can you review for style, this is waiting on code PR fluent/fluent-bit#9570 before we merge this and is tagged so.

esmerel

Updated (mostly) for style and consistency. It's not exactly how I want it because the web editor doesn't handle suggested changes with code ticks well.

Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Eric D. Schabell <eric@schabell.org>

coderabbitai · 2026-05-28T13:34:33Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f2b0de6b-93fe-4724-b389-230de8ad26aa

📥 Commits

Reviewing files that changed from the base of the PR and between ce948a0 and e7968d2.

📒 Files selected for processing (1)

pipeline/inputs/someip.md

✅ Files skipped from review due to trivial changes (1)

pipeline/inputs/someip.md

📝 Walkthrough

Walkthrough

Adds a new documentation page for the SOME/IP input plugin describing its purpose, supported configuration keys (Event, RPC), CLI and config-file examples, and a testing walkthrough with sample Fluent Bit logs and received event output.

Changes

SOME/IP Plugin Documentation

Layer / File(s)	Summary
SOME/IP input plugin documentation `pipeline/inputs/someip.md`	New documentation file covering the SOME/IP input plugin: overview, `Event` and `RPC` configuration keys, CLI and config-file usage examples, and a testing section with sample commands, startup logs, and received event output.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

5.0

Suggested reviewers

cosmo0920

Poem

A rabbit finds a SOME/IP trail,
Notes configs, CLI, and test detail,
Logs that hum and events that sing,
Docs hop in—now testers spring! 🐇📘

🚥 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 'in_someip: Initial input plugin documentation.' clearly and specifically describes the main change—adding initial documentation for the in_someip input plugin.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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.}

Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Eric D. Schabell <eric@schabell.org>

coderabbitai

Actionable comments posted: 2

🤖 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 `@pipeline/inputs/someip.md`:
- Line 14: The RPC description contains a duplicated phrase "should be a should
be" in the sentence about the request payload; edit the text in the RPC
description (the line describing RPC format) to remove the duplicate so it reads
clearly (e.g., "The request payload should be base64 encoded") — update the
sentence in the SOME/IP RPC description to eliminate the repeated words.
- Around line 11-15: Update the fluent-bit.yaml example and parameter table:
replace repeated Title_Case mapping keys `Event` and `RPC` with lowercase
`event` and `rpc`, represent multiple events as a YAML list under a single
`event:` key (instead of duplicating the key), and correct the RPC description
typo in the parameters table from “should be a should be base64 encoded” to
“should be base64 encoded”; look for the fluent-bit example and the table
entries referencing `Event`/`RPC` in the someip.md content to apply these
changes.

🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: e9fa62c0-504f-45d4-8a0e-913416454bb4

📥 Commits

Reviewing files that changed from the base of the PR and between c576098 and df38c34.

📒 Files selected for processing (1)

pipeline/inputs/someip.md

coderabbitai · 2026-05-28T13:43:03Z

Actionable comments posted: 0

- Change all bash code fence identifiers to shell - Fix unclosed code fence in command line section - Lowercase YAML config keys in example and parameter table - Convert duplicate YAML event keys to a proper list - Add missing closing code fence for fluent-bit.yaml tab - Add missing endtab tag for fluent-bit.yaml tab - Add missing closing code fence for fluent-bit.conf tab - Fix mismatched closing quote in RPC parameter description - Remove trailing space after someip_test_service command - Remove extra trailing blank lines at end of file Applies to fluent#1569 Signed-off-by: Eric D. Schabell <eric@schabell.org>

- Change all bash code fence identifiers to shell - Fix unclosed code fence in command line section - Add missing closing code fence for fluent-bit.yaml tab - Add missing endtab tag for fluent-bit.yaml tab - Add missing closing code fence for fluent-bit.conf tab - Lowercase YAML config keys in example and parameter table - Convert duplicate YAML event keys to a proper YAML list - Fix mismatched closing quote in rpc parameter description - Replace RPCs with RPC entries to avoid vale spelling flag - Fix headings to sentence case - Fixing vale compliance errors - Remove first-person we usage in Testing section - Remove trailing spaces extra trailing blank lines at end of file Applies to fluent#1569 Signed-off-by: Eric D. Schabell <eric@schabell.org>

coderabbitai

Actionable comments posted: 2

🤖 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 `@pipeline/inputs/someip.md`:
- Line 74: Replace the insecure URL string "http://fluentbit.io" with
"https://fluentbit.io" in the markdown text so the Fluent Bit docs link uses
HTTPS (look for the literal "http://fluentbit.io" occurrence in the
pipeline/inputs/someip.md content and update it to "https://fluentbit.io").
- Around line 13-14: Update the two parameter descriptions for `event` and `rpc`
to use the hyphenated form "comma-separated" (i.e., change instances of "comma
separated list" to "comma-separated list") so both lines read consistently;
specifically edit the `event` description containing "service_ID, event_ID,
event_group_ID_1, event_group_ID_2, ..." and the `rpc` description containing
"service_ID, service_instance, method_ID, request_payload" to use
"comma-separated" in the phrasing.

🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2a6af4c2-47c3-465b-8de8-403dbba79d11

📥 Commits

Reviewing files that changed from the base of the PR and between abf83b4 and ce948a0.

📒 Files selected for processing (1)

pipeline/inputs/someip.md

eschabell · 2026-05-28T16:20:36Z

@anthonypayne-GM a bunch of fixes for docs compliance and vale issues done!

- Change "comma separated list" to "comma-separated list" in event and rpc descriptions - Fix insecure http://fluentbit.io link to https://fluentbit.io Applies to fluent#1569 Signed-off-by: Eric D. Schabell <eric@schabell.org>

coderabbitai · 2026-05-28T16:24:40Z

Actionable comments posted: 0

eschabell

@anthonypayne-GM just waiting now on the code PR merging.

in_someip: Initial input plugin documentation.

4ca9be6

Adds the documentation for the new in_someip plugin: fluent/fluent-bit#9570 Signed-off-by: Anthony Payne <anthony.payne@gm.com>

anthonypayne-GM requested review from a team as code owners February 6, 2025 22:47

anthonypayne-GM closed this Feb 6, 2025

anthonypayne-GM reopened this Feb 6, 2025

anthonypayne-GM added 2 commits February 25, 2025 10:56

Merge branch 'fluent:master' into someip-input-plugin-docs

2b41441

in_someip: Added yaml sample configuration

42ddbc0

Updated in_someip documentation to include example yaml configuration. Signed-off-by: Anthony Payne <anthony.payne@gm.com>

anthonypayne-GM mentioned this pull request Feb 25, 2025

in_someip: SOME/IP input plugin fluent/fluent-bit#9570

Open

3 tasks

lecaros added the waiting-on-code-merge label Mar 17, 2025

eschabell self-assigned this Oct 21, 2025

eschabell requested a review from esmerel October 21, 2025 20:10

eschabell added the waiting-on-review Waiting on a review from mainteners label Oct 21, 2025

esmerel reviewed Oct 21, 2025

View reviewed changes

esmerel removed the waiting-on-review Waiting on a review from mainteners label Oct 28, 2025

eschabell added 4.2.1 waiting-for-user Waiting for user/contributors feedback or requested changes and removed 4.2.1 labels Dec 3, 2025

Update pipeline/inputs/someip.md

df38c34

Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Eric D. Schabell <eric@schabell.org>

eschabell self-requested a review as a code owner May 28, 2026 13:34

eschabell added waiting-on-review Waiting on a review from mainteners and removed waiting-for-user Waiting for user/contributors feedback or requested changes labels May 28, 2026

eschabell and others added 6 commits May 28, 2026 15:35

Update pipeline/inputs/someip.md

9db2656

Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Eric D. Schabell <eric@schabell.org>

Update pipeline/inputs/someip.md

46a7f11

Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Eric D. Schabell <eric@schabell.org>

Update pipeline/inputs/someip.md

a1d9a46

Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Eric D. Schabell <eric@schabell.org>

Update pipeline/inputs/someip.md

f314d8a

Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Eric D. Schabell <eric@schabell.org>

Update pipeline/inputs/someip.md

d3eae3c

Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Eric D. Schabell <eric@schabell.org>

Update pipeline/inputs/someip.md

abf83b4

Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Eric D. Schabell <eric@schabell.org>

coderabbitai Bot reviewed May 28, 2026

View reviewed changes

Comment thread pipeline/inputs/someip.md

Comment thread pipeline/inputs/someip.md Outdated

eschabell added 2 commits May 28, 2026 15:57

coderabbitai Bot reviewed May 28, 2026

View reviewed changes

Comment thread pipeline/inputs/someip.md Outdated

Comment thread pipeline/inputs/someip.md Outdated

docs: pipeline: inputs: someip: moree vale compliance fixes

e7968d2

- Change "comma separated list" to "comma-separated list" in event and rpc descriptions - Fix insecure http://fluentbit.io link to https://fluentbit.io Applies to fluent#1569 Signed-off-by: Eric D. Schabell <eric@schabell.org>

eschabell approved these changes May 28, 2026

View reviewed changes

eschabell removed the waiting-on-review Waiting on a review from mainteners label May 28, 2026

Conversation

anthonypayne-GM commented Feb 6, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

eschabell commented Oct 21, 2025

Uh oh!

esmerel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot commented May 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested labels

Suggested reviewers

Poem

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot commented May 28, 2026

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

eschabell commented May 28, 2026

Uh oh!

coderabbitai Bot commented May 28, 2026

Uh oh!

eschabell left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

anthonypayne-GM commented Feb 6, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented May 28, 2026 •

edited

Loading