README
¶
Websocket Processor
| Status | |
|---|---|
| Stability | development: logs, metrics, traces |
| Distributions | [] |
The WebSocket processor, which can be positioned anywhere in a pipeline, allows
data to pass through to the next component. Simultaneously, it makes a portion
of the data accessible to WebSocket clients connecting on a configurable port.
This functionality resembles that of the Unix tee command, which enables data
to flow through while duplicating and redirecting it for inspection.
To avoid overloading clients, the amount of telemetry duplicated over any open WebSockets is rate limited by an adjustable amount.
Config
The WebSocket processor has two configurable fields: port and limit:
port: The port on which the WebSocket processor listens. Optional. Defaults to12001.limit: The rate limit over the WebSocket in messages per second. Can be a float or an integer. Optional. Defaults to1.
Example configuration:
websocket:
port: 12001
limit: 1 # rate limit 1 msg/sec
Documentation
¶
Overview ¶
Package websocketprocessor can be positioned anywhere in a pipeline, allowing data to pass through to the next component. Simultaneously, it makes a portion of the data accessible to WebSocket clients connecting on a configurable port.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewFactory ¶
Types ¶
type Config ¶
type Config struct {
// Port indicates the port used by the web socket listener started by this processor.
// Defaults to 12001.
Port int `mapstructure:"port"`
// Limit is a float that indicates the maximum number of messages repeated
// through the websocket by this processor in messages per second. Defaults to 1.
Limit rate.Limit `mapstructure:"limit"`
}
Source Files
Directories