This is an automated email from the ASF dual-hosted git repository. robbie pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/activemq-artemis.git
commit 729682390540b172894a20b3f9bf6cf166640052 Author: Gary Tully <[email protected]> AuthorDate: Tue Sep 16 12:48:22 2025 +0100 NO-JIRA reference the status attribute for details about errors applying properties --- docs/user-manual/configuration-index.adoc | 23 ++++++++++++++--------- docs/user-manual/management.adoc | 2 ++ 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/docs/user-manual/configuration-index.adoc b/docs/user-manual/configuration-index.adoc index 9994c052e6..8b8805b78e 100644 --- a/docs/user-manual/configuration-index.adoc +++ b/docs/user-manual/configuration-index.adoc @@ -115,24 +115,29 @@ acceptorConfigurations.tcp.params.port=61616 . set the acceptor named "tcp" 'HOST' parameter to localhost . set the acceptor named "tcp" 'PORT' parameter to 61616 +==== Usage + +The `artemis run` command script supports `--properties <properties file url>`, where a properties file can be configured. + +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. + ==== Attribute Names with Dots -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: ". +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: `"`. An address setting, where the address contains dots, would be a typical example where quoting is required: ---- addressSettings."Address.Name.With.Dots".expiryAddress=expiredMessages ---- -The configuration properties are very low level, lower level than xml, which makes them very powerful. -Any accessible attribute of the internal `org.apache.activemq.artemis.core.config.impl.ConfigurationImpl` objects can be modified. -With great power one must take great care! - -The `artemis run` command script supports `--properties <properties file url>`, where a properties file can be configured. +==== Error reporting +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. +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`. -NOTE: one shortcoming of this method of configuration is that any property that does not match is ignored with no fanfare. -Enable debug logging for `org.apache.activemq.artemis.core.config.impl.ConfigurationImpl` to get more insight. +More detailed information can also be obtained through debug logging of the `org.apache.activemq.artemis.core.config.impl.ConfigurationImpl` class. -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. +NOTE: The configuration properties are very low level, lower level than xml, which makes them very powerful. +Any accessible attribute of the internal `org.apache.activemq.artemis.core.config.impl.ConfigurationImpl` objects can be modified. +With great power one must take great care! == The core configuration diff --git a/docs/user-manual/management.adoc b/docs/user-manual/management.adoc index 479c8328f8..3a430a71ff 100644 --- a/docs/user-manual/management.adoc +++ b/docs/user-manual/management.adoc @@ -94,6 +94,8 @@ Since this method actually stops the server you will probably receive some sort 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`. ==== +* The status of 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. + === Address Management Individual addresses can be managed using the `AddressControl` interface. --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected] For further information, visit: https://activemq.apache.org/contact
