20.8.10. Reference for HornetQ Configuration Attributes

The JBoss EAP 6 implementation of HornetQ exposes the following attributes for configuration. You can use the Management CLI in particular to exposure the configurable or viewable attributes with the read-resource operation.

Example 20.5. Example

[standalone@localhost:9999 /] /subsystem=messaging/hornetq-server=default:read-resource

Table 20.10. HornetQ Attributes

Attribute Default Value Type Description
allow-failback true BOOLEAN Whether this server will automatically shutdown if the original live server comes back up
async-connection-execution-enabled true BOOLEAN Whether incoming packets on the server must be handed off to a thread from the thread pool for processing
address-setting An address setting defines some attributes that are defined against an address wildcard rather than a specific queue
acceptor An acceptor defines a way in which connections can be made to the HornetQ server
backup-group-name STRING The name of a set of live/backups that must replicate with each other
backup false BOOLEAN Whether this server is a backup server
check-for-live-server false BOOLEAN Whether a replicated live server must check the current cluster to see if there is already a live server with the same node ID
clustered false BOOLEAN [Deprecated] Whether the server is clustered
cluster-password CHANGE ME!! STRING The password used by cluster connections to communicate between the clustered nodes
cluster-user HORNETQ.CLUSTER.ADMIN.USER STRING The user used by cluster connections to communicate between the clustered nodes
cluster-connection Cluster connections group servers into clusters so that messages can be load balanced between the nodes of the cluster
create-bindings-dir true BOOLEAN Whether the server must create the bindings directory on start up
create-journal-dir true BOOLEAN Whether the server must create the journal directory on start up
connection-ttl-override -1L LONG If set, this will override how long (in ms) to keep a connection alive without receiving a ping
connection-factory Defines a connection factory
connector A connector can be used by a client to define how it connects to a server
connector-service
divert A messaging resource that allows you to transparently divert messages routed to one address to some other address, without making any changes to any client application logic
discovery-group Multicast group to listen to receive broadcast from other servers announcing their connectors
failback-delay 5000 LONG How long to wait before failback occurs on live server restart
failover-on-shutdown false BOOLEAN Whether this backup server (if it is a backup server) must come live on a normal server shutdown
grouping-handler Makes decisions about which node in a cluster must handle a message with a group id assigned
id-cache-size 20000 INT The size of the cache for pre-creating message IDs
in-vm-acceptor Defines a way in which in-VM connections can be made to the HornetQ server
in-vm-connector Used by an in-VM client to define how it connects to a server
jmx-domain org.hornetq STRING The JMX domain used to register internal HornetQ MBeans in the MBeanServer
jmx-management-enabled false BOOLEAN Whether HornetQ must expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration
journal-buffer-size 501760 (490KiB) LONG The size of the internal buffer on the journal
journal-buffer-timeout 500000 (0.5 milliseconds) for ASYNCIO journal and 3333333 (3.33 milliseconds) for NIO journal LONG The timeout (in nanoseconds) used to flush internal buffers on the journal
journal-compact-min-files 10 INT The minimal number of journal data files before we can start compacting
journal-compact-percentage 30 INT The percentage of live data on which we consider compacting the journal
journal-file-size 10485760 LONG The size (in bytes) of each journal file
journal-max-io 1 INT The maximum number of write requests that can be in the AIO queue at any one time. The default value changes to 500 when ASYNCIO journal is used
journal-min-files 2 INT How many journal files to pre-create
journal-sync-non-transactional true BOOLEAN Whether to wait for non transaction data to be synced to the journal before returning a response to the client
journal-sync-transactional true BOOLEAN Whether to wait for transaction data to be synchronized to the journal before returning a response to the client
journal-type ASYNCIO String The type of journal to use. This attribute can take the values "ASYNCIO" or "NIO"
jms-topic Defines a JMS topic
live-connector-ref reference STRING [Deprecated] The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is "undefined"
log-journal-write-rate false BOOLEAN Whether to periodically log the journal's write rate and flush rate
mask-password true BOOLEAN  
management-address jms.queue.hornetq.management STRING Address to send management messages to
management-notification-address hornetq.notifications STRING The name of the address that consumers bind to in order to receive management notifications
max-saved-replicated-journal-size 2 INT The maximum number of backup journals to keep after failback occurs
memory-measure-interval -1 LONG Frequency to sample JVM memory in ms (or -1 to disable memory sampling)
memory-warning-threshold 25 INT Percentage of available memory which if exceeded results in a warning log
message-counter-enabled false BOOLEAN Whether message counters are enabled
message-counter-max-day-history 10 INT How many days to keep message counter history
message-counter-sample-period 10000 LONG The sample period (in ms) to use for message counters
message-expiry-scan-period 30000 LONG How often (in ms) to scan for expired messages
message-expiry-thread-priority 3 INT The priority of the thread expiring messages
page-max-concurrent-io 5 INT The maximum number of concurrent reads allowed on paging
perf-blast-pages -1 INT  
persist-delivery-count-before-delivery false BOOLEAN Whether the delivery count is persisted before delivery. False means that this only happens after a message has been canceled
persist-id-cache true BOOLEAN Whether IDs are persisted to the journal
persistence-enabled true BOOLEAN Whether the server will use the file based journal for persistence
pooled-connection-factory Defines a managed connection factory
remoting-interceptors undefined LIST [Deprecated] The list of interceptor classes used by this server
remoting-incoming-interceptors undefined LIST The list of incoming interceptor classes used by this server
remoting-outgoing-interceptors undefined LIST The list of outgoing interceptor classes used by this server
run-sync-speed-test false BOOLEAN Whether to perform a diagnostic test on how fast your disk can sync on startup. Useful when determining performance issues
replication-clustername STRING The name of the cluster connection to replicate from if more than one cluster connection is configured
runtime-queue A runtime queue
remote-connector Used by a remote client to define how it connects to a server
remote-acceptor Defines a way in which remote connections can be made to the HornetQ server
scheduled-thread-pool-max-size 5 INT The number of threads that the main scheduled thread pool has
security-domain other STRING The security domain to use in order to verify user and role information
security-enabled true BOOLEAN Whether security is enabled
security-setting A security setting allows sets of permissions to be defined against queues based on their address
security-invalidation-interval 10000 LONG How long (in ms) to wait before invalidating the security cache
server-dump-interval -1 LONG How often to dump basic runtime information to the server log. A value less than 1 disables this feature
shared store true BOOLEAN Whether this server is using a shared store for failover
thread-pool-max-size 30 INT The number of threads that the main thread pool has. -1 means no limit
transaction-timeout 300000 LONG How long (in ms) before a transaction can be removed from the resource manager after create time
transaction-timeout-scan-period 1000 LONG How often (in ms) to scan for timeout transactions
wild-card-routing-enabled true BOOLEAN Whether the server supports wild card routing

Warning

The value of journal-file-size must be higher than the size of message sent to server, or the server will not be able to store the message.