Skip to content

Commit cc48b94

Browse files
committed
NO-JIRA reference the status attribute for details about errors applying properties
1 parent d6f9024 commit cc48b94

2 files changed

Lines changed: 9 additions & 4 deletions

File tree

docs/user-manual/configuration-index.adoc

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ acceptorConfigurations.tcp.params.port=61616
116116
. set the acceptor named "tcp" 'PORT' parameter to 61616
117117

118118
==== Attribute Names with Dots
119-
Dots are significant in property keys because they identify the nesting level. If attribute names contain dots those need to be quoted. The default quote string is specified via the property key.surround and has a default value of the double quote character: ".
119+
Dots are significant in property keys because they identify the nesting level. If attribute names contain dots those need to be quoted. The quote string is specified via the property `key.surround` and has a default value of the double quote character: `"`.
120120

121121
An address setting, where the address contains dots, would be a typical example where quoting is required:
122122
----
@@ -129,10 +129,13 @@ With great power one must take great care!
129129

130130
The `artemis run` command script supports `--properties <properties file url>`, where a properties file can be configured.
131131

132-
NOTE: one shortcoming of this method of configuration is that any property that does not match is ignored with no fanfare.
133-
Enable debug logging for `org.apache.activemq.artemis.core.config.impl.ConfigurationImpl` to get more insight.
132+
There is a related xref:management.adoc#server-management[server management operation] `exportConfigAsProperties` that will export the current configuration as broker properties. Use this to get a better understanding of how properties apply to the broker configuration and how they map from xml.
134133

135-
There is a related xref:management.adoc#server-management[server management operation], `exportConfigAsProperties` that will export the current configuration as broker properties. Use this to get a better understanding of how properties apply to the broker configuration and how they map from xml.
134+
==== Error reporting
135+
The free form text format of a java properties file and the inexact mapping from xml attribute to key=value can make it tricky to correctly configure broker properties.
136+
Properties that don't match or fail to apply are tracked through the status attribute of the broker, visible through the xref:management.adoc#server-management[server management operation] `getStatus`.
137+
138+
More detailed information can also be obtained through debug logging of the `org.apache.activemq.artemis.core.config.impl.ConfigurationImpl` class.
136139

137140
== The core configuration
138141

docs/user-manual/management.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,8 @@ Since this method actually stops the server you will probably receive some sort
9494
The broker's tmp dir is configured via the system property `java.io.tmpdir`. The default value, set via the launch scripts, is `$ARTEMIS_INSTANCE/tmp`.
9595
====
9696

97+
* The status the broker, a json string, can be obtained through the `getStatus()` operation. The status includes identity, uptime, activation state and information about broker properties configuration and reload.
98+
9799
=== Address Management
98100

99101
Individual addresses can be managed using the `AddressControl` interface.

0 commit comments

Comments
 (0)