Appendix B. Address Setting Configuration Elements
Appendix B. Address Setting Configuration Elements The table below lists all of the configuration elements of an address-setting . Note that some elements are marked DEPRECATED. Use the suggested replacement to avoid potential issues. Table B.1. Address Setting Elements Name Description address-full-policy Determines what happens when an address configured with a max-size-bytes becomes full. The available policies are: PAGE : messages sent to a full address will be paged to disk. DROP : messages sent to a full address will be silently dropped. FAIL : messages sent to a full address will be dropped and the message producers will receive an exception. BLOCK : message producers will block when they try and send any further messages. Note The BLOCK policy works only for the AMQP, OpenWire, and Core Protocol protocols because they feature flow control. auto-create-addresses Whether to automatically create addresses when a client sends a message to or attempts to consume a message from a queue mapped to an address that does not exist a queue. The default value is true . auto-create-dead-letter-resources Specifies whether the broker automatically creates a dead letter address and queue to receive undelivered messages. The default value is false . If the parameter is set to true , the broker automatically creates an <address> element that defines a dead letter address and an associated dead letter queue. The name of the automatically-created <address> element matches the name value that you specify for <dead-letter-address> . auto-create-jms-queues DEPRECATED: Use auto-create-queues instead. Determines whether this broker should automatically create a JMS queue corresponding to the address settings match when a JMS producer or a consumer tries to use such a queue. The default value is false . auto-create-jms-topics DEPRECATED: Use auto-create-queues instead. Determines whether this broker should automatically create a JMS topic corresponding to the address settings match when a JMS producer or a consumer tries to use such a queue. The default value is false . auto-create-queues Whether to automatically create a queue when a client sends a message to or attempts to consume a message from a queue. The default value is true . auto-delete-addresses Whether to delete auto-created addresses when the broker no longer has any queues. The default value is true . auto-delete-jms-queues DEPRECATED: Use auto-delete-queues instead. Determines whether AMQ Broker should automatically delete auto-created JMS queues when they have no consumers and no messages. The default value is false . auto-delete-jms-topics DEPRECATED: Use auto-delete-queues instead. Determines whether AMQ Broker should automatically delete auto-created JMS topics when they have no consumers and no messages. The default value is false . auto-delete-queues Whether to delete auto-created queues when the queue has no consumers and no messages. The default value is true . config-delete-addresses When the configuration file is reloaded, this setting specifies how to handle an address (and its queues) that has been deleted from the configuration file. You can specify the following values: OFF (default) The address is not deleted when the configuration file is reloaded. FORCE The address and its queues are deleted when the configuration file is reloaded. If there are any messages in the queues, they are removed also. config-delete-queues When the configuration file is reloaded, this setting specifies how to handle queues that have been deleted from the configuration file. You can specify the following values: OFF (default) The queue is not deleted when the configuration file is reloaded. FORCE The queue is deleted when the configuration file is reloaded. If there are any messages in the queue, they are removed also. dead-letter-address The address to which the broker sends dead messages. dead-letter-queue-prefix Prefix that the broker applies to the name of an automatically-created dead letter queue. The default value is DLQ. dead-letter-queue-suffix Suffix that the broker applies to an automatically-created dead letter queue. The default value is not defined (that is, the broker applies no suffix). default-address-routing-type The routing-type used on auto-created addresses. The default value is MULTICAST . default-max-consumers The maximum number of consumers allowed on this queue at any one time. The default value is 200 . default-purge-on-no-consumers Whether to purge the contents of the queue once there are no consumers. The default value is false . default-queue-routing-type The routing-type used on auto-created queues. The default value is MULTICAST . enable-metrics Specifies whether a configured metrics plugin such as the Prometheus plugin collects metrics for a matching address or set of addresses. The default value is true . expiry-address The address that will receive expired messages. expiry-delay Defines the expiration time in milliseconds that will be used for messages using the default expiration time. The default value is -1 , which is means no expiration time. last-value-queue Whether a queue uses only last values or not. The default value is false . management-browse-page-size How many messages a management resource can browse. The default value is 200 . max-delivery-attempts how many times to attempt to deliver a message before sending to dead letter address. The default is 10 . max-redelivery-delay Maximum value for the redelivery-delay, in milliseconds. max-size-bytes The maximum memory size for this address, specified in bytes. Used when the address-full-policy is PAGING , BLOCK , or FAIL , this value is specified in byte notation such as "K", "Mb", and "GB". The default value is -1 , which denotes infinite bytes. This parameter is used to protect broker memory by limiting the amount of memory consumed by a particular address space. This setting does not represent the total amount of bytes sent by the client that are currently stored in broker address space. It is an estimate of broker memory utilization. This value can vary depending on runtime conditions and certain workloads. It is recommended that you allocate the maximum amount of memory that can be afforded per address space. Under typical workloads, the broker requires approximately 150% to 200% of the payload size of the outstanding messages in memory. max-size-bytes-reject-threshold Used when the address-full-policy is BLOCK . The maximum size, in bytes, that an address can reach before the broker begins to reject messages. Works in combination with max-size-bytes for the AMQP protocol only. The default value is -1 , which means no limit. message-counter-history-day-limit How many days to keep a message counter history for this address. The default value is 0 . page-size-bytes The paging size in bytes. Also supports byte notation like K , Mb , and GB . The default value is 10485760 bytes, almost 10.5 MB. redelivery-delay The time, in milliseconds, to wait before redelivering a cancelled message. The default value is 0 . redelivery-delay-multiplier Multiplier to apply to the redelivery-delay parameter. The default value is 1.0 . redistribution-delay Defines how long to wait in milliseconds after the last consumer is closed on a queue before redistributing any messages. The default value is -1 . send-to-dla-on-no-route When set to true , a message will be sent to the configured dead letter address if it cannot be routed to any queues. The default value is false . slow-consumer-check-period How often to check, in seconds, for slow consumers. The default value is 5 . slow-consumer-policy Determines what happens when a slow consumer is identified. Valid options are KILL or NOTIFY . KILL kills the consumer's connection, which impacts any client threads using that same connection. NOTIFY sends a CONSUMER_SLOW management notification to the client. The default value is NOTIFY . slow-consumer-threshold The minimum rate of message consumption allowed before a consumer is considered slow. Measured in messages-per-second. The default value is -1 , which is unbounded.