# Versions

This chapter provides the following information for each release:

- A link to the full release notes which includes all issues resolved in the release.
- A brief list of "highlights" when applicable.
- If necessary, specific steps required when upgrading from the previous version.
  - Note: If the upgrade spans multiple versions then the steps from each version need to be followed in order.
  - Note: Follow the general upgrade procedure outlined in the Upgrading the Broker chapter in addition to any version-specific upgrade instructions outlined here.

## 2.21.0

Full release notes.

Highlights:

- MQTT 5 is now supported.
- A new set of performance tools are now available to evaluate throughput and Response Under Load performance of Artemis
- Diverts now support multiple addresses
- Runtime configuration reloading now supports bridges.
- Paging can now be configured by message count.

#### Upgrading from older versions

Due to XML schema changes to correct an inaccurate domain name 2 files will need to be updated:

1. `etc/bootstrap.xml`
2. `etc/management.xml`

In both files change the XML namespace from `activemq.org` to `activemq.apache.org`, e.g. in `bootsrap.xml` use:

    <broker xmlns="http://activemq.apache.org/schema">

And in `management.xml` use:

    <management-context xmlns="http://activemq.apache.org/schema">

## 2.20.0

Full release notes.

Highlights:

- Java 11 is now required.

## 2.19.0

Full release notes.

Highlights:

- New ability to replay retained journal records via the management API.
- New environment/system property to set the "key" for masked passwords when using the default codec.
- Ability to disable message-load-balancing and still allow redistribution via the new `OFF_WITH_REDISTRIBUTION` type.
- MQTT session state can now be cleaned up automatically to avoid excessive accumulation in situations where client's don't clean up their own sessions.
- Distribute full Jakarta Messaging 3.0 client in the `lib/client` directory along with a new example of how to use it in `examples/features/standard/queue-jakarta`.

## 2.18.0

Full release notes.

Highlights:

- Dual Mirror support improving capabilities on AMQP Mirror for Disaster Recovery
- Journal Retention
- Replication integrated with Zookeeper
- Connection Routers
- Concurrency configuration for core bridges.
- XPath filter expressions (for parity with ActiveMQ "Classic").

#### Upgrading from older versions

1. Due to ARTEMIS-3367 the default setting for `verifyHost` on core connectors has been changed from `false` to `true`. This means that core clients will now expect the `CN` or Subject Alternative Name values of the broker's SSL certificate to match the hostname in the client's URL.

   This impacts all core-based clients including core JMS clients and core connections between cluster nodes. Although this is a "breaking" change, not performing hostname verification is a security risk (e.g. due to man-in-the-middle attacks). Enabling it by default aligns core client behavior with industry standards. To deal with this you can do one of the following:

   - Update your SSL certificates to use a hostname which matches the hostname in the client's URL. This is the recommended option with regard to security.
   - Update any connector using `sslEnabled=true` to also use `verifyHost=false`. Using this option means that you won't get the extra security of hostname verification, but no certificates will need to change. This essentially restores the previous default behavior.

   For additional details about please refer to section 3.1 of RFC 2818 "HTTP over TLS".

2. Due to ARTEMIS-3117 SSL keystore and truststores are no longer reloaded automatically. Previously an instance of `javax.net.ssl.SSLContext` was created for every connection. This would implicitly pick up any changes to the keystore and truststore for any new connection. However, this was grossly inefficient and therefore didn't scale well with lots of connections. The behavior was changed so that just one `javax.net.ssl.SSLContext` is created for each `acceptor`. However, one can still reload keystores & truststores from disk without restarting the broker. Simply use the `reload` management operation on the `acceptor`. This is available via JMX, the web console, Jolokia, etc.

   Here's an example `curl` command you can use with Jolokia to invoke the `artemis` acceptor's `reload` operation:

       curl --user admin:admin --header "Content-Type: application/json" --request POST --data '{"type":"exec", "mbean":"org.apache.activemq.artemis:broker=\"0.0.0.0\",component=acceptors,name=\"artemis\"", "operation":"reload"}' http://localhost:8161/console/jolokia/exec

   Of course you'll want to adjust the username & password as well as the broker and acceptor names for your environment.

3. The "rate" metric for queues was removed from the web console via ARTEMIS-3397. This was a follow-up from ARTEMIS-2909 in 2.16.0 (referenced in the upgrade instructions below). The "rate" metric mistakenly left visible on the web console after it was removed from the management API.

4. Due to ARTEMIS-3141, ARTEMIS-3128, & ARTEMIS-3175 the data returned for any "list" or "browse" management method which return message data, including those exposed via the web console, will have their return data truncated by default. This is done to avoid adverse conditions with large volumes of message data which could potentially negatively impact broker stability. The `management-message-attribute-size-limit` address-setting controls this behavior. If you wish to restore the previous (and potentially dangerous behavior) then you can specify `-1` for this. It is `256` by default.

## 2.17.0

Full release notes.

Highlights:

- Message-level authorization similar to ActiveMQ 5.x.
- A count of addresses and queues is now available from the management API.
- You can now reload the broker's configuration from disk via the management API rather than waiting for the periodic disk scan to pick it up
- Performance improvements on libaio journal.
- New command-line option to transfer messages.
- Performance improvements for the wildcard address manager.
- JDBC datasource property values can now be masked.
- Lots of usability improvements to the Hawtio 2 based web console introduced in 2.16.0
- New management method to create a core bridge using JSON-based configuration input.
- Jakarta Messaging 2.0 & 3.0 artifacts for Jakarta EE 8 & 9 respectively.

## 2.16.0

Full release notes.

Highlights:

- Configurable namespace for temporary queues
- AMQP Server Connectivity
- "Basic" `SecurityManager` implementation that supports replication
- Consumer window size support for individual STOMP clients
- Improved JDBC connection management
- New web console based on Hawtio 2
- Performance optimizations (i.e. caching) for authentication and authorization
- Support for admin objects in the JCA resource adapter to facilitate deployment into 3rd-party Java EE application servers
- Ability to prevent an acceptor from automatically starting

#### Upgrading from older versions

1. Due to ARTEMIS-2893 the fundamental way user management was implemented had to change to avoid data integrity issues related to concurrent modification. From a user's perspective two main things changed:

   1. User management is no longer possible using the `artemis user` commands when the broker is offline. Of course users are still free to modify the properties files directly in this situation.

   2. The parameters of the `artemis user` commands changed. Instead of using something like this:

          ./artemis user add --user guest --password guest --role admin

      Use this instead:

          ./artemis user add --user-command-user guest --user-command-password guest --role admin

      In short, use `user-command-user` in lieu of `user` and `user-command-password` in lieu of `password`. Both `user` and `password` parameters now apply to the connection used to send the command to the broker.

      For additional details see ARTEMIS-2893 and ARTEMIS-3010

2. Due to ARTEMIS-2909 the "rate" metric was removed from the management API for queues. In short, the `org.apache.activemq.artemis.core.server.Queue#getRate` method is for slow-consumer detection and is designed for internal use only.

   Furthermore, it's too opaque to be trusted by a remote user as it only returns the number of message added to the queue since the last time it was called. The problem here is that the user calling it doesn't know when it was invoked last. Therefore, they could be getting the rate of messages added for the last 5 minutes or the last 5 milliseconds. This can lead to inconsistent and misleading results.

   There are three main ways for users to track rates of message production and consumption (in recommended order):

   1. Use a metrics plugin. This is the most feature-rich and flexible way to track broker metrics, although it requires tools (e.g. Prometheus) to store the metrics and display them (e.g. Grafana).

   2. Invoke the `getMessageCount()` and `getMessagesAdded()` management methods and store the returned values along with the time they were retrieved. A time-series database is a great tool for this job. This is exactly what tools like Prometheus do. That data can then be used to create informative graphs, etc. using tools like Grafana. Of course, one can skip all the tools and just do some simple math to calculate rates based on the last time the counts were retrieved.

   3. Use the broker's message counters. Message counters are the broker's simple way of providing historical information about the queue. They provide similar results to the previous solutions, but with less flexibility since they only track data while the broker is up and there's not really any good options for graphing.

## 2.15.0

Full release notes.

Highlights:

- Ability to use FQQN syntax for both `security-settings` and JNDI lookup
- Support pausing dispatch during group rebalance (to avoid potential out-of-order consumption)
- Socks5h support

## 2.14.0

Full release notes.

Highlights:

- Management methods to update diverts
- Ability to "disable" a queue so that messages are not routed to it
- Support JVM GC & thread metrics
- Support for resetting queue properties by unsetting them in `broker.xml`
- Undeploy diverts by removing them from `broker.xml`
- Add `addressMemoryUsagePercentage` and `addressSize` as metrics

#### Upgrading from older versions

This is likely a rare situation, but it's worth mentioning here anyway. Prior to 2.14.0 if you configured a parameter on a `queue` in `broker.xml` (e.g. `max-consumers`) and then later removed that setting the configured value you set would remain. This has changed in 2.14.0 via ARTEMIS-2797. Any value that is not explicitly set in `broker.xml` will be set back to either the static default or the dynamic default configured in the address-settings (e.g. via `default-max-consumers` in this example). Therefore, ensure any existing queues have all the needed parameters set in `broker.xml` values before upgrading.

## 2.13.0

Full release notes.

Highlights:

- Management methods for an address' duplicate ID cache to check the cache's size and clear it
- Support for min/max expiry-delay
- Per-acceptor security domains
- Command-line `check` tool for checking the health of a broker
- Support disabling metrics per address via the `enable-metrics` address setting
- Improvements to the audit logging
- Speed optimizations for the `HierarchicalObjectRepository`, an internal object used to store address and security settings

#### Upgrading from older versions

Version 2.13.0 added new audit logging which is logged at `INFO` level and can be very verbose. The `logging.properties` shipped with this new version is set up to filter this out by default. If your `logging.properties` isn't updated appropriately this audit logging will likely appear in your console and `artemis.log` file assuming you're using a logging configuration close to the default. Add this to your `logging.properties`:

    # to enable audit change the level to INFO
    logger.org.apache.activemq.audit.base.level=ERROR
    logger.org.apache.activemq.audit.base.handlers=AUDIT_FILE
    logger.org.apache.activemq.audit.base.useParentHandlers=false

    logger.org.apache.activemq.audit.resource.level=ERROR
    logger.org.apache.activemq.audit.resource.handlers=AUDIT_FILE
    logger.org.apache.activemq.audit.resource.useParentHandlers=false

    logger.org.apache.activemq.audit.message.level=ERROR
    logger.org.apache.activemq.audit.message.handlers=AUDIT_FILE
    logger.org.apache.activemq.audit.message.useParentHandlers=false

    ...

    #Audit logger
    handler.AUDIT_FILE=org.jboss.logmanager.handlers.PeriodicRotatingFileHandler
    handler.AUDIT_FILE.level=INFO
    handler.AUDIT_FILE.properties=suffix,append,autoFlush,fileName
    handler.AUDIT_FILE.suffix=.yyyy-MM-dd
    handler.AUDIT_FILE.append=true
    handler.AUDIT_FILE.autoFlush=true
    handler.AUDIT_FILE.fileName=${artemis.instance}/log/audit.log
    handler.AUDIT_FILE.formatter=AUDIT_PATTERN

    formatter.AUDIT_PATTERN=org.jboss.logmanager.formatters.PatternFormatter
    formatter.AUDIT_PATTERN.properties=pattern
    formatter.AUDIT_PATTERN.pattern=%d [AUDIT](%t) %s%E%n

## 2.12.0

Full release notes.

Highlights:

- Support for SOCKS proxy
- Real large message support for AMQP
- Automatic creation of dead-letter resources akin to ActiveMQ 5's individual dead-letter strategy
- Automatic creation of expiry resources
- Improved API for queue creation
- Allow users to override JAVA_ARGS via environment variable
- Reduce heap usage during journal loading during broker start-up
- Allow `server` header in STOMP `CONNECTED` frame to be disabled
- Support disk store used percentage as an exportable metric (e.g. to be monitored by tools like Prometheus, etc.)
- Ability to configure a "customizer" for the embedded web server
- Improved logging for errors when starting an `acceptor` to more easily identify the `acceptor` which has the problem.
- The CLI will now read the `broker.xml` to find the default `connector` URL for commands which require it (e.g. `consumer`, `producer`, etc.)

## 2.11.0

Full release notes.

Highlights:

- Support retroactive addresses.
- Support downstream federated queues and addresses.
- Make security manager configurable via XML.
- Support pluggable SSL TrustManagerFactory.
- Add plugin support for federated queues/addresses.
- Support `com.sun.jndi.ldap.read.timeout` in LDAPLoginModule.

## 2.10.0

Full release notes.

This was mainly a bug-fix release with a notable dependency change impacting version upgrade.

#### Upgrading from 2.9.0

Due to the WildFly dependency upgrade the broker start scripts/configuration need to be adjusted after upgrading.

##### On *nix

Locate this statement in `bin/artemis`:

    WILDFLY_COMMON="$ARTEMIS_HOME/lib/wildfly-common-1.5.1.Final.jar"

This needs to be replaced with this:

    WILDFLY_COMMON="$ARTEMIS_HOME/lib/wildfly-common-1.5.2.Final.jar"

##### On Windows

Locate this part of `JAVA_ARGS` in `etc/artemis.profile.cmd` respectively `bin/artemis-service.xml`:

    %ARTEMIS_HOME%\lib\wildfly-common-1.5.1.Final.jar

This needs to be replaced with this:

    %ARTEMIS_HOME%\lib\wildfly-common-1.5.2.Final.jar

## 2.9.0

Full release notes.

This was a light release. It included a handful of bug fixes, a few improvements, and one major new feature.

Highlights:

- Support exporting metrics.

## 2.8.1

Full release notes.

This was mainly a bug-fix release with a notable dependency change impacting version upgrade.

#### Upgrading from 2.8.0

Due to the dependency upgrade made on ARTEMIS-2319 the broker start scripts need to be adjusted after upgrading.

##### On *nix

Locate this `if` statement in `bin/artemis`:

    if [ -z "$LOG_MANAGER" ] ; then
     # this is the one found when the server was created
     LOG_MANAGER="$ARTEMIS_HOME/lib/jboss-logmanager-2.0.3.Final.jar"
    fi

This needs to be replaced with this block:

    if [ -z "$LOG_MANAGER" ] ; then
     # this is the one found when the server was created
     LOG_MANAGER="$ARTEMIS_HOME/lib/jboss-logmanager-2.1.10.Final.jar"
    fi

    WILDFLY_COMMON=`ls $ARTEMIS_HOME/lib/wildfly-common*jar 2>/dev/null`
    if [ -z "$WILDFLY_COMMON" ] ; then
     # this is the one found when the server was created
     WILDFLY_COMMON="$ARTEMIS_HOME/lib/wildfly-common-1.5.1.Final.jar"
    fi

Notice that the `jboss-logmanager` version has changed and there is also a new `wildfly-common` library.

Not much further down there is this line:

    -Xbootclasspath/a:"$LOG_MANAGER" \

This line should be changed to be:

    -Xbootclasspath/a:"$LOG_MANAGER:$WILDFLY_COMMON" \

##### On Windows

Locate this part of `JAVA_ARGS` in `etc/artemis.profile.cmd` respectively `bin/artemis-service.xml`:

    -Xbootclasspath/a:%ARTEMIS_HOME%\lib\jboss-logmanager-2.1.10.Final.jar

This needs to be replaced with this:

    -Xbootclasspath/a:%ARTEMIS_HOME%\lib\jboss-logmanager-2.1.10.Final.jar;%ARTEMIS_HOME%\lib\wildfly-common-1.5.1.Final.jar

## 2.8.0

Full release notes.

Highlights:

- Support ActiveMQ5 feature JMSXGroupFirstForConsumer.
- Clarify handshake timeout error with remote address.
- Support duplicate detection for AMQP messages the same as core.

## 2.7.0

Full release notes.

Highlights:

- Support advanced destination options like `consumersBeforeDispatchStarts` and `timeBeforeDispatchStarts` from 5.x.
- Add support for delays before deleting addresses and queues via `auto-delete-queues-delay` and `auto-delete-addresses-delay` Address Settings.
- Support logging HTTP access.
- Add a CLI command to purge a queue.
- Support user and role manipulation for PropertiesLoginModule via management interfaces.
- Docker images.
- Audit logging.
- Implementing consumer priority.
- Support FQQN for producers.
- Track routed and unrouted messages sent to an address.
- Support connection pooling in LDAPLoginModule.
- Support configuring a default consumer window size via `default-consumer-window-size` Address Setting.
- Support masking `key-store-password` and `trust-store-password` in management.xml.
- Support `JMSXGroupSeq` -1 to close/reset message groups from 5.x.
- Allow configuration of RMI registry port.
- Support routing-type configuration on core bridge.
- Move artemis-native as its own project, as activemq-artemis-native.
- Support federated queues and addresses.

## 2.6.4

Full release notes.

This was mainly a bug-fix release with a few improvements a couple notable new features:

Highlights:

- Added the ability to set the text message content on the `producer` CLI command.
- Support reload logging configuration at runtime.

## 2.6.3

Full release notes.

This was mainly a bug-fix release with a few improvements but no substantial new features.

## 2.6.2

Full release notes.

This was a bug-fix release with no substantial new features or improvements.

## 2.6.1

Full release notes.

This was a bug-fix release with no substantial new features or improvements.

## 2.6.0

Full release notes.

Highlights:

- Support regular expressions for matching client certificates.
- Support `SASL_EXTERNAL` for AMQP clients.
- New examples showing virtual topic mapping and exclusive queue features.

## 2.5.0

Full release notes.

Highlights:

- Exclusive consumers.
- Equivalent ActiveMQ 5.x Virtual Topic naming abilities.
- SSL Certificate revocation list.
- Last-value queue support for OpenWire.
- Support masked passwords in bootstrap.xm and login.config
- Configurable broker plugin implementation for logging various broker events (i.e. `LoggingActiveMQServerPlugin`).
- Option to use OpenSSL provider for Netty via the `sslProvider` URL parameter.
- Enable splitting of broker.xml into multiple files.
- Enhanced message count and size metrics for queues.

#### Upgrading from 2.4.0

1. Due to changes from ARTEMIS-1644 any `acceptor` that needs to be compatible with HornetQ and/or Artemis 1.x clients needs to have `anycastPrefix=jms.queue.;multicastPrefix=jms.topic.` in the `acceptor` url. This prefix used to be configured automatically behind the scenes when the broker detected these old types of clients, but that broke certain use-cases with no possible work-around. See ARTEMIS-1644 for more details.

## 2.4.0

Full release notes.

Highlights:

- JMX configuration via XML rather than having to use system properties via command line or start script.
- Configuration of max frame payload length for STOMP web-socket.
- Ability to configure HA using JDBC persistence.
- Implement role-based access control for management objects.

#### Upgrading from 2.3.0

1. Create `<ARTEMIS_INSTANCE>/etc/management.xml`. At the very least, the file must contain this:

       <management-context xmlns="http://activemq.apache.org/schema"/>

   This configures role based authorisation for JMX. Read more in the Management documentation.

2. If configured, remove the Jolokia war file from the `web` element in `<ARTEMIS_INSTANCE>/etc/bootstrap.xml`:

       <app url="jolokia" war="jolokia.war"/>

   This is no longer required as the Jolokia REST interface is now integrated into the console web application.

   If the following is absent and you desire to deploy the web console then add:

       <app url="console" war="console.war"/>

   Note: the Jolokia REST interface URL will now be at `http://<host>:<port>/console/jolokia`

## 2.3.0

Full release notes.

Highlights:

- Web admin console!
- Critical Analysis and deadlock detection on broker
- Support Netty native kqueue on Mac.
- Last-value queue for AMQP

#### Upgrading from 2.2.0

1. If you desire to deploy the web console then add the following to the `web` element in `<ARTEMIS_INSTANCE>/etc/bootstrap.xml`:

       <app url="console" war="console.war"/>

## 2.2.0

Full release notes.

Highlights:

- Scheduled messages with the STOMP protocol.
- Support for JNDIReferenceFactory and JNDIStorable.
- Ability to delete queues and addresses when broker.xml changes.
- Client authentication via Kerberos TLS Cipher Suites (RFC 2712).

## 2.1.0

Full release notes.

Highlights:

- Broker plugin support.
- Support Netty native epoll on Linux.
- Ability to configure arbitrary security role mappings.
- AMQP performance improvements.

## 2.0.0

Full release notes.

Highlights:

- Huge update involving a significant refactoring of the addressing model yielding the following benefits:
  - Simpler and more flexible XML configuration.
  - Support for additional messaging use-cases.
  - Eliminates confusing JMS-specific queue naming conventions (i.e. "jms.queue." & "jms.topic." prefixes).
- Pure encoding of messages so protocols like AMQP don't need to convert messages to "core" format unless absolutely necessary.
- "MAPPED" journal type for increased performance in certain use-cases.

## 1.5.6

Full release notes.

Highlights:

- Bug fixes.

## 1.5.5

Full release notes.

Highlights:

- Bug fixes.

## 1.5.4

Full release notes.

Highlights:

- Support Oracle12C for JDBC persistence.
- Bug fixes.

## 1.5.3

Full release notes.

Highlights:

- Support "byte notation" (e.g. "K", "KB", "Gb", etc.) in broker XML configuration.
- CLI command to recalculate disk sync times.
- Bug fixes.

## 1.5.2

Full release notes.

Highlights:

- Support for paging using JDBC.
- Bug fixes.

## 1.5.1

Full release notes.

Highlights:

- Support outgoing connections for AMQP.
- Bug fixes.

## 1.5.0

Full release notes.

Highlights:

- AMQP performance improvements.
- JUnit rule implementation so messaging resources like brokers can be easily configured in tests.
- Basic CDI integration.
- Store user's password in hash form by default.

## 1.4.0

Full release notes.

Highlights:

- "Global" limit for disk usage.
- Detect and reload certain XML configuration changes at runtime.
- MQTT interceptors.
- Support adding/deleting queues via CLI.
- New "browse" security permission for clients who only wish to look at messages.
- Option to populate JMSXUserID.
- "Dual authentication" support to authenticate SSL-based and non-SSL-based clients differently.

## 1.3.0

Full release notes.

Highlights:

- Better support of OpenWire features (e.g. reconnect, producer flow-control, optimized acknowledgements)
- SSL keystore reload at runtime.
- Initial support for JDBC persistence.
- Support scheduled messages on last-value queue.

## 1.2.0

Full release notes.

Highlights:

- Improvements around performance
- OSGi support.
- Support functionality equivalent to all 5.x JAAS login modules including:
  - Properties file
  - LDAP
  - SSL certificate
  - "Guest"

## 1.1.0

Full release notes.

Highlights:

- MQTT support.
- The examples now use the CLI programmatically to create, start, stop, etc. servers reflecting real cases used in production.
- CLI improvements. There are new tools to compact the journal and additional improvements to the user experience.
- Configurable resource limits.
- Ability to disable server-side message load-balancing.

## 1.0.0

Full release notes.

Highlights:

- First release of the donated code-base as ActiveMQ Artemis!
- Lots of features for parity with ActiveMQ 5.x including:
  - OpenWire support
  - AMQP 1.0 support
  - URL based connections
  - Auto-create addresses/queues
  - Jolokia integration

# results matching ""

# No results matching ""