Search code examples
javarestjmxspring-jmx

JMX and REST API. How can I build a bridge between them?


I have written a code which exposes data from my JVM application via JMX Bean. I can see these values in JConsole. How can I grab these values from jconsole, do I need to write another program.

And also, how can I use REST API to display these JMX Bean data to Rich UI format?

I have used Jolokia and I am getting this reply. I am not getting any info.

I used the jolokia as JVM argument in my code. But the only reply I am getting is this

{
timestamp: 1411988073,
status: 200,
request: {
type: "version"
},
value: {
protocol: "7.2",
config: {
maxDepth: "15",
maxCollectionSize: "1000",
maxObjects: "0",
discoveryEnabled: "true",
agentContext: "/jolokia",
historyMaxEntries: "10",
agentId: "10.91.240.11-4524-5f2e712f-jvm",
agentType: "jvm",
debug: "false",
debugMaxEntries: "100"
},
agent: "1.2.2",
info: { }
}
}

Why there is no info?

My code goes like this:

/*
 * Main.java - main class for the Hello MBean and QueueSampler MXBean example.
 * Create the Hello MBean and QueueSampler MXBean, register them in the platform
 * MBean server, then wait forever (or until the program is interrupted).
 */

package com.example;

public class Main implements HelloMBean {
public static void main(String[] args) throws Exception {
    // Get the Platform MBean Server
    MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();

    // Construct the ObjectName for the Hello MBean we will register
    ObjectName mbeanName = new ObjectName(
            "com.example:type=Tiger, name=Info");

    // Create the Hello World MBean
    Hello mbean = new Hello();
    System.out.println(mbean);
    System.out.println(mbeanName);
    // Register the Hello World MBean
    mbs.registerMBean(mbean, mbeanName);
    if (System.getProperty("com.sun.management.jmxremote") == null) {
        System.out.println("JMX remote is disabled");
    } else {
        String portString = System.getProperty("com.sun.management.jmxremote.port");
        if (portString != null) {
            System.out.println("JMX running on port "
                + Integer.parseInt(portString));
        }}


    // Wait forever
    System.out.println("Waiting for incoming requests...");
    Thread.sleep(Long.MAX_VALUE);
}

/*
 * private final String name = "Reginald"; private int cacheSize =
 * DEFAULT_CACHE_SIZE; private static final int DEFAULT_CACHE_SIZE = 200;
 */
@Override
public void sayHello() {
    // TODO Auto-generated method stub

}

@Override
public int add(int x, int y) {
    // TODO Auto-generated method stub
    return 0;
}

@Override
public String getName() {
    // TODO Auto-generated method stub
    return null;
}

@Override
public int getCacheSize() {
    // TODO Auto-generated method stub
    return 0;
}

@Override
public void setCacheSize(int size) {
    // TODO Auto-generated method stub

}
}

The interface is :

package com.example;

public interface HelloMBean {
public void sayHello();
public int add(int x, int y);
public String getName();

// a read-write attribute called CacheSize of type int
public int getCacheSize();
public void setCacheSize(int size);
}

And the implementation as this:

package com.example;

import javax.management.*;

public class Hello
extends NotificationBroadcasterSupport implements HelloMBean {

public void sayHello() {
System.out.println("hello, world");
}

public int add(int x, int y) {
return x + y;
}


public String getName() {
return this.name;
}


public int getCacheSize() {
return this.cacheSize;
}

public synchronized void setCacheSize(int size) {
int oldSize = this.cacheSize;
this.cacheSize = size;


System.out.println("Cache size now " + this.cacheSize);


Notification n =
    new AttributeChangeNotification(this,
                    sequenceNumber++,
                    System.currentTimeMillis(),
                    "CacheSize changed",
                    "CacheSize",
                    "int",
                    oldSize,
                    this.cacheSize);


sendNotification(n);
}

@Override
public MBeanNotificationInfo[] getNotificationInfo() {
String[] types = new String[] {
    AttributeChangeNotification.ATTRIBUTE_CHANGE
};
String name = AttributeChangeNotification.class.getName();
String description = "An attribute of this MBean has changed";
MBeanNotificationInfo info =
    new MBeanNotificationInfo(types, name, description);
return new MBeanNotificationInfo[] {info};
}

private final String name = "Reginald";
private int cacheSize = DEFAULT_CACHE_SIZE;
private static final int DEFAULT_CACHE_SIZE = 200;


private long sequenceNumber = 1;
}

Solution

  • Take a look a Jolokia; it exposes MBeans as JSON over HTTP...

    ... It is an agent based approach, living side by side with JSR-160, but uses the much more open HTTP for its transport business where the data payload is serialized in JSON. This opens a whole new world for different, non-Java clients. Beside this protocol switch, Jolokia provides new features for JMX remoting, which are not available in JSR-160 connectors: Bulk requests allow for multiple JMX operations with a single remote server roundtrip. A fine grained security mechanism can restrict the JMX access on specific JMX operations. Other features like the JSR-160 proxy mode or history tracking are specific to Jolokia, too.

    EDIT:

    You need to issue a query; e.g. if your domain is test (e.g. an MBean with object name test:name=counter, issue this query http://127.0.0.1:7777/jolokia/read/test:name=counter.

    Or, use http://127.0.0.1:7777/jolokia/read/test:* and you'll get all MBeans under the test domain.

    See the documentation.