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

     1  ---
     2  title: dynamic
     3  type: output
     4  status: stable
     5  categories: ["Utility"]
     6  ---
     7  
     8  <!--
     9       THIS FILE IS AUTOGENERATED!
    10  
    11       To make changes please edit the contents of:
    12       lib/output/dynamic.go
    13  -->
    14  
    15  import Tabs from '@theme/Tabs';
    16  import TabItem from '@theme/TabItem';
    17  
    18  
    19  A special broker type where the outputs are identified by unique labels and can
    20  be created, changed and removed during runtime via a REST API.
    21  
    22  ```yaml
    23  # Config fields, showing default values
    24  output:
    25    label: ""
    26    dynamic:
    27      outputs: {}
    28      prefix: ""
    29      timeout: 5s
    30      max_in_flight: 1
    31  ```
    32  
    33  The broker pattern used is always `fan_out`, meaning each message will
    34  be delivered to each dynamic output.
    35  
    36  To GET a JSON map of output identifiers with their current uptimes use the
    37  '/outputs' endpoint.
    38  
    39  To perform CRUD actions on the outputs themselves use POST, DELETE, and GET
    40  methods on the `/outputs/{output_id}` endpoint. When using POST the
    41  body of the request should be a YAML configuration for the output, if the output
    42  already exists it will be changed.
    43  
    44  ## Fields
    45  
    46  ### `outputs`
    47  
    48  A map of outputs to statically create.
    49  
    50  
    51  Type: `object`  
    52  Default: `{}`  
    53  
    54  ### `prefix`
    55  
    56  A path prefix for HTTP endpoints that are registered.
    57  
    58  
    59  Type: `string`  
    60  Default: `""`  
    61  
    62  ### `timeout`
    63  
    64  The server side timeout of HTTP requests.
    65  
    66  
    67  Type: `string`  
    68  Default: `"5s"`  
    69  
    70  ### `max_in_flight`
    71  
    72  The maximum number of messages to dispatch across child outputs at any given time.
    73  
    74  
    75  Type: `int`  
    76  Default: `1`  
    77  
    78