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

     1  ---
     2  title: hash_sample
     3  type: processor
     4  status: deprecated
     5  ---
     6  
     7  <!--
     8       THIS FILE IS AUTOGENERATED!
     9  
    10       To make changes please edit the contents of:
    11       lib/processor/hash_sample.go
    12  -->
    13  
    14  import Tabs from '@theme/Tabs';
    15  import TabItem from '@theme/TabItem';
    16  
    17  :::warning DEPRECATED
    18  This component is deprecated and will be removed in the next major version release. Please consider moving onto [alternative components](#alternatives).
    19  :::
    20  
    21  
    22  <Tabs defaultValue="common" values={[
    23    { label: 'Common', value: 'common', },
    24    { label: 'Advanced', value: 'advanced', },
    25  ]}>
    26  
    27  <TabItem value="common">
    28  
    29  ```yaml
    30  # Common config fields, showing default values
    31  label: ""
    32  hash_sample:
    33    retain_min: 0
    34    retain_max: 10
    35  ```
    36  
    37  </TabItem>
    38  <TabItem value="advanced">
    39  
    40  ```yaml
    41  # All config fields, showing default values
    42  label: ""
    43  hash_sample:
    44    retain_min: 0
    45    retain_max: 10
    46    parts:
    47      - 0
    48  ```
    49  
    50  </TabItem>
    51  </Tabs>
    52  
    53  ## Fields
    54  
    55  ### `retain_min`
    56  
    57  The lower percentage of the sample range.
    58  
    59  
    60  Type: `int`  
    61  Default: `0`  
    62  
    63  ### `retain_max`
    64  
    65  The upper percentage of the sample range.
    66  
    67  
    68  Type: `int`  
    69  Default: `10`  
    70  
    71  ### `parts`
    72  
    73  An array of message indexes within the batch to sample based on. If left empty all messages are included. This field is only applicable when batching messages [at the input level](/docs/configuration/batching).
    74  
    75  
    76  Type: `array`  
    77  Default: `[0]`  
    78  
    79  ## Alternatives
    80  
    81  All functionality of this processor has been superseded by the
    82  [bloblang](/docs/components/processors/bloblang) processor.
    83