amqp_0_9
Connects to an AMQP (0.91) queue. AMQP is a messaging protocol used by various message brokers, including RabbitMQ.
-
Common
-
Advanced
# Common configuration fields, showing default values
input:
label: ""
amqp_0_9:
urls: [] # No default (required)
queue: "" # No default (required)
consumer_tag: "" # Optional
prefetch_count: 10# All configuration fields, showing default values
input:
label: ""
amqp_0_9:
urls: [] # No default (required)
queue: "" # No default (required)
queue_declare:
enabled: false
durable: true
auto_delete: false
arguments: {} # No default (optional)
bindings_declare: [] # No default (optional)
consumer_tag: "" # Optional
auto_ack: false
nack_reject_patterns: []
prefetch_count: 10
prefetch_size: 0
tls:
enabled: false
skip_cert_verify: false
enable_renegotiation: false
root_cas: "" # Optional
root_cas_file: "" # Optional
client_certs: []TLS is automatically enabled when connecting to an amqps URL. However, you can customize TLS settings if required.
Metadata
This input adds the following metadata fields to each message:
-
amqp_content_type -
amqp_content_encoding -
amqp_delivery_mode -
amqp_priority -
amqp_correlation_id -
amqp_reply_to -
amqp_expiration -
amqp_message_id -
amqp_timestamp -
amqp_type -
amqp_user_id -
amqp_app_id -
amqp_consumer_tag -
amqp_delivery_tag -
amqp_redelivered -
amqp_exchange -
amqp_routing_key -
All existing message headers, including nested headers prefixed with the key of their respective parent.
You can access these metadata fields using function interpolations.
Fields
urls
A list of URLs to connect to. This input attempts to connect to each URL in the list, in order, until a successful connection is established. It then continues to use that URL until the connection is closed.
If an item in the list contains commas, it is split into multiple URLs.
Type: array
# Examples
urls:
- amqp://guest:guest@127.0.0.1:5672/
urls:
- amqp://127.0.0.1:5672/,amqp://127.0.0.2:5672/
urls:
- amqp://127.0.0.1:5672/
- amqp://127.0.0.2:5672/queue_declare
Passively declares the target queue to make sure a queue with the specified name exists and is configured correctly. If the queue exists, then the passive declaration verifies that fields specified in this object match the its properties.
Type: object
queue_declare.auto_delete
Whether the declared queue auto-deletes when there are no active consumers.
Type: bool
Default: false
queue_declare.arguments
Arguments for server-specific implementations of the queue (optional). You can use arguments to configure additional parameters for queue types that require them. For more information about available arguments, see the RabbitMQ Client Library.
Type: object
# Examples
arguments:
x-max-length: 1000
x-max-length-bytes: 4096
x-queue-type: quorum| Argument | Description | Accepted values |
|---|---|---|
|
Declares the type of queue. |
Options: |
|
The maximum number of messages in the queue. |
A non-negative integer. |
|
The maximum size of messages (in bytes) in the queue. |
A non-negative integer. |
|
Sets the queue’s overflow behavior. |
Options: |
|
The duration (in milliseconds) that messages remain in the queue before they expire and are discarded. |
A string that represents the number of milliseconds. For example, |
|
The duration after which the queue automatically expires. |
A positive integer. |
|
The duration (in configurable units) that streamed messages are retained on disk before they are discarded. |
Options: |
|
The maximum size (in bytes) of the segment files held on disk. |
A positive integer. Default: |
|
The version of the classic queue to use. |
Options: |
|
The duration (in milliseconds) that a consumer can remain idle before it is automatically canceled. |
A positive integer that represents the number of milliseconds. For example, |
|
When set to |
A boolean. |
bindings_declare
Passively declares the bindings of the target queue to make sure they exist and are configured correctly. If the bindings exist, then the passive declaration verifies that fields specified in this object match them.
Type: array
# Examples
bindings_declare:
- exchange: my_exchange
key: my_routing_keyauto_ack
Set to true to automatically acknowledge messages as soon as they are consumed rather than waiting for acknowledgments from downstream. This can improve throughput and prevent the pipeline from becoming blocked, but delivery guarantees are lost.
Type: bool
Default: false
nack_reject_patterns
A list of regular expression patterns to match against errors in messages that Redpanda Connect fails to deliver. When a message has an error that matches a pattern, it is dropped or delivered to a dead-letter queue (if a queue has been configured).
By default, failed messages are negatively acknowledged (nacked) and requeued.
Type: array
Default: []
# Examples
nack_reject_patterns:
- ^reject me please:.+$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
tls.root_cas
Specify a certificate authority to use (optional). This is a string that represents a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate.
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. |
Type: string
Default: ""
# Examples
root_cas: |-
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----tls.root_cas_file
Specify the path to a root certificate authority file (optional). This is a file, often with a .pem extension, that contains a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate.
Type: string
Default: ""
# Examples
root_cas_file: ./root_cas.pemtls.client_certs
A list of client certificates to use. For each certificate, specify values for either the cert and key fields, or the cert_file and key_file fields.
Type: array
Default: []
# Examples
client_certs:
- cert: foo
key: bar
client_certs:
- cert_file: ./example.pem
key_file: ./example.keytls.client_certs[].key
A plain text certificate key to use.
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. |
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.
The pbeWithMD5AndDES-CBC algorithm does not authenticate ciphertext, and is vulnerable to padding oracle attacks, which may allow an attacker to recover the plain text password.
|
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. |
Type: string
Default: ""
# Examples
password: foo
password: ${KEY_PASSWORD}
