|
1 | 1 | # WebSocket
|
2 | 2 |
|
3 |
| -The _WebSocket_ output plugin lets you flush your records into a WebSocket endpoint. It issues an HTTP GET request to do the handshake, and then uses TCP connections to send the data records in either JSON or [MessagePack](http://msgpack.org) format. |
| 3 | +The _WebSocket_ output plugin lets you flush your records into a WebSocket endpoint. It issues an HTTP `GET` request to do the handshake, and then uses TCP connections to send the data records in either JSON or [MessagePack](http://msgpack.org) format. |
4 | 4 |
|
5 | 5 | ## Configuration parameters
|
6 | 6 |
|
@@ -77,7 +77,7 @@ pipeline:
|
77 | 77 | {% endtab %}
|
78 | 78 | {% endtabs %}
|
79 | 79 |
|
80 |
| -The WebSocket plugin works with TCP keepalive mode, see [networking](https://docs.fluentbit.io/manual/v/master/administration/networking#configuration-options) for details. Because WebSocket is a stateful plugin, it will decide when to send out handshake to server side. For example when the plugin begins to work or after connection with server has been dropped. In general, the interval to init a new WebSocket handshake would be less than the keepalive interval. With that strategy, it could detect and resume WebSocket connections. |
| 80 | +For details about how the WebSocket plugin works with TCP keepalive mode, see [networking](https://docs.fluentbit.io/manual/v/master/administration/networking#configuration-options). Because WebSocket is a stateful plugin, it will decide when to send out handshake to server side. For example, when the plugin begins to work or after connection with server has been dropped. In general, the interval to init a new WebSocket handshake would be less than the keepalive interval. With that strategy, it could detect and resume WebSocket connections. |
81 | 81 |
|
82 | 82 | ## Tests
|
83 | 83 |
|
@@ -170,6 +170,6 @@ fluent-bit -c ../conf/out_ws.conf
|
170 | 170 |
|
171 | 171 | ### Scenario description
|
172 | 172 |
|
173 |
| -From the output of the Fluent Bit log, you can see that once data has been ingested into Fluent Bit, plugin performs handshake. If no data or traffic is ongoing, the TCP connection would be aborted. When additional data arrives, a retry for WebSocket plugin triggers, with another handshake and data flush. |
| 173 | +From the output of the Fluent Bit log, you can see that when data has been ingested into Fluent Bit, the plugin performs a handshake. If no data or traffic is ongoing, the TCP connection would be aborted. When additional data arrives, a retry for WebSocket plugin triggers, with another handshake and data flush. |
174 | 174 |
|
175 |
| -There is another scenario, if the WebSocket server goes down and up in a short time, Fluent Bit would resume the TCP connection immediately. But in that case, the WebSocket output plugin is a malfunction state, and needs to restart Fluent Bit to resume working. |
| 175 | +In another scenario, if the WebSocket server goes down and up in a short time, Fluent Bit would resume the TCP connection immediately. But in that case, the WebSocket output plugin is a malfunction state, and needs to restart Fluent Bit to resume working. |
0 commit comments