gemmellr commented on code in PR #5258: URL: https://github.com/apache/activemq-artemis/pull/5258#discussion_r1778343611
########## docs/user-manual/configuration-index.adoc: ########## @@ -379,9 +400,16 @@ If set to "true" the passwords are masked. | xref:paging.adoc#max-disk-usage[max-disk-usage] | The max percentage of data we should use from disks. The broker will block while the disk is full. -Disable by setting -1. +Disable by setting `-1`. | 90 +| xref:paging.adoc#minimum-disk-free[min-disk-free] +| Min free bytes on disk below which the system blocks or fails clients. +Supports byte notation like "K", "Mb", "GB", etc. Review Comment: Should the _Mb_ actually be _MB_? I'm guessing its actually case insensitive and so it doesnt necessarily make a difference that it is 'wrong', i.e it doesnt actually allow configuring in bits. Even with that, still seems like the doc should use the Bytes based variant. ########## docs/user-manual/large-messages.adoc: ########## @@ -2,35 +2,68 @@ :idprefix: :idseparator: - -Apache ActiveMQ Artemis can be configured to store messages as files when these messages are beyond a configured value. - -Instead of keeping these messages in memory ActiveMQ Artemis will hold just a thin object on the queues with a reference to a file into a specific folder configured as large-messages-directory. +Apache ActiveMQ Artemis can be configured to give special treatment to messages which are beyond a configured size. +Instead of keeping the entire contents of these messages _in memory_ the broker will hold just a thin object on the queues with a reference to the content (e.g. in a file or a database table). This is supported on Core Protocol and on the AMQP Protocol. == Configuring the server -Large messages are stored on a disk directory on the server side, as configured on the main configuration file. - +When using the xref:persistence.adoc#file-journal-default[file journal] large messages are stored on disk on the server. The configuration property `large-messages-directory` specifies where large messages are stored. -For JDBC persistence the `large-message-table` should be configured. [,xml] ---- -<configuration xmlns="urn:activemq" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="urn:activemq /schema/artemis-server.xsd"> - <core xmlns="urn:activemq:core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:activemq:core"> +<configuration...> + <core...> + ... + <large-messages-directory>data/large-messages</large-messages-directory> + ... + </core> +</configuration> +---- + +By default the large message directory is `data/largemessages`. + +[NOTE] +==== +For the best performance we recommend using the file journal with the large messages directory on a different physical volume to the message journal or paging directory. +==== + +For xref:persistence.adoc#jdbc-persistence[JDBC persistence] the `large-message-table` should be configured. + +[,xml] +---- +<configuration...> + <core...> ... - <large-messages-directory>/data/large-messages</large-messages-directory> + <store> + <database-store> + ... + <large-message-table-name>LARGE_MESSAGES_TABLE</large-message-table-name> + ... + </database-store> + </store> ... </core> </configuration> ---- -By default the large message directory is `data/largemessages` and `large-message-table` is configured as "LARGE_MESSAGE_TABLE". +By default `large-message-table` is configured as `LARGE_MESSAGE_TABLE`. + +By default when writing the final bytes to a large message all writes are synchronized to the storage medium. +This can be configured via `large-message-sync`, e.g.: -For the best performance we recommend using file store with large messages directory stored on a different physical volume to the message journal or paging directory. +[,xml] +---- +<configuration...> + <core...> + ... + <large-message-sync>false</large-message-sync> Review Comment: In the examples above, the value being configured is the same as the noted default. The text here implies the default is true, but this example sets it false. Intended? ########## docs/user-manual/security.adoc: ########## @@ -13,7 +28,6 @@ The size of the caches are controlled by the `authentication-cache-size` and `au Both default to `1000`. How long cache entries are valid is controlled by `security-invalidation-interval`, which is in milliseconds. -Using `0` will disable caching. Review Comment: Should this have moved up to the cache-size entries above, rather than being removed entirely? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: gitbox-unsubscr...@activemq.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: gitbox-unsubscr...@activemq.apache.org For additional commands, e-mail: gitbox-h...@activemq.apache.org For further information, visit: https://activemq.apache.org/contact
