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

     1  ---
     2  title: nsq
     3  type: input
     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/input/nsq.go
    13  -->
    14  
    15  import Tabs from '@theme/Tabs';
    16  import TabItem from '@theme/TabItem';
    17  
    18  
    19  Subscribe to an NSQ instance topic and channel.
    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  input:
    32    label: ""
    33    nsq:
    34      nsqd_tcp_addresses:
    35        - localhost:4150
    36      lookupd_http_addresses:
    37        - localhost:4161
    38      topic: benthos_messages
    39      channel: benthos_stream
    40      user_agent: benthos_consumer
    41      max_in_flight: 100
    42  ```
    43  
    44  </TabItem>
    45  <TabItem value="advanced">
    46  
    47  ```yaml
    48  # All config fields, showing default values
    49  input:
    50    label: ""
    51    nsq:
    52      nsqd_tcp_addresses:
    53        - localhost:4150
    54      lookupd_http_addresses:
    55        - localhost:4161
    56      tls:
    57        enabled: false
    58        skip_cert_verify: false
    59        enable_renegotiation: false
    60        root_cas: ""
    61        root_cas_file: ""
    62        client_certs: []
    63      topic: benthos_messages
    64      channel: benthos_stream
    65      user_agent: benthos_consumer
    66      max_in_flight: 100
    67  ```
    68  
    69  </TabItem>
    70  </Tabs>
    71  
    72  ## Fields
    73  
    74  ### `nsqd_tcp_addresses`
    75  
    76  A list of nsqd addresses to connect to.
    77  
    78  
    79  Type: `array`  
    80  Default: `["localhost:4150"]`  
    81  
    82  ### `lookupd_http_addresses`
    83  
    84  A list of nsqlookupd addresses to connect to.
    85  
    86  
    87  Type: `array`  
    88  Default: `["localhost:4161"]`  
    89  
    90  ### `tls`
    91  
    92  Custom TLS settings can be used to override system defaults.
    93  
    94  
    95  Type: `object`  
    96  
    97  ### `tls.enabled`
    98  
    99  Whether custom TLS settings are enabled.
   100  
   101  
   102  Type: `bool`  
   103  Default: `false`  
   104  
   105  ### `tls.skip_cert_verify`
   106  
   107  Whether to skip server side certificate verification.
   108  
   109  
   110  Type: `bool`  
   111  Default: `false`  
   112  
   113  ### `tls.enable_renegotiation`
   114  
   115  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`.
   116  
   117  
   118  Type: `bool`  
   119  Default: `false`  
   120  Requires version 3.45.0 or newer  
   121  
   122  ### `tls.root_cas`
   123  
   124  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.
   125  
   126  
   127  Type: `string`  
   128  Default: `""`  
   129  
   130  ```yaml
   131  # Examples
   132  
   133  root_cas: |-
   134    -----BEGIN CERTIFICATE-----
   135    ...
   136    -----END CERTIFICATE-----
   137  ```
   138  
   139  ### `tls.root_cas_file`
   140  
   141  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.
   142  
   143  
   144  Type: `string`  
   145  Default: `""`  
   146  
   147  ```yaml
   148  # Examples
   149  
   150  root_cas_file: ./root_cas.pem
   151  ```
   152  
   153  ### `tls.client_certs`
   154  
   155  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.
   156  
   157  
   158  Type: `array`  
   159  Default: `[]`  
   160  
   161  ```yaml
   162  # Examples
   163  
   164  client_certs:
   165    - cert: foo
   166      key: bar
   167  
   168  client_certs:
   169    - cert_file: ./example.pem
   170      key_file: ./example.key
   171  ```
   172  
   173  ### `tls.client_certs[].cert`
   174  
   175  A plain text certificate to use.
   176  
   177  
   178  Type: `string`  
   179  Default: `""`  
   180  
   181  ### `tls.client_certs[].key`
   182  
   183  A plain text certificate key to use.
   184  
   185  
   186  Type: `string`  
   187  Default: `""`  
   188  
   189  ### `tls.client_certs[].cert_file`
   190  
   191  The path to a certificate to use.
   192  
   193  
   194  Type: `string`  
   195  Default: `""`  
   196  
   197  ### `tls.client_certs[].key_file`
   198  
   199  The path of a certificate key to use.
   200  
   201  
   202  Type: `string`  
   203  Default: `""`  
   204  
   205  ### `topic`
   206  
   207  The topic to consume from.
   208  
   209  
   210  Type: `string`  
   211  Default: `"benthos_messages"`  
   212  
   213  ### `channel`
   214  
   215  The channel to consume from.
   216  
   217  
   218  Type: `string`  
   219  Default: `"benthos_stream"`  
   220  
   221  ### `user_agent`
   222  
   223  A user agent to assume when connecting.
   224  
   225  
   226  Type: `string`  
   227  Default: `"benthos_consumer"`  
   228  
   229  ### `max_in_flight`
   230  
   231  The maximum number of pending messages to consume at any given time.
   232  
   233  
   234  Type: `int`  
   235  Default: `100`  
   236  
   237