Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

Whether a health check is published in case the smallrye-health extension is present.

This is a global setting and is not specific to a datasource.

Environment variable: QUARKUS_ARTEMIS_HEALTH_ENABLED

boolean

Whether configurations (org.apache.activemq.artemis.api.core.client.ServerLocator`s in case of the `artemis-core extension, jakarta.jms.ConnectionFactory`s in case of the `artemis-jms extension) should be included in the health check. Defaults to true if not set.

Environment variable: QUARKUS_ARTEMIS_HEALTH_EXTERNAL_ENABLED

boolean

Whether failed health checks should report the stack trace via a log.

Environment variable: QUARKUS_ARTEMIS_HEALTH_FAIL_LOG

boolean

true

The log level for the stack trace of a failed health check.

If the log level is not enabled, the health check will only report "DOWN".

If the log level is enabled,

  • the health check will report "DOWN, see error-id <id>" and

  • the stack trace is logged on the defined log level. The log will contain the error-id <id> in the log message and in the MDC.

Environment variable: QUARKUS_ARTEMIS_HEALTH_FAIL_LOG_LEVEL

fatal, error, warn, info, debug, trace

info

Configurations

Type

Default

quarkus.artemis."configuration-name".enabled

Whether to enable this configuration.

Is enabled by default.

Environment variable: QUARKUS_ARTEMIS_ENABLED

boolean

quarkus.artemis."configuration-name".devservices.enabled

Enable or disable Dev Services explicitly. Dev Services are automatically enabled unless quarkus.artemis.url is set.

Environment variable: QUARKUS_ARTEMIS_DEVSERVICES_ENABLED

boolean

quarkus.artemis."configuration-name".devservices.port

Optional fixed port the dev service will listen to.

If not defined, the port will be chosen randomly.

Environment variable: QUARKUS_ARTEMIS_DEVSERVICES_PORT

int

quarkus.artemis."configuration-name".devservices.web-ui-port

Optional fixed port the Artemis Web-Ui will be exposed at.

If not defined, the Artemis Web-Ui port will be chosen randomly.

Environment variable: QUARKUS_ARTEMIS_DEVSERVICES_WEB_UI_PORT

int

quarkus.artemis."configuration-name".devservices.image-name

The ActiveMQ Artemis container image to use.

Defaults to quay.io/arkmq-org/activemq-artemis-broker:artemis.2.52.0

Environment variable: QUARKUS_ARTEMIS_DEVSERVICES_IMAGE_NAME

string

quarkus.artemis."configuration-name".devservices.shared

Indicates if the ActiveMQ Artemis broker managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for ActiveMQ Artemis starts a new container. Is activated by default when not set.

The discovery uses the quarkus-dev-service-artemis label. The value is configured using the service-name property.

Container sharing is only used in dev mode.

Environment variable: QUARKUS_ARTEMIS_DEVSERVICES_SHARED

boolean

quarkus.artemis."configuration-name".devservices.service-name

The value of the quarkus-dev-service-artemis label attached to the started container. This property is used when shared is set to true. It defaults to artemis when not set. In this case, before starting a container, Dev Services for ActiveMQ Artemis looks for a container with the quarkus-dev-service-artemis label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the quarkus-dev-service-artemis label set to the specified value.

This property is used when you need multiple shared ActiveMQ Artemis brokers.

Environment variable: QUARKUS_ARTEMIS_DEVSERVICES_SERVICE_NAME

string

quarkus.artemis."configuration-name".devservices.user

User to start artemis broker. Defaults to admin if not set.

Environment variable: QUARKUS_ARTEMIS_DEVSERVICES_USER

string

quarkus.artemis."configuration-name".devservices.password

Password to start artemis broker. Defaults to admin when not set.

Environment variable: QUARKUS_ARTEMIS_DEVSERVICES_PASSWORD

string

quarkus.artemis."configuration-name".devservices.extra-args

Value to pass into the AMQ_EXTRA_ARGS environment variable in the container. Values wil be augmented with those provided in defaultExtraArgs

Environment variable: QUARKUS_ARTEMIS_DEVSERVICES_EXTRA_ARGS

string

quarkus.artemis."configuration-name".devservices.default-extra-args

Default values to be merged with those provided in extraArgs. It’s recommended to only overwrite this if one of the below listed default arguments needs to be unset, otherwise the extraArgs option should be used.

Defaults to --no-autotune --mapped --no-fsync --relax-jolokia when not set.

Environment variable: QUARKUS_ARTEMIS_DEVSERVICES_DEFAULT_EXTRA_ARGS

string

quarkus.artemis."configuration-name".xa-enabled

Support to expose jakarta.jms.XAConnectionFactory. Is not activated by default.

Environment variable: QUARKUS_ARTEMIS_XA_ENABLED

boolean

quarkus.artemis."configuration-name".url

Artemis connection url.

Environment variable: QUARKUS_ARTEMIS_URL

string

quarkus.artemis."configuration-name".username

Username for authentication, only used with JMS.

Environment variable: QUARKUS_ARTEMIS_USERNAME

string

quarkus.artemis."configuration-name".password

Password for authentication, only used with JMS.

Environment variable: QUARKUS_ARTEMIS_PASSWORD

string

quarkus.artemis."configuration-name".health-exclude

Whether this particular data source should be excluded from the health check if the general health check for data sources is enabled.

By default, the health check includes all configured data sources (if it is enabled).

Environment variable: QUARKUS_ARTEMIS_HEALTH_EXCLUDE

boolean

quarkus.artemis."configuration-name".consumer-window-size

The window size for consumer flow control in bytes.

Environment variable: QUARKUS_ARTEMIS_CONSUMER_WINDOW_SIZE

int

quarkus.artemis."configuration-name".consumer-max-rate

The maximum rate of messages consumed per second.

Environment variable: QUARKUS_ARTEMIS_CONSUMER_MAX_RATE

int

quarkus.artemis."configuration-name".producer-window-size

The window size for producer flow control in bytes.

Environment variable: QUARKUS_ARTEMIS_PRODUCER_WINDOW_SIZE

int

quarkus.artemis."configuration-name".producer-max-rate

The maximum rate of messages produced per second.

Environment variable: QUARKUS_ARTEMIS_PRODUCER_MAX_RATE

int

quarkus.artemis."configuration-name".confirmation-window-size

The window size for confirmation of sent messages in bytes.

Environment variable: QUARKUS_ARTEMIS_CONFIRMATION_WINDOW_SIZE

int

quarkus.artemis."configuration-name".min-large-message-size

The threshold in bytes for treating a message as a large message.

Environment variable: QUARKUS_ARTEMIS_MIN_LARGE_MESSAGE_SIZE

int

quarkus.artemis."configuration-name".compress-large-message

Whether to compress large messages sent to the server.

Environment variable: QUARKUS_ARTEMIS_COMPRESS_LARGE_MESSAGE

boolean

quarkus.artemis."configuration-name".compression-level

The compression level to use (0-9).

Environment variable: QUARKUS_ARTEMIS_COMPRESSION_LEVEL

int

quarkus.artemis."configuration-name".cache-large-messages-client

Whether to cache large messages on the client side.

Environment variable: QUARKUS_ARTEMIS_CACHE_LARGE_MESSAGES_CLIENT

boolean

quarkus.artemis."configuration-name".client-failure-check-period

The frequency (ms) to check for client failure.

Environment variable: QUARKUS_ARTEMIS_CLIENT_FAILURE_CHECK_PERIOD

long

quarkus.artemis."configuration-name".connection-ttl

How long (ms) to keep a connection alive without receiving a packet.

Environment variable: QUARKUS_ARTEMIS_CONNECTION_TTL

long

quarkus.artemis."configuration-name".call-timeout

Total time (ms) to wait for a blocking call to complete.

Environment variable: QUARKUS_ARTEMIS_CALL_TIMEOUT

long

quarkus.artemis."configuration-name".call-failover-timeout

Total time (ms) to wait for a call during failover.

Environment variable: QUARKUS_ARTEMIS_CALL_FAILOVER_TIMEOUT

long

quarkus.artemis."configuration-name".use-global-pools

Whether to use global thread pools.

Environment variable: QUARKUS_ARTEMIS_USE_GLOBAL_POOLS

boolean

quarkus.artemis."configuration-name".scheduled-thread-pool-max-size

The maximum size of the scheduled thread pool.

Environment variable: QUARKUS_ARTEMIS_SCHEDULED_THREAD_POOL_MAX_SIZE

int

quarkus.artemis."configuration-name".thread-pool-max-size

The maximum size of the general purpose thread pool.

Environment variable: QUARKUS_ARTEMIS_THREAD_POOL_MAX_SIZE

int

quarkus.artemis."configuration-name".reconnect-attempts

Maximum number of reconnection attempts. Use -1 for infinite.

Environment variable: QUARKUS_ARTEMIS_RECONNECT_ATTEMPTS

int

quarkus.artemis."configuration-name".initial-connect-attempts

Reconnection attempts for the initial connection.

Environment variable: QUARKUS_ARTEMIS_INITIAL_CONNECT_ATTEMPTS

int

quarkus.artemis."configuration-name".failover-attempts

Maximum number of failover attempts.

Environment variable: QUARKUS_ARTEMIS_FAILOVER_ATTEMPTS

int

quarkus.artemis."configuration-name".retry-interval

Interval (ms) between reconnection attempts.

Environment variable: QUARKUS_ARTEMIS_RETRY_INTERVAL

long

quarkus.artemis."configuration-name".retry-interval-multiplier

Multiplier for exponential backoff on retries.

Environment variable: QUARKUS_ARTEMIS_RETRY_INTERVAL_MULTIPLIER

double

quarkus.artemis."configuration-name".max-retry-interval

Maximum interval (ms) between retries.

Environment variable: QUARKUS_ARTEMIS_MAX_RETRY_INTERVAL

long

quarkus.artemis."configuration-name".failover-on-initial-connection

Whether to failover to backup on initial connection.

Environment variable: QUARKUS_ARTEMIS_FAILOVER_ON_INITIAL_CONNECTION

boolean

quarkus.artemis."configuration-name".auto-group

Whether to automatically group messages.

Environment variable: QUARKUS_ARTEMIS_AUTO_GROUP

boolean

quarkus.artemis."configuration-name".group-id

The group ID to use for messages.

Environment variable: QUARKUS_ARTEMIS_GROUP_ID

string

quarkus.artemis."configuration-name".block-on-acknowledge

Whether consumers block while sending acknowledgments.

Environment variable: QUARKUS_ARTEMIS_BLOCK_ON_ACKNOWLEDGE

boolean

quarkus.artemis."configuration-name".block-on-durable-send

Whether producers block when sending durable messages.

Environment variable: QUARKUS_ARTEMIS_BLOCK_ON_DURABLE_SEND

boolean

quarkus.artemis."configuration-name".block-on-non-durable-send

Whether producers block when sending non-durable messages.

Environment variable: QUARKUS_ARTEMIS_BLOCK_ON_NON_DURABLE_SEND

boolean

quarkus.artemis."configuration-name".pre-acknowledge

Whether messages are pre-acknowledged on the server.

Environment variable: QUARKUS_ARTEMIS_PRE_ACKNOWLEDGE

boolean

quarkus.artemis."configuration-name".initial-message-packet-size

The initial size of message packets in bytes.

Environment variable: QUARKUS_ARTEMIS_INITIAL_MESSAGE_PACKET_SIZE

int

quarkus.artemis."configuration-name".ack-batch-size

Core Only: The acknowledgments batch size.

Environment variable: QUARKUS_ARTEMIS_ACK_BATCH_SIZE

int

quarkus.artemis."configuration-name".on-message-close-timeout

Core Only: Timeout (ms) for onMessage completion when closing consumers.

Environment variable: QUARKUS_ARTEMIS_ON_MESSAGE_CLOSE_TIMEOUT

int

quarkus.artemis."configuration-name".use-topology-for-load-balancing

Core Only: Whether to use cluster topology for load balancing.

Environment variable: QUARKUS_ARTEMIS_USE_TOPOLOGY_FOR_LOAD_BALANCING

boolean

quarkus.artemis."configuration-name".client-id

JMS Only: The client ID for the connection.

Environment variable: QUARKUS_ARTEMIS_CLIENT_ID

string

quarkus.artemis."configuration-name".enable-shared-client-id

JMS Only: Whether multiple connections can share the same client ID.

Environment variable: QUARKUS_ARTEMIS_ENABLE_SHARED_CLIENT_ID

boolean

quarkus.artemis."configuration-name".enable1x-prefixes

JMS Only: Whether to use 1.x message prefixes (jms.queue.).

Environment variable: QUARKUS_ARTEMIS_ENABLE1X_PREFIXES

boolean

quarkus.artemis."configuration-name".ignore-jta

JMS Only: Whether to ignore JTA for session management.

Environment variable: QUARKUS_ARTEMIS_IGNORE_JTA

boolean

quarkus.artemis."configuration-name".dups-ok-batch-size

JMS Only: The batch size for DUPS_OK_ACKNOWLEDGE mode.

Environment variable: QUARKUS_ARTEMIS_DUPS_OK_BATCH_SIZE

int

quarkus.artemis."configuration-name".transaction-batch-size

JMS Only: The batch size for transacted sessions in bytes.

Environment variable: QUARKUS_ARTEMIS_TRANSACTION_BATCH_SIZE

int

quarkus.artemis."configuration-name".cache-destinations

JMS Only: Whether to cache JMS destinations on the client.

Environment variable: QUARKUS_ARTEMIS_CACHE_DESTINATIONS

boolean

quarkus.artemis."configuration-name".deserialization-allow-list

JMS Only: Allowed classes for ObjectMessage deserialization.

Environment variable: QUARKUS_ARTEMIS_DESERIALIZATION_ALLOW_LIST

string

quarkus.artemis."configuration-name".deserialization-deny-list

JMS Only: Forbidden classes for ObjectMessage deserialization.

Environment variable: QUARKUS_ARTEMIS_DESERIALIZATION_DENY_LIST

string

quarkus.artemis."configuration-name".incoming-interceptor-list

Comma-separated list of incoming interceptors.

Environment variable: QUARKUS_ARTEMIS_INCOMING_INTERCEPTOR_LIST

string

quarkus.artemis."configuration-name".outgoing-interceptor-list

Comma-separated list of outgoing interceptors.

Environment variable: QUARKUS_ARTEMIS_OUTGOING_INTERCEPTOR_LIST

string

quarkus.artemis."configuration-name".connection-load-balancing-policy-class-name

Class name of the connection load balancing policy.

Environment variable: QUARKUS_ARTEMIS_CONNECTION_LOAD_BALANCING_POLICY_CLASS_NAME

string

quarkus.artemis."configuration-name".protocol-manager-factory-str

Class name of the protocol manager factory.

Environment variable: QUARKUS_ARTEMIS_PROTOCOL_MANAGER_FACTORY_STR

string