github.com/Jeffail/benthos/v3@v3.65.0/website/docs/components/processors/throttle.md (about)

     1  ---
     2  title: throttle
     3  type: processor
     4  status: deprecated
     5  categories: ["Utility"]
     6  ---
     7  
     8  <!--
     9       THIS FILE IS AUTOGENERATED!
    10  
    11       To make changes please edit the contents of:
    12       lib/processor/throttle.go
    13  -->
    14  
    15  import Tabs from '@theme/Tabs';
    16  import TabItem from '@theme/TabItem';
    17  
    18  :::warning DEPRECATED
    19  This component is deprecated and will be removed in the next major version release. Please consider moving onto [alternative components](#alternatives).
    20  :::
    21  
    22  Throttles the throughput of a pipeline to a maximum of one message batch per
    23  period. This throttle is per processing pipeline, and therefore four threads
    24  each with a throttle would result in four times the rate specified.
    25  
    26  ```yaml
    27  # Config fields, showing default values
    28  label: ""
    29  throttle:
    30    period: 100us
    31  ```
    32  
    33  The period should be specified as a time duration string. For example, '1s'
    34  would be 1 second, '10ms' would be 10 milliseconds, etc.
    35  
    36  ### Alternatives
    37  
    38  It's recommended that you use the [`rate_limit` processor](/docs/components/processors/rate_limit) instead.
    39  
    40  ## Fields
    41  
    42  ### `period`
    43  
    44  The period to throttle to.
    45  
    46  
    47  Type: `string`  
    48  Default: `"100us"`  
    49  
    50