Chapter 7. Configuring maximum memory usage for addresses

Procedure

1. Open the <broker_instance_dir>/etc/broker.xml configuration file.

2. Within the core element, add the paging-directory element. Specify a location for the paging directory in your file system.

   <configuration ...>
     <core ...>
       ...
       <paging-directory>/path/to/paging-directory</paging-directory>
       ...
     </core>
   </configuration>

   For each address that you subsequently configure for paging, the broker adds a dedicated directory within the paging directory that you have specified.

Procedure

1. Open the <broker_instance_dir>/etc/broker.xml configuration file.

2. For an address-setting element that you have configured for a matching address or set of addresses, add configuration elements to specify maximum memory usage and define paging behavior. For example:

   <address-settings>
       <address-setting match="my.paged.address">
           ...
           <max-size-bytes>104857600</max-size-bytes>
           <page-size-bytes>10485760</page-size-bytes>
           <address-full-policy>PAGE</address-full-policy>
           ...
       </address-setting>
   </address-settings>

   max-size-bytes

   Maximum size, in bytes, of the memory allowed for the address before the broker executes the policy specified for address-full-policy. The default value is -1, which means that there is no limit. The value that you specify also supports byte notation such as "K", "MB", and "GB".

   page-size-bytes

   Size, in bytes, of each page file used on the paging system. The default value is 10485760 (that is, 10 MiB). The value that you specify also supports byte notation such as "K", "MB", and "GB".

   address-full-policy

   Action that the broker takes when then the maximum size for an address has been reached. The default value is PAGE. Valid values are:

   PAGE

   The broker pages any further messages to disk.

   DROP

   The broker silently drops any further messages.

   FAIL

   The broker drops any further messages and issues exceptions to client message producers.

   BLOCK

   Client message producers block when they try to send further messages.

   Additional paging configuration elements that are not shown in the preceding example are described below.

   page-max-cache-size

   Number of page files that the broker keeps in memory to optimize IO during paging navigation. The default value is 5.

   page-sync-timeout

   Time, in nanoseconds, between periodic page synchronizations. If you are using an asynchronous IO journal (that is, journal-type is set to ASYNCIO in the broker.xml configuration file), the default value is 3333333. If you are using a standard Java NIO journal (that is, journal-type is set to NIO), the default value is the configured value of the journal-buffer-timeout parameter.

Procedure

1. Stop the broker.

   1. On Linux:

      <broker_instance_dir>/bin/artemis stop

   2. On Windows:

      <broker_instance_dir>\bin\artemis-service.exe stop

2. Open the <broker_instance_dir>/etc/broker.xml configuration file.

3. Within the core element, add the global-max-size element and specify a value. For example:

   <configuration>
     <core>
       ...
       <global-max-size>1GB</global-max-size>
       ...
     </core>
   </configuration>

   global-max-size

   Total amount of memory, in bytes, that the broker can use for all addresses. When this limit is reached, for the address associated with an incoming message, the broker executes the policy that is specified as a value for address-full-policy. The default value of global-max-size is half of the maximum memory available to the Java virtual machine (JVM) that is hosting the broker.

   The value for global-max-size is in bytes, but also supports byte notation (for example, "K", "Mb", "GB").

   In the preceding example, the broker is configured to use a maximum of one gigabyte of available memory when processing messages.

4. Start the broker.

   1. On Linux:

      <broker_instance_dir>/bin/artemis run

   2. On Windows:

      <broker_instance_dir>\bin\artemis-service.exe start

Procedure

1. Stop the broker.

   1. On Linux:

      <broker_instance_dir>/bin/artemis stop

   2. On Windows:

      <broker_instance_dir>\bin\artemis-service.exe stop

2. Open the <broker_instance_dir>/etc/broker.xml configuration file.

3. Within the core element add the max-disk-usage configuration element and specify a value. For example:

   <configuration>
     <core>
       ...
       <max-disk-usage>50</max-disk-usage>
       ...
     </core>
   </configuration>

   max-disk-usage

   Maximum percentage of the available disk space that the broker can use when paging messages. When this limit is reached, the broker blocks incoming messages rather than paging them. The default value is 90.

   In the preceding example, the broker is limited to using fifty percent of disk space when paging messages.

4. Start the broker.

   1. On Linux:

      <broker_instance_dir>/bin/artemis run

   2. On Windows:

      <broker_instance_dir>\bin\artemis-service.exe start

Procedure

1. Open the <broker_instance_dir>/etc/broker.xml configuration file.

2. For an address-setting element that you have configured for a matching address or set of addresses, add configuration elements to define message blocking behavior. For example:

   <address-settings>
       <address-setting match="my.blocking.address">
           ...
           <max-size-bytes>300000</max-size-bytes>
           <address-full-policy>BLOCK</address-full-policy>
           ...
       </address-setting>
   </address-settings>

   max-size-bytes

   Maximum size, in bytes, of the memory allowed for the address before the broker executes the policy specified for address-full-policy. The value that you specify also supports byte notation such as "K", "MB", and "GB".

   Note

   If you specify max-size-bytes in an address-setting element, the value applies to each matching address. Specifying this value does not mean that the total size of all matching addresses is limited to the value of max-size-bytes.

   address-full-policy

   Action that the broker takes when then the maximum size for an address has been reached.

Procedure

1. Open the <broker_instance_dir>/etc/broker.xml configuration file.

2. For an address-setting element that you have configured for a matching address or set of addresses, specify the maximum size of all AMQP messages in memory. For example:

   <address-settings>
       <address-setting match="my.amqp.blocking.address">
           ...
           <max-size-bytes-reject-threshold>300000</max-size-bytes-reject-threshold>
           ...
       </address-setting>
   </address-settings>

   max-size-bytes-reject-threshold

   Maximum size, in bytes, of the memory allowed for the address before the broker blocks further AMQP messages. The value that you specify also supports byte notation such as "K", "MB", and "GB". By default, max-size-bytes-reject-threshold is set to -1, which means that there is no maximum size.

   Note

   If you specify max-size-bytes-reject-threshold in an address-setting element, the value applies to each matching address. Specifying this value does not mean that the total size of all matching addresses is limited to the value of max-size-bytes-reject-threshold.