NSQ

Publish to an NSQ topic.

Common config fields

Showing common config fields and default values

   output:
   label: ""
   nsq:
   nsqd_tcp_address: "" # No default (required)
   topic: "" # No default (required)
   user_agent: "" # No default (optional)
   max_in_flight: 64 # Maximum number of messages processed concurrently

Advanced config fields

Showing all config fields and default values

   output:
   label: ""
   nsq:
   nsqd_tcp_address: "" # No default (required)
   topic: "" # No default (required)
   user_agent: "" # No default (optional)
   tls:
   enabled: false
   skip_cert_verify: false
   enable_renegotiation: false
   root_cas: ""
   root_cas_file: ""
   client_certs: []
   max_in_flight: 64

The topic field can be dynamically set using function interpolations described here. When sending batched messages these interpolations are performed per message part.

Performance

This output benefits from sending multiple messages in flight in parallel for improved performance. You can tune the max number of in flight messages (or message batches) with the field max_in_flight.

Fields

nsqd_tcp_address

The address of the target NSQD server.

Type: string

topic

The topic to publish to. This field supports interpolation functions.

Type: string

user_agent

A user agent to assume when connecting.

Type: string

tls

Custom TLS settings can be used to override system defaults.

Type: object

tls.enabled

Whether custom TLS settings are enabled.

Type: bool Default: false

tls.skip_cert_verify

Whether to skip server-side certificate verification.

Type: bool Default: false

tls.enable_renegotiation

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.

Type: bool Default: false Requires version 3.45.0 or newer

tls.root_cas

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.

Type: string Default: ""

   # Examples

   root_cas: |-
   -----BEGIN CERTIFICATE-----
   ...
   -----END CERTIFICATE-----   

tls.root_cas_file

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.

Type: string Default: ""

   # Examples

   root_cas_file: ./root_cas.pem

tls.client_certs

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.

Type: array Default: []

# Examples

client_certs:
- cert: foo
key: bar

client_certs:
- cert_file: ./example.pem
key_file: ./example.key

tls.client_certs[].cert

A plain text certificate to use.

Type: string Default: ""

tls.client_certs[].key

A plain text certificate key to use.

Type: string Default: ""

tls.client_certs[].cert_file

The path of a certificate to use.

Type: string Default: ""

tls.client_certs[].key_file

The path of a certificate key to use.

Type: string Default: ""

tls.client_certs[].password

A plain text password for when the private key is password encrypted in PKCS#1 or PKCS#8 format. The obsolete pbeWithMD5AndDES-CBC algorithm is not supported for the PKCS#8 format. Warning: Since it does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext.

Type: string Default: ""

   # Example

   password: foo

max_in_flight

The maximum number of messages to have in flight at a given time. Increase this to improve throughput.

Type: int Default: 64