Micronaut JMX

Integrates JMX Monitoring

Version: 4.5.0

1 Introduction

The micronaut-jmx module includes support for exposing Micronaut management endpoints over JMX.

A bean will be created for the management bean server based on configuration.

Table 1. Configuration Properties for JmxConfiguration
Property	Type	Description
`jmx.agent-id`	java.lang.String	If specified, it is expected the {@link javax.management.MBeanServerFactory#findMBeanServer} will return a server. An error will be thrown otherwise.
`jmx.domain`	java.lang.String	Used if {@link #getAgentId()} returns null and {@link java.lang.management.ManagementFactory#getPlatformMBeanServer()} throws an exception.
`jmx.add-to-factory`	boolean	Only used if {@link #getAgentId()} returns null and {@link java.lang.management.ManagementFactory#getPlatformMBeanServer()} throws an exception.
`jmx.ignore-agent-not-found`	boolean	If a server could not be found with the {@link #agentId}, an exception will be thrown unless this method returns true.
`jmx.register-endpoints`	boolean	If management beans should be registered for endpoints.

For this project, you can find a list of releases (with release notes) here:

implementation("io.micronaut.jmx:micronaut-jmx")

<dependency>
    <groupId>io.micronaut.jmx</groupId>
    <artifactId>micronaut-jmx</artifactId>
</dependency>

If the management dependency is also on the classpath, management beans will be created for all endpoints by default.

You can find the source code of this project in this repository: