Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
limit
stage
The limit
stage is a rate-limiting stage that throttles logs based on several options.
Limit stage schema
This pipeline stage places limits on the rate or burst quantity of log lines that Promtail pushes to Loki.
The concept of having distinct burst and rate limits mirrors the approach to limits that can be set for Loki’s distributor component: ingestion_rate_mb
and ingestion_burst_size_mb
, as defined in limits_config.
limit:
# The rate limit in lines per second that Promtail will push to Loki
[rate: <int>]
# The cap in the quantity of burst lines that Promtail will push to Loki
[burst: <int>]
# When drop is true, log lines that exceed the current rate limit will be discarded.
# When drop is false, log lines that exceed the current rate limit will only wait
# to enter the back pressure mode.
[drop: <bool> | default = false]
Examples
The following are examples showing the use of the limit
stage.
limit
Simple limit
stage configurations.
Match a line and throttle
Given the pipeline:
- limit:
rate: 10
burst: 10
Would throttle any log line.
Match a line and drop
Given the pipeline:
- limit:
rate: 10
burst: 10
drop: true
Would throttle any log line and drop logs when rate limit.