Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 2BEF2200BEA for ; Mon, 12 Dec 2016 17:11:30 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 2ABE8160B1A; Mon, 12 Dec 2016 16:11:30 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 0653A160B4A for ; Mon, 12 Dec 2016 17:11:26 +0100 (CET) Received: (qmail 5983 invoked by uid 500); 12 Dec 2016 16:11:26 -0000 Mailing-List: contact commits-help@activemq.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@activemq.apache.org Delivered-To: mailing list commits@activemq.apache.org Received: (qmail 4471 invoked by uid 99); 12 Dec 2016 16:11:24 -0000 Received: from Unknown (HELO svn01-us-west.apache.org) (209.188.14.144) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 12 Dec 2016 16:11:24 +0000 Received: from svn01-us-west.apache.org (localhost [127.0.0.1]) by svn01-us-west.apache.org (ASF Mail Server at svn01-us-west.apache.org) with ESMTP id DD4933A3B2A for ; Mon, 12 Dec 2016 16:11:22 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: svn commit: r1002655 [34/47] - in /websites/production/activemq/content/artemis/docs/1.5.1: ./ diagrams/ gitbook/ gitbook/fonts/ gitbook/fonts/fontawesome/ gitbook/gitbook-plugin-fontsettings/ gitbook/gitbook-plugin-highlight/ gitbook/gitbook-plugin-lu... Date: Mon, 12 Dec 2016 16:11:21 -0000 To: commits@activemq.apache.org From: clebertsuconic@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20161212161122.DD4933A3B2A@svn01-us-west.apache.org> archived-at: Mon, 12 Dec 2016 16:11:30 -0000 Added: websites/production/activemq/content/artemis/docs/1.5.1/persistence.html ============================================================================== --- websites/production/activemq/content/artemis/docs/1.5.1/persistence.html (added) +++ websites/production/activemq/content/artemis/docs/1.5.1/persistence.html Mon Dec 12 16:11:17 2016 @@ -0,0 +1,1357 @@ + + + + + Persistence · ActiveMQ Artemis Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + +
+ +
+ +
+ + + + + + + + +
+
+ +
+
+ +
+ +

Persistence

+

In this chapter we will describe how persistence works with Apache ActiveMQ Artemis and +how to configure it.

+

Apache ActiveMQ Artemis ships with two persistence options. The Apache ActiveMQ Artemis File journal +which is highly optimized for the messaging use case and gives great performance, and also Apache Artemis +JDBC Store, which uses JDBC to connect to a database of your choice. The JDBC Store is still under development, +but it is possible to use it's journal features, (essentially everything except for paging and large messages).

+

Apache ActiveMQ Artemis File Journal (Default)

+

An Apache ActiveMQ Artemis file journal is an append only journal. It consists of a set of +files on disk. Each file is pre-created to a fixed size and initially +filled with padding. As operations are performed on the server, e.g. add +message, update message, delete message, records are appended to the +journal. When one journal file is full we move to the next one.

+

Because records are only appended, i.e. added to the end of the journal +we minimise disk head movement, i.e. we minimise random access +operations which is typically the slowest operation on a disk.

+

Making the file size configurable means that an optimal size can be +chosen, i.e. making each file fit on a disk cylinder. Modern disk +topologies are complex and we are not in control over which cylinder(s) +the file is mapped onto so this is not an exact science. But by +minimising the number of disk cylinders the file is using, we can +minimise the amount of disk head movement, since an entire disk cylinder +is accessible simply by the disk rotating - the head does not have to +move.

+

As delete records are added to the journal, Apache ActiveMQ Artemis has a sophisticated +file garbage collection algorithm which can determine if a particular +journal file is needed any more - i.e. has all its data been deleted in +the same or other files. If so, the file can be reclaimed and re-used.

+

Apache ActiveMQ Artemis also has a compaction algorithm which removes dead space from +the journal and compresses up the data so it takes up less files on +disk.

+

The journal also fully supports transactional operation if required, +supporting both local and XA transactions.

+

The majority of the journal is written in Java, however we abstract out +the interaction with the actual file system to allow different pluggable +implementations. Apache ActiveMQ Artemis ships with two implementations:

+
    +
  • Java NIO.

    +

    The first implementation uses standard Java NIO to interface with +the file system. This provides extremely good performance and runs +on any platform where there's a Java 6+ runtime.

    +
  • +
  • Linux Asynchronous IO

    +

    The second implementation uses a thin native code wrapper to talk to +the Linux asynchronous IO library (AIO). With AIO, Apache ActiveMQ Artemis will be +called back when the data has made it to disk, allowing us to avoid +explicit syncs altogether and simply send back confirmation of +completion when AIO informs us that the data has been persisted.

    +

    Using AIO will typically provide even better performance than using +Java NIO.

    +

    The AIO journal is only available when running Linux kernel 2.6 or +later and after having installed libaio (if it's not already +installed). For instructions on how to install libaio please see Installing AIO section.

    +

    Also, please note that AIO will only work with the following file +systems: ext2, ext3, ext4, jfs, xfs. With other file systems, e.g. +NFS it may appear to work, but it will fall back to a slower +synchronous behaviour. Don't put the journal on a NFS share!

    +

    For more information on libaio please see lib AIO.

    +

    libaio is part of the kernel project.

    +
  • +
+

The standard Apache ActiveMQ Artemis core server uses two instances of the journal:

+
    +
  • Bindings journal.

    +

    This journal is used to store bindings related data. That includes +the set of queues that are deployed on the server and their +attributes. It also stores data such as id sequence counters.

    +

    The bindings journal is always a NIO journal as it is typically low +throughput compared to the message journal.

    +

    The files on this journal are prefixed as activemq-bindings. Each +file has a bindings extension. File size is 1048576, and it is +located at the bindings folder.

    +
  • +
  • JMS journal.

    +

    This journal instance stores all JMS related data, This is basically +any JMS Queues, Topics and Connection Factories and any JNDI +bindings for these resources.

    +

    Any JMS Resources created via the management API will be persisted +to this journal. Any resources configured via configuration files +will not. The JMS Journal will only be created if JMS is being used.

    +

    The files on this journal are prefixed as activemq-jms. Each file +has a jms extension. File size is 1048576, and it is located at +the bindings folder.

    +
  • +
  • Message journal.

    +

    This journal instance stores all message related data, including the +message themselves and also duplicate-id caches.

    +

    By default Apache ActiveMQ Artemis will try and use an AIO journal. If AIO is not +available, e.g. the platform is not Linux with the correct kernel +version or AIO has not been installed then it will automatically +fall back to using Java NIO which is available on any Java platform.

    +

    The files on this journal are prefixed as activemq-data. Each file +has a amq extension. File size is by the default 10485760 +(configurable), and it is located at the journal folder.

    +
  • +
+

For large messages, Apache ActiveMQ Artemis persists them outside the message journal. +This is discussed in Large Messages.

+

Apache ActiveMQ Artemis can also be configured to page messages to disk in low memory +situations. This is discussed in Paging.

+

If no persistence is required at all, Apache ActiveMQ Artemis can also be configured +not to persist any data at all to storage as discussed in the Configuring +the broker for Zero Persistence section.

+

Configuring the bindings journal

+

The bindings journal is configured using the following attributes in +broker.xml

+
    +
  • bindings-directory

    +

    This is the directory in which the bindings journal lives. The +default value is data/bindings.

    +
  • +
  • create-bindings-dir

    +

    If this is set to true then the bindings directory will be +automatically created at the location specified in +bindings-directory if it does not already exist. The default value +is true

    +
  • +
+

Configuring the jms journal

+

The jms config shares its configuration with the bindings journal.

+

Configuring the message journal

+

The message journal is configured using the following attributes in +broker.xml

+
    +
  • journal-directory

    +

    This is the directory in which the message journal lives. The +default value is data/journal.

    +

    For the best performance, we recommend the journal is located on its +own physical volume in order to minimise disk head movement. If the +journal is on a volume which is shared with other processes which +might be writing other files (e.g. bindings journal, database, or +transaction coordinator) then the disk head may well be moving +rapidly between these files as it writes them, thus drastically +reducing performance.

    +

    When the message journal is stored on a SAN we recommend each +journal instance that is stored on the SAN is given its own LUN +(logical unit).

    +
  • +
  • create-journal-dir

    +

    If this is set to true then the journal directory will be +automatically created at the location specified in +journal-directory if it does not already exist. The default value +is true

    +
  • +
  • journal-type

    +

    Valid values are NIO or ASYNCIO.

    +

    Choosing NIO chooses the Java NIO journal. Choosing ASYNCIO chooses +the Linux asynchronous IO journal. If you choose ASYNCIO but are not +running Linux or you do not have libaio installed then Apache ActiveMQ Artemis will +detect this and automatically fall back to using NIO.

    +
  • +
  • journal-sync-transactional

    +

    If this is set to true then Apache ActiveMQ Artemis will make sure all transaction +data is flushed to disk on transaction boundaries (commit, prepare +and rollback). The default value is true.

    +
  • +
  • journal-sync-non-transactional

    +

    If this is set to true then Apache ActiveMQ Artemis will make sure non +transactional message data (sends and acknowledgements) are flushed +to disk each time. The default value for this is true.

    +
  • +
  • journal-file-size

    +

    The size of each journal file in bytes. The default value for this +is 10485760 bytes (10MiB).

    +
  • +
  • journal-min-files

    +

    The minimum number of files the journal will maintain. When Apache ActiveMQ Artemis +starts and there is no initial message data, Apache ActiveMQ Artemis will +pre-create journal-min-files number of files.

    +

    Creating journal files and filling them with padding is a fairly +expensive operation and we want to minimise doing this at run-time +as files get filled. By pre-creating files, as one is filled the +journal can immediately resume with the next one without pausing to +create it.

    +

    Depending on how much data you expect your queues to contain at +steady state you should tune this number of files to match that +total amount of data.

    +
  • +
  • journal-pool-files

    +

    The system will create as many files as needed however when reclaiming files +it will shrink back to the journal-pool-files.

    +

    The default to this parameter is -1, meaning it will never delete files on the journal once created.

    +

    Notice that the system can't grow infinitely as you are still required to use paging for destinations that can +grow indefinitely.

    +

    Notice: in case you get too many files you can use compacting.

    +
  • +
  • journal-max-io

    +

    Write requests are queued up before being submitted to the system +for execution. This parameter controls the maximum number of write +requests that can be in the IO queue at any one time. If the queue +becomes full then writes will block until space is freed up.

    +

    When using NIO, this value should always be equal to 1

    +

    When using AIO, the default should be 500.

    +

    The system maintains different defaults for this parameter depending +on whether it's NIO or AIO (default for NIO is 1, default for AIO is +500)

    +

    There is a limit and the total max AIO can't be higher than what is +configured at the OS level (/proc/sys/fs/aio-max-nr) usually at +65536.

    +
  • +
  • journal-buffer-timeout

    +

    Instead of flushing on every write that requires a flush, we +maintain an internal buffer, and flush the entire buffer either when +it is full, or when a timeout expires, whichever is sooner. This is +used for both NIO and AIO and allows the system to scale better with +many concurrent writes that require flushing.

    +

    This parameter controls the timeout at which the buffer will be +flushed if it hasn't filled already. AIO can typically cope with a +higher flush rate than NIO, so the system maintains different +defaults for both NIO and AIO (default for NIO is 3333333 +nanoseconds - 300 times per second, default for AIO is 500000 +nanoseconds - ie. 2000 times per second).

    +
    +

    Note

    +

    By increasing the timeout, you may be able to increase system +throughput at the expense of latency, the default parameters are +chosen to give a reasonable balance between throughput and +latency.

    +
    +
  • +
  • journal-buffer-size

    +

    The size of the timed buffer on AIO. The default value is 490KiB.

    +
  • +
  • journal-compact-min-files

    +

    The minimal number of files before we can consider compacting the +journal. The compacting algorithm won't start until you have at +least journal-compact-min-files

    +

    Setting this to 0 will disable the feature to compact completely. +This could be dangerous though as the journal could grow indefinitely. +Use it wisely!

    +
  • +
+
The default for this parameter is `10`
+
    +
  • journal-compact-percentage

    +

    The threshold to start compacting. When less than this percentage is +considered live data, we start compacting. Note also that compacting +won't kick in until you have at least journal-compact-min-files +data files on the journal

    +

    The default for this parameter is 30

    +
  • +
  • journal-datasync (default: true)

    +

    This will disable the use of fdatasync on journal writes.

    +
  • +
+

An important note on disabling disk write cache.

+
+

Warning

+

Most disks contain hardware write caches. A write cache can increase +the apparent performance of the disk because writes just go into the +cache and are then lazily written to the disk later.

+

This happens irrespective of whether you have executed a fsync() from +the operating system or correctly synced data from inside a Java +program!

+

By default many systems ship with disk write cache enabled. This means +that even after syncing from the operating system there is no +guarantee the data has actually made it to disk, so if a failure +occurs, critical data can be lost.

+

Some more expensive disks have non volatile or battery backed write +caches which won't necessarily lose data on event of failure, but you +need to test them!

+

If your disk does not have an expensive non volatile or battery backed +cache and it's not part of some kind of redundant array (e.g. RAID), +and you value your data integrity you need to make sure disk write +cache is disabled.

+

Be aware that disabling disk write cache can give you a nasty shock +performance wise. If you've been used to using disks with write cache +enabled in their default setting, unaware that your data integrity +could be compromised, then disabling it will give you an idea of how +fast your disk can perform when acting really reliably.

+

On Linux you can inspect and/or change your disk's write cache +settings using the tools hdparm (for IDE disks) or sdparm or +sginfo (for SDSI/SATA disks)

+

On Windows you can check / change the setting by right clicking on the +disk and clicking properties.

+
+

Installing AIO

+

The Java NIO journal gives great performance, but If you are running +Apache ActiveMQ Artemis using Linux Kernel 2.6 or later, we highly recommend you use +the AIO journal for the very best persistence performance.

+

It's not possible to use the AIO journal under other operating systems +or earlier versions of the Linux kernel.

+

If you are running Linux kernel 2.6 or later and don't already have +libaio installed, you can easily install it using the following steps:

+

Using yum, (e.g. on Fedora or Red Hat Enterprise Linux):

+
yum install libaio
+

Using aptitude, (e.g. on Ubuntu or Debian system):

+
apt-get install libaio
+

Apache ActiveMQ Artemis JDBC Persistence

+

WARNING: The Apache ActiveMQ Artemis JDBC persistence store is under development and is included for evaluation purposes.

+

The Apache ActiveMQ Artemis JDBC persistence layer offers the ability to store broker state (Messages, Addresses and other +application state) using a database. N.B. Address full policy Paging (See: The section on Paging) is currently not +supported with the JDBC persistence layer.

+

Using the ActiveMQ Artemis File Journal is the recommended configuration as it offers higher levels of performance and is +more mature. The JDBC persistence layer is targeted to those users who must use a database e.g. due to internal company +policy.

+

ActiveMQ Artemis currently has support for a limited number of database vendors (older versions may work but mileage may +vary):

+
    +
  1. PostGres 9.4.x
  2. +
  3. MySQL 5.7.x
  4. +
  5. Apache Derby 10.11.1.1
  6. +
+

The JDBC store uses a JDBC connection to store messages and bindings data in records in database tables. The data stored +in the database tables is encoded using Apache ActiveMQ Artemis internal encodings.

+

Configuring JDBC Persistence

+

To configure Apache ActiveMQ Artemis to use a database for persisting messages and bindings data you must do two things.

+
    +
  1. Add the appropriate JDBC driver libraries to the Artemis runtime. You can do this by dropping the relevant jars in the lib folder of the ActiveMQ Artemis distribution.

    +
  2. +
  3. Create a store element in your broker.xml config file under the <core> element. For example:

    +
  4. +
+
      <store>
+         <database-store>
+            <jdbc-connection-url>jdbc:derby:data/derby/database-store;create=true</jdbc-connection-url>
+            <bindings-table-name>BINDINGS_TABLE</bindings-table-name>
+            <message-table-name>MESSAGE_TABLE</message-table-name>
+            <large-message-table-name>LARGE_MESSAGES_TABLE</large-message-table-name>
+            <jdbc-driver-class-name>org.apache.derby.jdbc.EmbeddedDriver</jdbc-driver-class-name>
+         </database-store>
+      </store>
+
+
    +
  • jdbc-connection-url

    +

    The full JDBC connection URL for your database server. The connection url should include all configuration parameters and database name. Note: When configuring the server using the XML configuration files please ensure to escape any illegal chars; "&" for example, is typical in JDBC connection url and should be escaped to "&".

    +
  • +
  • bindings-table-name

    +

    The name of the table in which bindings data will be persisted for the ActiveMQ Artemis server. Specifying table names allows users to share single database amongst multiple servers, without interference.

    +
  • +
  • message-table-name

    +

    The name of the table in which bindings data will be persisted for the ActiveMQ Artemis server. Specifying table names allows users to share single database amongst multiple servers, without interference.

    +
  • +
  • large-message-table-name

    +

    The name of the table in which messages and related data will be persisted for the ActiveMQ Artemis server. Specifying table names allows users to share single database amongst multiple servers, without interference.

    +
  • +
  • jdbc-driver-class-name

    +

    The fully qualified class name of the desired database Driver.

    +
  • +
+

Configuring Apache ActiveMQ Artemis for Zero Persistence

+

In some situations, zero persistence is sometimes required for a +messaging system. Configuring Apache ActiveMQ Artemis to perform zero persistence is +straightforward. Simply set the parameter persistence-enabled in +broker.xml to false.

+

Please note that if you set this parameter to false, then zero +persistence will occur. That means no bindings data, message data, large +message data, duplicate id caches or paging data will be persisted.

+ + +
+ +
+
+
+ +

results matching ""

+
    + +
    +
    + +

    No results matching ""

    + +
    +
    +
    + +
    +
    + +
    + + + + + + + + + + + + + + +
    + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Added: websites/production/activemq/content/artemis/docs/1.5.1/pre-acknowledge.html ============================================================================== --- websites/production/activemq/content/artemis/docs/1.5.1/pre-acknowledge.html (added) +++ websites/production/activemq/content/artemis/docs/1.5.1/pre-acknowledge.html Mon Dec 12 16:11:17 2016 @@ -0,0 +1,1078 @@ + + + + + Extra Acknowledge Modes · ActiveMQ Artemis Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + + + +
    + +
    + +
    + + + + + + + + +
    +
    + +
    +
    + +
    + +

    Extra Acknowledge Modes

    +

    JMS specifies 3 acknowledgement modes:

    +
      +
    • AUTO_ACKNOWLEDGE

      +
    • +
    • CLIENT_ACKNOWLEDGE

      +
    • +
    • DUPS_OK_ACKNOWLEDGE

      +
    • +
    +

    Apache ActiveMQ Artemis supports two additional modes: PRE_ACKNOWLEDGE and +INDIVIDUAL_ACKNOWLEDGE

    +

    In some cases you can afford to lose messages in event of failure, so it +would make sense to acknowledge the message on the server before +delivering it to the client.

    +

    This extra mode is supported by Apache ActiveMQ Artemis and will call it +pre-acknowledge mode.

    +

    The disadvantage of acknowledging on the server before delivery is that +the message will be lost if the system crashes after acknowledging the +message on the server but before it is delivered to the client. In +that case, the message is lost and will not be recovered when the system +restart.

    +

    Depending on your messaging case, preAcknowledgement mode can avoid +extra network traffic and CPU at the cost of coping with message loss.

    +

    An example of a use case for pre-acknowledgement is for stock price +update messages. With these messages it might be reasonable to lose a +message in event of crash, since the next price update message will +arrive soon, overriding the previous price.

    +
    +

    Note

    +

    Please note, that if you use pre-acknowledge mode, then you will lose +transactional semantics for messages being consumed, since clearly +they are being acknowledged first on the server, not when you commit +the transaction. This may be stating the obvious but we like to be +clear on these things to avoid confusion!

    +
    +

    Using PRE_ACKNOWLEDGE

    +

    This can be configured in a client's JNDI context environment, e.g. +jndi.properties, like this:

    +
    java.naming.factory.initial=org.apache.activemq.artemis.jndi.ActiveMQInitialContextFactory
    +connection.ConnectionFactory=tcp://localhost:61616?preAcknowledge=true
    +

    Alternatively, to use pre-acknowledgement mode using the JMS API, create +a JMS Session with the ActiveMQSession.PRE_ACKNOWLEDGE constant.

    +
    // messages will be acknowledge on the server *before* being delivered to the client
    +Session session = connection.createSession(false, ActiveMQJMSConstants.PRE_ACKNOWLEDGE);
    +

    Or you can set pre-acknowledge directly on the +ActiveMQConnectionFactory instance using the setter method.

    +

    To use pre-acknowledgement mode using the core API you can set it +directly on the ClientSessionFactory instance using the setter method.

    +

    Individual Acknowledge

    +

    A valid use-case for individual acknowledgement would be when you need +to have your own scheduling and you don't know when your message +processing will be finished. You should prefer having one consumer per +thread worker but this is not possible in some circumstances depending +on how complex is your processing. For that you can use the individual +Acknowledgement.

    +

    You basically setup Individual ACK by creating a session with the +acknowledge mode with ActiveMQJMSConstants.INDIVIDUAL_ACKNOWLEDGE. +Individual ACK inherits all the semantics from Client Acknowledge, with +the exception the message is individually acked.

    +
    +

    Note

    +

    Please note, that to avoid confusion on MDB processing, Individual +ACKNOWLEDGE is not supported through MDBs (or the inbound resource +adapter). this is because you have to finish the process of your +message inside the MDB.

    +
    +

    Example

    +

    See the examples chapter for an example which shows how to use pre-acknowledgement mode with JMS.

    + + +
    + +
    +
    +
    + +

    results matching ""

    +
      + +
      +
      + +

      No results matching ""

      + +
      +
      +
      + +
      +
      + +
      + + + + + + + + + + + + + + +
      + + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +