Skip to main content
Version: v4.23

throttle

Limits the bandwidth of a pipeline.

throttle bandwidth:int, [within=duration]

Description​

The throttle operator limits the amount of data flowing through it to a bandwidth.

bandwidth: int​

The maximum bandwidth that is enforced for this pipeline, in bytes per the specified interval.

within = duration (optional)​

The duration over which to measure the maximum bandwidth.

Defaults to 1s.

Examples​

Read a byte stream at 1 byte per second​

Read a TCP stream at a rate of 1 character per second:

load_tcp "tcp://0.0.0.0:4000"
throttle 1

Set a throughput limit for a given time window​

Load a sample input data file at a speed of at most 1MiB every 10s and import it into the node:

load_http "https://storage.googleapis.com/tenzir-datasets/M57/zeek-all.log.zst"
throttle 1Mi, within=10s
decompress "zstd"
read_zeek_tsv
import