This is an automated email from the ASF dual-hosted git repository.
brusdev pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/activemq-artemis.git
The following commit(s) were added to refs/heads/main by this push:
new a6b107dd8a ARTEMIS-4486 add missing bits from metrics documentation
a6b107dd8a is described below
commit a6b107dd8af8024aee5d3e19bf515a107f63c974
Author: Erwin Dondorp <[email protected]>
AuthorDate: Thu Nov 2 16:48:09 2023 +0100
ARTEMIS-4486 add missing bits from metrics documentation
---
docs/user-manual/metrics.adoc | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/docs/user-manual/metrics.adoc b/docs/user-manual/metrics.adoc
index 8ba91def22..e94cdc4709 100644
--- a/docs/user-manual/metrics.adoc
+++ b/docs/user-manual/metrics.adoc
@@ -16,6 +16,8 @@ public interface ActiveMQMetricsPlugin extends Serializable {
ActiveMQMetricsPlugin init(Map<String, String> options);
MeterRegistry getRegistry();
+
+ default void registered(ActiveMQServer server) { }
}
----
@@ -23,6 +25,8 @@ When the broker starts it will call `init` and pass in the
`options` which can b
At this point the plugin should instantiate and configure the
`io.micrometer.core.instrument.MeterRegistry` implementation.
Later during the broker startup process it will call `getRegistry` in order to
get the `MeterRegistry` implementation and use it for registering meters.
+Once registered, it will call `registered` to provide the plugin with a handle
to the server.
+The plugin can then use that handle later to inspect whether the broker is
operational and not in a startup or shutdown phase.
The broker ships with two `ActiveMQMetricsPlugin` implementations:
@@ -46,11 +50,15 @@ A description for each metric is exported along with the
metric itself therefore
* connection.count
* total.connection.count
* address.memory.usage
+* address.memory.usage.percentage
+* disk.store.usage
=== Address
* routed.message.count
* unrouted.message.count
+* address.size
+* number.of.pages
=== Queue
