github.com/observiq/carbon@v0.9.11-0.20200820160507-1b872e368a5e/docs/operators/rate_limit.md (about)

     1  ## `rate_limit` operator
     2  
     3  The `rate_limit` operator limits the rate of entries that can pass through it. This is useful if you want to limit
     4  throughput of the agent, or in conjunction with operators like `generate_input`, which will otherwise
     5  send as fast as possible.
     6  
     7  ### Configuration Fields
     8  
     9  | Field      | Default          | Description                                                                        |
    10  | ---        | ---              | ---                                                                                |
    11  | `id`       | `rate_limit`     | A unique identifier for the operator                                               |
    12  | `output`   | Next in pipeline | The connected operator(s) that will receive all outbound entries                   |
    13  | `rate`     |                  | The number of logs to allow per second                                             |
    14  | `interval` |                  | A [duration](/docs/types/duration.md) that indicates the time between sent entries |
    15  | `burst`    | 0                | The max number of entries to "save up" for spikes of load                          |
    16  
    17  Exactly one of `rate` or `interval` must be specified.
    18  
    19  ### Example Configurations
    20  
    21  
    22  #### Limit throughput to 10 entries per second
    23  
    24  Configuration:
    25  ```yaml
    26  - type: rate_limit
    27    rate: 10
    28  ```