in_someip: Initial input plugin documentation.#1569
in_someip: Initial input plugin documentation.#1569anthonypayne-GM wants to merge 3 commits intofluent:masterfrom
Conversation
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>
|
@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
left a comment
There was a problem hiding this comment.
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. | |||
There was a problem hiding this comment.
| 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\). |
There was a problem hiding this comment.
| 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 :)
| | 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 | |
There was a problem hiding this comment.
| | 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
| ## 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: |
There was a problem hiding this comment.
| ## 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: |
| ### 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 | ||
| ``` |
There was a problem hiding this comment.
| ### 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 |
| ### Configuration File | ||
|
|
||
| In your main configuration file append the following _Input_ & _Output_ sections: |
There was a problem hiding this comment.
| ### Configuration File | |
| In your main configuration file append the following _Input_ & _Output_ sections: | |
| ### Configuration file | |
| In your main configuration file append the following sections: |
| {% 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==' | ||
| ``` |
There was a problem hiding this comment.
| {% 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.
Adds the documentation for the new in_someip plugin:
fluent/fluent-bit#9570