Skip to content

Conversation

@anthonypayne-GM
Copy link

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

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

Signed-off-by: Anthony Payne <[email protected]>
Updated in_someip documentation to include example yaml
configuration.

Signed-off-by: Anthony Payne <[email protected]>
@eschabell
Copy link
Collaborator

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

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

@esmerel esmerel left a comment

Choose a reason for hiding this comment

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

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.

@@ -0,0 +1,115 @@
# SOMEIP

The **someip** input plugin is used to interact with a SOME/IP communication network to subscribe to events and to exchange request/response with SOME/IP services.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The **someip** input plugin is used to interact with a SOME/IP communication network to subscribe to events and to exchange request/response with SOME/IP services.
The _someip_ input plugin is used to interact with a SOME/IP communication network to subscribe to events and to exchange request/response with SOME/IP services.

Matching style of other pages.


The **someip** input plugin is used to interact with a SOME/IP communication network to subscribe to events and to exchange request/response with SOME/IP services.

This plugin uses the [vsomeip library](https://github.com/COVESA/vsomeip) \(built-in dependency\).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
This plugin uses the [vsomeip library](https://github.com/COVESA/vsomeip) \(built-in dependency\).
This plugin uses the [vsomeip library](https://github.com/COVESA/vsomeip) (built-in dependency).

We don't need to escape it, the gitbook renderer is smart enough to figure it out :)

Comment on lines +13 to +14
| Event | SOME/IP event to subscribe to. The configuration can have multiple events, one on each line. An event is identified by a comma separated list with, "_service ID_, _event ID_, _event group ID 1_, _event group ID 2_, ...". The Event must include at least one _event group ID_, but can be associated with multiple. |
| RPC | SOME/IP request to send when service is available. The configuration can have multiple RPCs, one on each line. An RPC is composed as a comma separated list with, "_service ID_, _service instance_, _method ID_, _request payload_". The request payload should be a should be base64 encoded |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| Event | SOME/IP event to subscribe to. The configuration can have multiple events, one on each line. An event is identified by a comma separated list with, "_service ID_, _event ID_, _event group ID 1_, _event group ID 2_, ...". The Event must include at least one _event group ID_, but can be associated with multiple. |
| RPC | SOME/IP request to send when service is available. The configuration can have multiple RPCs, one on each line. An RPC is composed as a comma separated list with, "_service ID_, _service instance_, _method ID_, _request payload_". The request payload should be a should be base64 encoded |
| `Event` | SOME/IP event to subscribe to. The configuration can have multiple events, one on each line. An event is identified by a comma separated list with, `service_ID, event_ID, event_group_ID_1, event_group_ID_2, ...`. The event must include at least one `event_group_ID`, but can be associated with multiple. |
| `RPC` | SOME/IP request to send when service is available. The configuration can have multiple RPCs, one on each line. An RPC is composed as a comma separated list with, `service_ID, service_instance, method_ID, request_payload". The request payload should be base64 encoded. |

Stylistic consistency

Comment on lines +16 to +18
## Getting Started

In order to subscribe to SOME/IP events or send request/receive SOME/IP response, you can run the plugin from the command line or through the configuration file:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## Getting Started
In order to subscribe to SOME/IP events or send request/receive SOME/IP response, you can run the plugin from the command line or through the configuration file:
## Get Started
To subscribe to SOME/IP events or send request/receive SOME/IP response, run the plugin from the command line or through the configuration file:

Comment on lines +20 to +26
### Command Line

The **someip** plugin can be enabled with options from the command line:

```bash
$ ./fluent-bit -i someip -p Event=4,1,32768,1 -o stdout
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
### Command Line
The **someip** plugin can be enabled with options from the command line:
```bash
$ ./fluent-bit -i someip -p Event=4,1,32768,1 -o stdout
```
### Command line
The _someip_ plugin can be enabled with options from the command line:
```bash
./fluent-bit -i someip -p Event=4,1,32768,1 -o stdout

Comment on lines +28 to +30
### Configuration File

In your main configuration file append the following _Input_ & _Output_ sections:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
### Configuration File
In your main configuration file append the following _Input_ & _Output_ sections:
### Configuration file
In your main configuration file append the following sections:

Comment on lines +33 to +56
{% tab title="fluent-bit.conf" %}
```text
[INPUT]
Name someip
Tag in.someip

Event 4,1,32768,1
Event 4,1,32769,2
RPC 4,1,1,CgAQAw==

[OUTPUT]
Name stdout
```
{% endtab %}

{% tab title="fluent-bit.yaml" %}
```yaml
pipeline:
inputs:
- name: someip
Event: '4,1,32768,1'
Event: '4,1,32769,2'
RPC: '4,1,1,CgAQAw=='
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
{% tab title="fluent-bit.conf" %}
```text
[INPUT]
Name someip
Tag in.someip
Event 4,1,32768,1
Event 4,1,32769,2
RPC 4,1,1,CgAQAw==
[OUTPUT]
Name stdout
```
{% endtab %}
{% tab title="fluent-bit.yaml" %}
```yaml
pipeline:
inputs:
- name: someip
Event: '4,1,32768,1'
Event: '4,1,32769,2'
RPC: '4,1,1,CgAQAw=='
```
{% tab title="fluent-bit.yaml" %}
```yaml
pipeline:
inputs:
- name: someip
Event: '4,1,32768,1'
Event: '4,1,32769,2'
RPC: '4,1,1,CgAQAw=='
{% tab title="fluent-bit.conf" %}
```text
[INPUT]
Name someip
Tag in.someip
Event 4,1,32768,1
Event 4,1,32769,2
RPC 4,1,1,CgAQAw==
[OUTPUT]
Name stdout

{% endtab %}

Swapping tab order to put current config type first.

@esmerel esmerel removed the waiting-on-review Waiting on a review from mainteners label Oct 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants