{"id":2179,"date":"2012-08-01T21:15:06","date_gmt":"2012-08-01T21:15:06","guid":{"rendered":"http:\/\/dalelane.co.uk\/blog\/?p=2179"},"modified":"2012-08-01T21:15:43","modified_gmt":"2012-08-01T21:15:43","slug":"using-jmx-to-monitor-uima-running-in-a-servlet","status":"publish","type":"post","link":"https:\/\/dalelane.co.uk\/blog\/?p=2179","title":{"rendered":"Using JMX to monitor UIMA running in a servlet"},"content":{"rendered":"

Overview<\/strong><\/p>\n

A quick howto for if you’re running UIMA in a servlet, and want to be able to monitor your AE performance using JMX<\/p>\n

Background<\/strong><\/p>\n

I’ve mentioned JMX<\/strong><\/a> before. Basically, a Java app can expose information and methods through a standard interface<\/a>. Tools like jconsole<\/a>, which come with Java, can then be used to monitor and administer the Java app. <\/p>\n

UIMA<\/strong> (Unstructured Information Management Architecture)<\/a> is an Apache project, providing a standards-based way to perform analytics on unstructured text. It hosts a pipeline of annotators<\/a>: individual components each performing a specific text analytics task. As a document moves down the pipeline UIMA runs each of the annotators on the document. Each annotator adds it’s own annotations for the things it looks for in the text. <\/p>\n

UIMA and JMX<\/strong><\/p>\n

UIMA supports JMX. UIMA registers an MBean<\/code> for each annotator<\/a>, letting you see the performance info for each annotator. In a pipeline of several annotators, it lets you see (amongst other things) how much time your document is spending in each annotator. <\/p>\n

\"jconsole\"\/<\/p>\n

In a stand-alone UIMA application, you basically get this for free<\/a>. Start the application with the standard Java -D<\/code> property for enabling JMX:<\/p>\n

-Dcom.sun.management.jmxremote<\/pre>\n
It is ready to let jconsole connect to it. <\/p>\n
UIMA in a servlet<\/strong><\/p>\n
For a current project, I’m running a UIMA pipeline in a Java servlet on Tomcat. I need to run the server with the JMX property, but there is slightly more to it than that. <\/p>\n
Basically, you need to manually register the analysis engine pipeline with JMX. From there, UIMA will handle registering all of the annotators and other components in the pipeline. <\/p>\n
Because the servlet can be started and stopped separate from the server as a whole, the easiest way to do this is from a ServletContextListener<\/code><\/a>. <\/p>\n
Step 1:<\/strong> Register the context listener <\/p>\n
Add something like this to your web.xml<\/p>\n
<listener>\r\n    <listener-class>com.dalelane.uima.myapp.PipelineJMXMonitor<\/listener-class>\r\n<\/listener><\/pre>\n
Step 2:<\/strong> Create the context listener<\/p>\n
If you get a handle to your UIMA AnalysisEngine<\/a>, it has a method  getManagementInterface()<\/code><\/a> for getting the JMX management interface. <\/p>\n
In your context listener’s contextInitialised<\/code> method, you can register this interface with the MBean server. In the context listener’s contextDestroyed<\/code> method, you need to unregister it. <\/p>\n
package com.dalelane.uima.myapp;\r\n\r\nimport java.util.List;\r\n\r\nimport javax.management.MBeanServer;\r\nimport javax.management.MBeanServerFactory;\r\nimport javax.management.ObjectName;\r\nimport javax.servlet.ServletContextEvent;\r\nimport javax.servlet.ServletContextListener;\r\n\r\nimport com.dalelane.uima.MyPipelineService;\r\n\r\npublic class PipelineJMXMonitor implements ServletContextListener {\r\n\r\n  @Override\r\n  public void contextInitialized(ServletContextEvent sce) {\r\n    try {\r\n      getMBeanServer().registerMBean(\r\n          MyPipelineService.getInstance().analysisEngine.getManagementInterface(),\r\n          new ObjectName(\"Application:Name=MyUIMAApp,Type=Server\"));\r\n    }\r\n    catch (Exception e){\r\n      e.printStackTrace();\r\n    }\r\n  }\r\n  \r\n  @Override\r\n  public void contextDestroyed(ServletContextEvent sce) {\r\n    try {\r\n      getMBeanServer().unregisterMBean(\r\n          new ObjectName(\"Application:Name=MyUIMAApp,Type=Server\"));\r\n    } \r\n    catch (Exception e) {\r\n      e.printStackTrace();\r\n    } \r\n  }\r\n\r\n  private MBeanServer getMBeanServer(){\r\n    List<MBeanServer> servers = MBeanServerFactory.findMBeanServer(null);\r\n    return servers.get(0);\r\n  }\r\n}<\/pre>\n
Step 3:<\/strong> Start the server<\/p>\n
Start the server with the -Dcom.sun.management.jmxremote<\/code> option, and it’ll be ready for using jconsole to monitor it. <\/p>\n","protected":false},"excerpt":{"rendered":"
Overview A quick howto for if you’re running UIMA in a servlet, and want to be able to monitor your AE performance using JMX Background I’ve mentioned JMX before. Basically, a Java app can expose information and methods through a standard interface. Tools like jconsole, which come with Java, can then be used to monitor […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[7],"tags":[219,517,534,535,533],"class_list":["post-2179","post","type-post","status-publish","format-standard","hentry","category-code","tag-java","tag-jmx","tag-servlet","tag-tomcat","tag-uima"],"_links":{"self":[{"href":"https:\/\/dalelane.co.uk\/blog\/index.php?rest_route=\/wp\/v2\/posts\/2179","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/dalelane.co.uk\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/dalelane.co.uk\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/dalelane.co.uk\/blog\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/dalelane.co.uk\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=2179"}],"version-history":[{"count":0,"href":"https:\/\/dalelane.co.uk\/blog\/index.php?rest_route=\/wp\/v2\/posts\/2179\/revisions"}],"wp:attachment":[{"href":"https:\/\/dalelane.co.uk\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=2179"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dalelane.co.uk\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=2179"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dalelane.co.uk\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=2179"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}