Instrumenting an Application to Provide Monitoring Data

To instrument an application to provide monitoring data, the application provider has to:

1. Write a monitor-configuration.xml defining the monitoring nodes that have to be installed.

   To create the monitor-configuration.xml, see the monitor-configuration.xml section. The details about the XML syntax can also be found in the document presenting the elements of the monitor-configuration.dtd. The XML file must always be named monitor-configuration.xml as this is how the monitoring framework recognizes it.

   It is very important where this xml file will be placed inside the distribution archive of the resource. For applications, the xml file has to be put in the /META-INF sub-folder inside the EAR.

2. Register resource MBean(s) that provide the monitoring data at runtime.
   1. Acquire a reference to the MBean server
   2. Build ObjectName(s) for the resource MBean(s)
   3. Register the MBean
   4. Send monitoring data actively via JMX notifications
   5. Instrument the application - this section combines the above steps in a complete step-by-step procedure of instrumenting an application with monitoring.

 

See also:

Application Instrumented with Monitoring