Calling JMX MBean method from a shell script

Question

Are there any libraries that would allow me to call a JMX MBean method from a shell script  We expose some operations admin commands through JMX  and we could have our admins use JConsole  or VisualVM  but some tasks are better left to automation  In that automation we d like to be able to call a JMX MBean method on our running server  preferably from a shell script

User · Answer

I ve developed jmxfuse which exposes JMX Mbeans as a Linux FUSE filesystem with similar functionality as the  proc fs  It relies on Jolokia as the bridge to JMX  Attributes and operations are exposed for reading and writing   http   code google com p jmxfuse   For example  to read an attribute   me oddjob jmx  cd log4j root attributes me oddjob jmx  cat priority   to write an attribute   me oddjob jmx  echo  WARN   gt  priority   to invoke an operation   me oddjob jmx  cd Catalina none none WebModule localhost helloworld operations addParameter me oddjob jmx  echo  myParam myValue   gt  invoke

User · Answer

You might want also to have a look at jmx4perl  It provides java-less access to a remote Java EE Server s MBeans  However  a small agent servlet needs to be installed on the target platform  which provides a restful JMX Access via HTTP with a JSON payload   Version 0 50 will add an agentless mode by implementing a JSR-160 proxy    Advantages are quick startup times compared to launching a local java JVM and ease of use  jmx4perl comes with a full set of Perl modules which can be easily used in your own scripts   use JMX  Jmx4Perl  use JMX  Jmx4Perl  Alias      Import certains aliases for MBeans  print  Memory Used           JMX  Jmx4Perl           - gt new url   gt   http   localhost 8080 j4p             - gt get attribute MEMORY HEAP USED     You can also use alias for common MBean Attribute Operation combos  e g  for most MXBeans    For additional features  Nagios-Plugin  XPath-like access to complex attribute types        please refer to the documentation of jmx4perl

User · Answer

Take a look at JManage  It s able to execute MBean methods and get   set attributes from command line

User · Answer

Dougnukem answer helped me a lot  I have taken the Groovy approach  using groovy 2 3 3    I did some changes on Dougnukem code  This will work with Java 7 and will print two attributes to stdout every 10 sec           package com my company jmx         import groovy util GroovyMBean          import javax management remote JMXServiceURL         import javax management remote JMXConnectorFactory         import java lang management                class Monitor                   static main args                        def serverUrl    service jmx rmi    jndi rmi   localhost 5019 jmxrmi                      String beanName    Catalina type DataSource class javax sql DataSource name   jdbc CommonDB                        println   numIdle numActive                       while 1                           def server   JMXConnectorFactory connect new JMXServiceURL serverUrl                            make sure to reconnect in case the jvm was restrated                          server connect                           GroovyMBean mbean   new GroovyMBean server MBeanServerConnection  beanName                          println     mbean numIdle    mbean numActive                           server close                           sleep 10000                                                           Compile this code into a jar using maven-compiler-plugin so you will not require groovy installation only the groovy-all jar   Below is the relevant plugin definition and dependency       lt build gt           lt plugins gt               lt plugin gt                   lt groupId gt org apache maven plugins lt  groupId gt                   lt artifactId gt maven-compiler-plugin lt  artifactId gt                   lt configuration gt                       lt compilerId gt groovy-eclipse-compiler lt  compilerId gt                       lt source gt 1 7 lt  source gt                       lt target gt 1 7 lt  target gt                   lt  configuration gt                   lt dependencies gt                       lt dependency gt                           lt groupId gt org codehaus groovy lt  groupId gt                           lt artifactId gt groovy-eclipse-compiler lt  artifactId gt                           lt version gt 2 8 0-01 lt  version gt                       lt  dependency gt                       lt dependency gt                           lt groupId gt org codehaus groovy lt  groupId gt                           lt artifactId gt groovy-eclipse-batch lt  artifactId gt                           lt version gt 2 3 4-01 lt  version gt                       lt  dependency gt                   lt  dependencies gt               lt  plugin gt           lt  plugins gt       lt  build gt       lt dependencies gt           lt dependency gt               lt groupId gt org codehaus groovy lt  groupId gt               lt artifactId gt groovy-all lt  artifactId gt               lt version gt 2 4 3 lt  version gt           lt  dependency gt       lt  dependencies gt    Wrap it with a bat or a shell and it will print the data to stdout

User · Answer

The following command line JMX utilities are available    jmxterm - seems to be the most fully featured utility  cmdline-jmxclient - used in the WebArchive project seems very bare bones  and no development since 2006 it looks like  Groovy script and JMX - provides some really powerful JMX functionality but requires groovy and other library setup  JManage command line functionality -  downside is that it requires a running JManage server to proxy commands through    Groovy JMX Example   import java lang management   import javax management ObjectName import javax management remote JMXConnectorFactory as JmxFactory import javax management remote JMXServiceURL as JmxUrl  def serverUrl    service jmx rmi    jndi rmi   localhost 9003 jmxrmi  String beanName    com webwars gameplatform data type udmdataloadsystem id 0  def server   JmxFactory connect new JmxUrl serverUrl   MBeanServerConnection def dataSystem   new GroovyMBean server  beanName   println  Connected to  n dataSystem n   println  Executing jmxForceRefresh    dataSystem jmxForceRefresh      cmdline-jmxclient example   If you have an    MBean  com company data type datasystem id 0   With an Operation called    jmxForceRefresh     Then you can write a simple bash script  assuming you download cmdline-jmxclient-0 10 3 jar and put in the same directory as your script       bin bash  cmdLineJMXJar   cmdline-jmxclient-0 10 3 jar user yourUser password yourPassword jmxHost localhost port 9003   No User and password so pass  -  echo  Available Operations for com company data type datasystem id 0  java -jar   cmdLineJMXJar    user    password    jmxHost    port  com company data type datasystem id 0  echo  Executing XML update     java -jar   cmdLineJMXJar  -   jmxHost    port  com company data type datasystem id 0 jmxForceRefresh

User · Answer

A little risky  but you could run a curl POST command with the values from the form from the JMX console  its URL and http authentication  if required    curl -s -X POST --user  myuser mypass    --data  action invokeOp amp name App service ThisServiceOp amp methodIndex 3 amp arg0 value1 amp arg1 value1 amp submit Invoke    http   yourhost domain com jmx-console HtmlAdaptor   Beware  the method index may change with changes to the software  And the implementation of the web form could change   The above is based on source of the JMX service page for the operation you want to perform   http   yourhost domain com jmx-console HtmlAdaptor action inspectMBean amp name YourJMXServiceName   Source of the form   form method  post  action  HtmlAdaptor  gt      lt input type  hidden  name  action  value  invokeOp  gt      lt input type  hidden  name  name  value  App service ThisServiceOp  gt      lt input type  hidden  name  methodIndex  value  3  gt      lt hr align  left  width  80  gt      lt h4 gt void ThisOperation   lt  h4 gt      lt p gt Operation exposed for management lt  p gt       lt table cellspacing  2  cellpadding  2  border  1  gt           lt tr class  OperationHeader  gt               lt th gt Param lt  th gt               lt th gt ParamType lt  th gt               lt th gt ParamValue lt  th gt               lt th gt ParamDescription lt  th gt           lt  tr gt           lt tr gt               lt td gt p1 lt  td gt              lt td gt java lang String lt  td gt            lt td gt                lt input type  text  name  arg0  gt            lt  td gt            lt td gt  no description  lt  td gt           lt  tr gt           lt tr gt               lt td gt p2 lt  td gt              lt td gt arg1Type lt  td gt            lt td gt                lt input type  text  name  arg1  gt            lt  td gt            lt td gt  no description  lt  td gt           lt  tr gt       lt  table gt       lt input type  submit  value  Invoke  gt   lt  form gt

User · Answer

I m not sure about bash-like environment   You might try some simple wrapper programs in Java  with program arguments  that invoke your MBeans on the remote server   You can then call these wrappers from the shell script  If you can use something like Python or Perl  you might be interested in JSR-262 which allows you to expose JMX operations over web services   This is scheduled to be included in Java 7 but you might be able to use a release candidate of the reference implementation

User · Answer

Potentially its easiest to write this in Java import javax management    import javax management remote     public class JmxInvoke        public static void main String    args  throws Exception           JMXConnectorFactory connect new JMXServiceURL args 0                 getMBeanServerConnection   invoke new ObjectName args 1    args 2   new Object      new String                     This would compile to a single  class and needs no dependencies in server or any complicated maven packaging  call it with javac JmxInvoke java java -cp   JmxInvoke  url   beanName   method

User · Answer

The Syabru Nagios JMX plugin is meant to be used from Nagios  but doesn t require Nagios and is very convenient for command-line use         check jmx -U service jmx rmi    jndi rmi   localhost 1099 JMXConnector --username myuser --password mypass -O java lang type Memory -A HeapMemoryUsage -K used  JMX OK - HeapMemoryUsage used   445012360    HeapMemoryUsage used  445012360

[java] Calling JMX MBean method from a shell script

Examples related to java

Examples related to sysadmin

Examples related to jmx