Connect

amqp_1

Available in: Self-Managed

Sends messages to an AMQP (1.0) server.

Common
Advanced

outputs:
  label: ""
  amqp_1:
    urls: [] # No default (optional)
    target_address: ""
    max_in_flight: 64
    metadata:
      exclude_prefixes: []

outputs:
  label: ""
  amqp_1:
    urls: [] # No default (optional)
    target_address: ""
    max_in_flight: 64
    tls:
      enabled: false
      skip_cert_verify: false
      enable_renegotiation: false
      root_cas: ""
      root_cas_file: ""
      client_certs: []
    application_properties_map: "" # No default (optional)
    sasl:
      mechanism: none
      user: ""
      password: ""
    metadata:
      exclude_prefixes: []
    content_type: opaque_binary
    persistent: false
    target_capabilities: [] # No default (optional)
    message_properties_to: "" # No default (optional)
    message_properties_message_id: "" # No default (optional)
    message_properties_correlation_id: "" # No default (optional)
    message_properties_subject: "" # No default (optional)
    message_properties_reply_to: "" # No default (optional)
    message_properties_group_id: "" # No default (optional)
    message_properties_group_sequence: "" # No default (optional)
    message_properties_reply_to_group_id: "" # No default (optional)
    message_properties_user_id: "" # No default (optional)
    message_properties_content_type: "" # No default (optional)
    message_properties_content_encoding: "" # No default (optional)

Metadata

Message metadata is added to each AMQP message as string annotations. To control which metadata keys are added, use the metadata configuration field.

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

`application_properties_map`

An optional Bloblang mapping that can be defined in order to set the application-properties on output messages.

Type: string

`content_type`

The content type of the message body.

Set this field value to string to transfer each message as an AMQP string. Consider using the string option if you want to write UTF-8 string messages, such as JSON messages, to your data destination.

Type: string

Default: opaque_binary

Options: opaque_binary, string

`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

`message_properties_content_encoding`

Set the content-encoding property on outgoing AMQP messages. This field supports Bloblang interpolation.

This field supports interpolation functions.

Type: string

`message_properties_content_type`

Set the content-type property on outgoing AMQP messages. This field supports Bloblang interpolation.

This field supports interpolation functions.

Type: string

# Examples:
message_properties_content_type: application/json

# ---

message_properties_content_type: text/plain; charset=utf-8

`message_properties_correlation_id`

Set the correlation-id property on outgoing AMQP messages. The value is auto-detected as UUID, uint64, or string. Purely numeric values are sent as uint64 on the wire. This field supports Bloblang interpolation.

This field supports interpolation functions.

Type: string

# Examples:
message_properties_correlation_id: ${! meta("amqp_correlation_id") }

`message_properties_group_id`

Set the group-id property on outgoing AMQP messages. This field supports Bloblang interpolation.

This field supports interpolation functions.

Type: string

`message_properties_group_sequence`

Set the group-sequence property on outgoing AMQP messages. Must be a valid uint32 value. This field supports Bloblang interpolation.

This field supports interpolation functions.

Type: string

`message_properties_message_id`

Set the message-id property on outgoing AMQP messages. The value is auto-detected as UUID, uint64, or string. Purely numeric values are sent as uint64 on the wire. This field supports Bloblang interpolation.

This field supports interpolation functions.

Type: string

# Examples:
message_properties_message_id: ${! uuid_v4() }

# ---

message_properties_message_id: ${! meta("amqp_message_id") }

`message_properties_reply_to`

Set the reply-to property on outgoing AMQP messages. This field supports Bloblang interpolation.

This field supports interpolation functions.

Type: string

`message_properties_reply_to_group_id`

Set the reply-to-group-id property on outgoing AMQP messages. This field supports Bloblang interpolation.

This field supports interpolation functions.

Type: string

`message_properties_subject`

Set the subject property on outgoing AMQP messages. This field supports Bloblang interpolation.

This field supports interpolation functions.

Type: string

`message_properties_to`

The field specifies the node that is the intended destination of the message, which may differ from the node currently receiving the transfer. This field supports Bloblang interpolation.

This field supports interpolation functions.

Type: string

# Examples:
message_properties_to: amqp://localhost:5672/

# ---

message_properties_to: ${! meta("target_address") }

`message_properties_user_id`

Set the user-id property on outgoing AMQP messages. This field supports Bloblang interpolation.

This field supports interpolation functions.

Type: string

`metadata`

Specify criteria for which metadata values are attached to messages as headers.

Type: object

`metadata.exclude_prefixes[]`

Provide a list of explicit metadata key prefixes to be excluded when adding metadata to sent messages.

Type: array

Default: []

`persistent`

If set to true, the message will be marked as persistent, ensuring it is stored durably and not lost if an intermediary (such as a broker) restarts. By default, messages are not durable.

Type: bool

Default: false

`sasl`

Enables SASL authentication.

Type: object

`sasl.mechanism`

The SASL authentication mechanism to use.

Type: string

Default: none

Option Summary

Option	Summary
`anonymous`	Anonymous SASL authentication.
`none`	No SASL based authentication.
`plain`	Plain text SASL authentication.

anonymous

Anonymous SASL authentication.

none

No SASL based authentication.

plain

Plain text SASL authentication.

`sasl.password`

A SASL plain text password. It is recommended that you use environment variables to populate this field.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

# Examples:
password: ${PASSWORD}

`sasl.user`

A SASL plain text username. It is recommended that you use environment variables to populate this field.

Type: string

Default: ""

# Examples:
user: ${USER}

`target_address`

The target address to write to. When left empty, the output uses the Anonymous Terminus pattern where the destination is specified per-message using message_properties_to.

Type: string

Default: ""

# Examples:
target_address: /foo

# ---

target_address: queue:/bar

# ---

target_address: topic:/baz

# ---

target_address:

`target_capabilities[]`

Lists the extension capabilities the sender desires from the target, such as support for queues, topics, durability, sharing, or temporary destinations.

Type: array

# Examples:
target_capabilities:
  - queue

# ---

target_capabilities:
  - topic

# ---

target_capabilities:
  - queue
  - topic

`tls`

Custom TLS settings can be used to override system defaults.

Type: object

`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: object

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[].cert_file`

The path of a certificate to use.

Type: string

Default: ""

`tls.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 Secrets.

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.

Because the obsolete pbeWithMD5AndDES-CBC algorithm does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

# Examples:
password: foo

# ---

password: ${KEY_PASSWORD}

`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.

Requires version 3.45.0 or later.

Type: bool

Default: false

`tls.enabled`

Whether custom TLS settings are enabled.

Type: bool

Default: false

`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.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

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.skip_cert_verify`

Whether to skip server side certificate verification.

Type: bool

Default: false

`urls[]`

A list of URLs to connect to. The first URL to successfully establish a connection will be used until the connection is closed. If an item of the list contains commas it will be expanded into multiple URLs.

Requires version 4.23.0 or later.

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/"

Was this helpful?

group Ask in the community

mail Share your feedback

group_add Make a contribution

What do you think of this page?

Let us know more:

Let us contact you about your feedback:

amqp_1

Metadata

Performance

Fields

application_properties_map

content_type

max_in_flight

message_properties_content_encoding

message_properties_content_type

message_properties_correlation_id

message_properties_group_id

message_properties_group_sequence

message_properties_message_id

message_properties_reply_to

message_properties_reply_to_group_id

message_properties_subject

message_properties_to

message_properties_user_id

metadata

metadata.exclude_prefixes[]

persistent

sasl

sasl.mechanism

sasl.password

sasl.user

target_address

target_capabilities[]

tls

tls.client_certs[]

tls.client_certs[].cert

tls.client_certs[].cert_file

tls.client_certs[].key

tls.client_certs[].key_file

tls.client_certs[].password

tls.enable_renegotiation

tls.enabled

tls.root_cas

tls.root_cas_file

tls.skip_cert_verify

urls[]

Simple online edits

Contribution guide

`application_properties_map`

`content_type`

`max_in_flight`

`message_properties_content_encoding`

`message_properties_content_type`

`message_properties_correlation_id`

`message_properties_group_id`

`message_properties_group_sequence`

`message_properties_message_id`

`message_properties_reply_to`

`message_properties_reply_to_group_id`

`message_properties_subject`

`message_properties_to`

`message_properties_user_id`

`metadata`

`metadata.exclude_prefixes[]`

`persistent`

`sasl`

`sasl.mechanism`

`sasl.password`

`sasl.user`

`target_address`

`target_capabilities[]`

`tls`

`tls.client_certs[]`

`tls.client_certs[].cert`

`tls.client_certs[].cert_file`

`tls.client_certs[].key`

`tls.client_certs[].key_file`

`tls.client_certs[].password`

`tls.enable_renegotiation`

`tls.enabled`

`tls.root_cas`

`tls.root_cas_file`

`tls.skip_cert_verify`

`urls[]`