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

     1  ---
     2  title: nsq
     3  type: output
     4  status: stable
     5  categories: ["Services"]
     6  ---
     7  
     8  <!--
     9       THIS FILE IS AUTOGENERATED!
    10  
    11       To make changes please edit the contents of:
    12       lib/output/nsq.go
    13  -->
    14  
    15  import Tabs from '@theme/Tabs';
    16  import TabItem from '@theme/TabItem';
    17  
    18  
    19  Publish to an NSQ topic.
    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  output:
    32    label: ""
    33    nsq:
    34      nsqd_tcp_address: localhost:4150
    35      topic: benthos_messages
    36      user_agent: benthos_producer
    37      max_in_flight: 1
    38  ```
    39  
    40  </TabItem>
    41  <TabItem value="advanced">
    42  
    43  ```yaml
    44  # All config fields, showing default values
    45  output:
    46    label: ""
    47    nsq:
    48      nsqd_tcp_address: localhost:4150
    49      topic: benthos_messages
    50      user_agent: benthos_producer
    51      tls:
    52        enabled: false
    53        skip_cert_verify: false
    54        enable_renegotiation: false
    55        root_cas: ""
    56        root_cas_file: ""
    57        client_certs: []
    58      max_in_flight: 1
    59  ```
    60  
    61  </TabItem>
    62  </Tabs>
    63  
    64  The `topic` field can be dynamically set using function interpolations
    65  described [here](/docs/configuration/interpolation#bloblang-queries). When sending
    66  batched messages these interpolations are performed per message part.
    67  
    68  ## Performance
    69  
    70  This output benefits from sending multiple messages in flight in parallel for
    71  improved performance. You can tune the max number of in flight messages with the
    72  field `max_in_flight`.
    73  
    74  ## Fields
    75  
    76  ### `nsqd_tcp_address`
    77  
    78  The address of the target NSQD server.
    79  
    80  
    81  Type: `string`  
    82  Default: `"localhost:4150"`  
    83  
    84  ### `topic`
    85  
    86  The topic to publish to.
    87  This field supports [interpolation functions](/docs/configuration/interpolation#bloblang-queries).
    88  
    89  
    90  Type: `string`  
    91  Default: `"benthos_messages"`  
    92  
    93  ### `user_agent`
    94  
    95  A user agent string to connect with.
    96  
    97  
    98  Type: `string`  
    99  Default: `"benthos_producer"`  
   100  
   101  ### `tls`
   102  
   103  Custom TLS settings can be used to override system defaults.
   104  
   105  
   106  Type: `object`  
   107  
   108  ### `tls.enabled`
   109  
   110  Whether custom TLS settings are enabled.
   111  
   112  
   113  Type: `bool`  
   114  Default: `false`  
   115  
   116  ### `tls.skip_cert_verify`
   117  
   118  Whether to skip server side certificate verification.
   119  
   120  
   121  Type: `bool`  
   122  Default: `false`  
   123  
   124  ### `tls.enable_renegotiation`
   125  
   126  Whether to allow the remote server to repeatedly request renegotiation. Enable this option if you're seeing the error message `local error: tls: no renegotiation`.
   127  
   128  
   129  Type: `bool`  
   130  Default: `false`  
   131  Requires version 3.45.0 or newer  
   132  
   133  ### `tls.root_cas`
   134  
   135  An optional root certificate authority to use. This is a string, representing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate.
   136  
   137  
   138  Type: `string`  
   139  Default: `""`  
   140  
   141  ```yaml
   142  # Examples
   143  
   144  root_cas: |-
   145    -----BEGIN CERTIFICATE-----
   146    ...
   147    -----END CERTIFICATE-----
   148  ```
   149  
   150  ### `tls.root_cas_file`
   151  
   152  An optional path of a root certificate authority file to use. This is a file, often with a .pem extension, containing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate.
   153  
   154  
   155  Type: `string`  
   156  Default: `""`  
   157  
   158  ```yaml
   159  # Examples
   160  
   161  root_cas_file: ./root_cas.pem
   162  ```
   163  
   164  ### `tls.client_certs`
   165  
   166  A list of client certificates to use. For each certificate either the fields `cert` and `key`, or `cert_file` and `key_file` should be specified, but not both.
   167  
   168  
   169  Type: `array`  
   170  Default: `[]`  
   171  
   172  ```yaml
   173  # Examples
   174  
   175  client_certs:
   176    - cert: foo
   177      key: bar
   178  
   179  client_certs:
   180    - cert_file: ./example.pem
   181      key_file: ./example.key
   182  ```
   183  
   184  ### `tls.client_certs[].cert`
   185  
   186  A plain text certificate to use.
   187  
   188  
   189  Type: `string`  
   190  Default: `""`  
   191  
   192  ### `tls.client_certs[].key`
   193  
   194  A plain text certificate key to use.
   195  
   196  
   197  Type: `string`  
   198  Default: `""`  
   199  
   200  ### `tls.client_certs[].cert_file`
   201  
   202  The path to a certificate to use.
   203  
   204  
   205  Type: `string`  
   206  Default: `""`  
   207  
   208  ### `tls.client_certs[].key_file`
   209  
   210  The path of a certificate key to use.
   211  
   212  
   213  Type: `string`  
   214  Default: `""`  
   215  
   216  ### `max_in_flight`
   217  
   218  The maximum number of messages to have in flight at a given time. Increase this to improve throughput.
   219  
   220  
   221  Type: `int`  
   222  Default: `1`  
   223  
   224