Skip to content

Commit

Permalink
ARTEMIS-4486 add missing bits from metrics documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Erwin Dondorp authored and brusdev committed Nov 3, 2023
1 parent 56cd29b commit a6b107d
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/user-manual/metrics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,17 @@ public interface ActiveMQMetricsPlugin extends Serializable {
ActiveMQMetricsPlugin init(Map<String, String> options);

MeterRegistry getRegistry();

default void registered(ActiveMQServer server) { }
}
----
When the broker starts it will call `init` and pass in the `options` which can be specified in XML as key/value properties.
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:
Expand All @@ -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
Expand Down

0 comments on commit a6b107d

Please sign in to comment.