websocket
Connects to a websocket server and continuously receives messages.
- Common
- Advanced
# Common config fields, showing default values
input:
label: ""
websocket:
url: ws://localhost:4195/get/ws # No default (required)
auto_replay_nacks: true
# All config fields, showing default values
input:
label: ""
websocket:
url: ws://localhost:4195/get/ws # No default (required)
proxy_url: "" # No default (optional)
open_message: "" # No default (optional)
open_message_type: binary
auto_replay_nacks: true
tls:
enabled: false
skip_cert_verify: false
enable_renegotiation: false
root_cas: ""
root_cas_file: ""
client_certs: []
connection:
max_retries: -1 # No default (optional)
oauth:
enabled: false
consumer_key: ""
consumer_secret: ""
access_token: ""
access_token_secret: ""
basic_auth:
enabled: false
username: ""
password: ""
jwt:
enabled: false
private_key_file: ""
signing_method: ""
claims: {}
headers: {}
It is possible to configure an open_message
, which when set to a non-empty string will be sent to the websocket server each time a connection is first established.
Fields
url
The URL to connect to.
Type: string
# Examples
url: ws://localhost:4195/get/ws
proxy_url
An optional HTTP proxy URL.
Type: string
open_message
An optional message to send to the server upon connection.
Type: string
open_message_type
An optional flag to indicate the data type of open_message.
Type: string
Default: "binary"
Option | Summary |
---|---|
binary | Binary data open_message. |
text | Text data open_message. The text message payload is interpreted as UTF-8 encoded text data. |
auto_replay_nacks
Whether messages that are rejected (nacked) at the output level should be automatically replayed indefinitely, eventually resulting in back pressure if the cause of the rejections is persistent. If set to false
these messages will instead be deleted. Disabling auto replays can greatly improve memory efficiency of high throughput streams as the original shape of the data can be discarded immediately upon consumption and mutation.
Type: bool
Default: true
tls
Custom TLS settings can be used to override system defaults.
Type: object
tls.enabled
Whether custom TLS settings are enabled.
Type: bool
Default: false