Learn how to send JMX data to Wavefront.

You can monitor Java applications that use JMX by either by setting up Jolokia and Telegraf or by using JMXTrans to send data directly to a Wavefront proxy.

Telegraf-based Integration

In the Telegraf-based integration you run Jolokia, which exposes JMX data as JSON on an HTTP port (8778 by default), and configure the Jolokia input plugin in Telegraf.

Download and Set up Jolokia

  1. Download the JVM-Agent artifact from Jolokia – Download. Jolokia 1.3.6 is the current version as of this writing.
  2. Save Jolokia to /opt/jolokia or any location accessible to the application.
  3. Configure the application to use Jolokia.
    1. Add the following line to the application startup script:
      JVM_OPTS="$JVM_OPTS -javaagent:/opt/jolokia/jolokia-jvm-1.3.6-agent.jar"
      

      Change /opt/jolokia if you saved it elsewhere.

    2. Restart the node running the application.
    3. Verify that you can access Jolokia on port 8778 by running:
      curl http://localhost:8778/jolokia/
      

      If you receive a JSON response then Jolokia is working.

Configure Telegraf

  1. Add the application configuration to your Telegraf configuration.
  2. Restart Telegraf.

JMXTrans-based Integration

While you can configure JMXTrans to retrieve JMX data from multiple JVMs and specific managed beans (MBeans), this section gets you up and running very quickly with a very simple and generic JMXTrans configuration that will send all of the JMX data from a single JVM to Wavefront. You can then browse the data within Wavefront and decide which MBeans are relevant for your use case and fine tune the JMXTrans configuration.

Enable JMX for a JVM

Enable JMX following the instructions on the JMXTrans GitHub repository. The sample JMXTrans configuration assumes JMX has been configured following these instructions, i.e. JMX is listening on port 1105 and does not require a username/password. In a production setting, you will likely require additional security. See JMX Best Practices for more details on configuring both JMX and JMXTrans.

Create a Generic JMXTrans Configuration

By default JMXTrans looks for configuration files (specifying JMX servers and ManagedBean queries) in the directory /var/lib/jmxtrans. The JMXTrans package installer runs JMXTrans after installation, so if you put your configuration file in place ahead of time, the data will start flowing to Wavefront right away. Place the following file in /var/lib/jmxtrans/all.json:

{"servers" : [ {         
  "port" : "1105",         
  "host" : "localhost",         
  "alias" : "my_host_name_in_wavefront_underscores_will_be_replaced_by_dots",         
  "queries" : [ { 
    "obj" : "", 
    "useObjDomainAsKey" : true, 
    "allowDottedKeys" : true, 
    "outputWriters" : [ { 
      "@class" : "com.googlecode.jmxtrans.model.output.GraphiteWriter", 
      "settings" : { 
        "port" : 2003, 
        "host" : "localhost", 
        "rootPrefix" : "jmx",
        "booleanAsNumber" : true, 
        "typeNames" : ["name", "type"] } 
      } ] 
    } ]
  } ] 
}

You may need to edit:

  • host - There are two host definitions in the file. The first, directly under servers, is the host of your JMX server. The second, under outputWriters is the host of your Wavefront proxy. These have both been defaulted to localhost in the sample configuration.
  • alias - Replace this with the host that you want to appear in Wavefront. Note that Wavefront hosts don’t have to be machines per se, they are just intended to be a unique source of data. So this could just as well be the name of the application you are monitoring as the host you are running on.
  • rootPrefix - It’s a good best practice to organize your Wavefront metrics in a hierarchy. Use this prefix to to specify the root metric node for your JMX data. Unlike collectd you don’t need to include a trailing . character.
  • obj - Note that obj is an empty string. This causes JMXTrans to retrieve all available MBeans and not filter them in any way.

Install and Run JMXTrans

  1. Download an appropriate install medium for your Linux distribution.
  2. Follow the installation instructions.
  3. If you install using one of the packages JMXTrans will start after the install process. Your data should immediately start flowing into Wavefront.

View the Data in Wavefront

  1. Log in to Wavefront and navigate to Browse > Sources. You should see the alias defined in your all.json file listed there.
  2. After a short amount of time, you should see the metrics appearing under Browse > Metrics. They will be prefixed with the rootPrefix setting from your all.json file.
    • By default, JMXTrans retrieves the latest JMX information every 60 seconds.
    • When you first start sending a new metric to Wavefront, it will take a short period of time for the system to index it. After this initial period, new JMX data will appear in your charts within a second or so.
  3. Click the Create Dashboard button to see your JMX data in a Wavefront dashboard.

Next Steps

JMXTrans is highly configurable. Take a look at the documentation if you want to tweak your configuration to retrieve only certain ManagedBeans or have things named differently within Wavefront.