jmx-utils's Introduction

jmx-utils

This library will help you in getting all the registered metrics in the JMX MbeanServer.

If you are looking for getting all the metrics from JMX MbeanServer and do some stuffs with that, like writing a metric reporter, then this is the library you are looking for.

Maven Dependency

Use the following repository

<repository>
    <id>clojars</id>
    <name>Clojars repository</name>
    <url>https://clojars.org/repo</url>
</repository>

Use the following maven dependency

<dependency>
    <groupId>com.geek-vivek.jmx</groupId>
    <artifactId>jmx-utils</artifactId>
    <version>1.0.0</version>
</dependency>

How to Use ?

First you need to create a class by implementing JmxMetricsListener interface.

    import com.geekvivek.jmx.utils.JmxMetric;
    import com.geekvivek.jmx.utils.interfaces.JmxMetricsListener;

    class MetricReporter1 implements JmxMetricsListener {
        @Override
        public void metricChange(JmxMetric metric){ /*do stuffs on receiving new metrics*/ }
        @Override
        public void metricRemoval(JmxMetric metric){ /* do stuffs when a metrics is removed from JMX */}
        @Override
        public void close(){ /* do stuffs when application is closing */}
    }

Now create an instance of MetricReporter1 and pass it to JmxMetricProviderService and start the JmxMetricProviderService

    import com.geekvivek.jmx.utils.service.JmxMetricProviderService;
    ...
    new JmxMetricProviderService(Collections.singletonList(
        new MetricReporter1()
    )).start(10, 60, TimeUnit.SECONDS);