Skip to content

docs: outputs: websocket: general doc updates and cleanup #2476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eschabell merged 1 commit into from
Mar 20, 2026
+7 −7
Merged

docs: outputs: websocket: general doc updates and cleanup #2476

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions pipeline/outputs/websocket.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ This plugin supports the following parameters:

| Key | Description | Default |
|:--- |:------------|:----------|
| `Host` | IP address or hostname of the target WebSocket Server. | `127.0.0.1` |
| `Port` | TCP port of the target WebSocket Server. | `80` |
| `URI` | Specify an optional HTTP URI for the target WebSocket server. For example, `/someuri`. | `/` |
| `Header` | Add a HTTP header key/value pair. Multiple headers can be set. | _none_ |
| `Format` | Specify the data format to be used in the HTTP request body. Supported formats: `json`, `json_stream`, `json_lines`, `gelf`. | `msgpack` |
| `json_date_key` | Specify the name of the date field in output. | `date` |
| `format` | Specify the data format to be used in the HTTP request body. Supported formats: `json`, `json_stream`, `json_lines`, `gelf`, `msgpack`. | _none_ |
| `header` | Add a HTTP header key/value pair. Multiple headers can be set. | _none_ |
| `host` | IP address or hostname of the target WebSocket Server. | `127.0.0.1` |
| `json_date_format` | Specify the format of the date. Supported formats: `double`, `epoch`, `epoch_ms`, `iso8601`, `java_sql_timestamp`. | `double` |
| `json_date_key` | Specify the name of the date field in output. | `date` |
| `port` | TCP port of the target WebSocket Server. | `80` |
| `uri` | Specify an optional HTTP URI for the target WebSocket server. For example, `/someuri`. | _none_ |
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |

## Get started
Expand Down Expand Up @@ -123,7 +123,7 @@ pipeline:
Port 8080
URI /
Format json
workers 4
Workers 4
net.keepalive on
net.keepalive_idle_timeout 30
```
Expand Down
Loading