[jira] [Comment Edited] (ARTEMIS-2246) Documentation for configuration max-disk-usage is inaccurate.

["Justin Bertram (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/ARTEMIS-2246?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16761376#comment-16761376 ] 

Justin Bertram edited comment on ARTEMIS-2246 at 2/6/19 9:41 PM:
-----------------------------------------------------------------

Technically speaking the documentation is accurate. The default {{max-disk-usage}} is {{100}} as can be seen in [the code|https://github.com/apache/activemq-artemis/blob/master/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/config/ActiveMQDefaultConfiguration.java#L470]. Therefore, if {{max-disk-usage}} is *not set* in the broker configuration it will default to {{100}}. However, this default [is overridden|https://github.com/apache/activemq-artemis/blob/master/artemis-cli/src/main/resources/org/apache/activemq/artemis/cli/commands/etc/broker.xml#L63] out of the box in broker.xml. This setting is accompanied by a comment which explains the behavior so it wouldn't have been necessary to review all the default configuration values but simply to look at the broker.xml.

That said, the documentation should be clarified.


was (Author: jbertram):
Technically speaking the documentation is accurate. The default {{max-disk-usage}} is {{100}} as can be seen in [the code|https://github.com/apache/activemq-artemis/blob/master/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/config/ActiveMQDefaultConfiguration.java#L470]. Therefore, is {{max-disk-usage}} is *not set* in the broker configuration it will default to {{100}}. However, this default [is overridden|https://github.com/apache/activemq-artemis/blob/master/artemis-cli/src/main/resources/org/apache/activemq/artemis/cli/commands/etc/broker.xml#L63] out of the box in broker.xml. This setting is accompanied by a comment which explains the behavior so it wouldn't have been necessary to review all the default configuration values but simply to look at the broker.xml.

That said, the documentation should be clarified.

> Documentation for configuration max-disk-usage is inaccurate.
> -------------------------------------------------------------
>
>                 Key: ARTEMIS-2246
>                 URL: https://issues.apache.org/jira/browse/ARTEMIS-2246
>             Project: ActiveMQ Artemis
>          Issue Type: Bug
>    Affects Versions: 2.6.4
>            Reporter: Leo Provido
>            Priority: Major
>
> During the execution of tests involving sending messages to the System, we observed that the System started blocking messages before the disk is full.
> According to the Configuration Reference ([https://activemq.apache.org/artemis/docs/1.4.0/configuration-index.html]) documentation, the default value of the configuration max-disk-usage is 100. However, we discovered that the actual default value of max-disk-usage is 90. The file inspected is ./etc/broker.xml. Thus, the documentation is deemed inaccurate.
> We have the opinion that severity of this incident is Major because a) the documentation provides an inaccurate piece of information that influences the way we design our mitigation strategies for risks surrounding hardware resources utilization, and b) we don’t necessarily have the bandwidth to review all default configuration values.
> Inaccurate information may cause failure to provide message brokering services despite mitigation strategies being in place.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)