从 shell 脚本调用 JMX MBean 方法

Posted 2023-02-16

【中文标题】从 shell 脚本调用 JMX MBean 方法

【英文标题】：Calling JMX MBean method from a shell script

【发布时间】：2009-11-17 19:20:26

【问题描述】：

是否有任何库允许我。我们通过 JMX 公开一些操作/管理命令，我们可以让我们的管理员使用 JConsole 或 VisualVM，但有些任务最好留给自动化。在这种自动化中，我们希望能够在正在运行的服务器上调用 JMX MBean 方法，最好是从 shell 脚本中调用。

【参考方案1】：

以下命令行 JMX 实用程序可用：

jmxterm - 似乎是功能最齐全的实用程序。 cmdline-jmxclient - 在 WebArchive 项目中使用似乎非常简单（看起来自 2006 年以来没有任何开发） Groovy script and JMX - 提供了一些非常强大的 JMX 功能，但需要 groovy 和其他库设置。 JManage command line functionality - （缺点是 它需要一个正在运行的 JManage 服务器代理命令）

Groovy JMX 示例：

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 示例：

如果你有一个

MBean：com.company.data:type=datasystem,id=0

使用名为的操作：

jmxForceRefresh()

然后你就可以写一个简单的bash脚本了（假设你下载了cmdline-jmxclient-0.10.3.jar并和你的脚本放在同一个目录下）：

#!/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

【讨论】：

jmxterm 似乎不适用于 Java 7 bugs.launchpad.net/jmxterm/+bug/942693

【参考方案2】：

我开发了 jmxfuse，它将 JMX Mbeans 公开为具有与 /proc fs 类似的功能的 Linux FUSE 文件系统。它依赖 Jolokia 作为 JMX 的桥梁。属性和操作暴露给读写。

http://code.google.com/p/jmxfuse/

例如，读取一个属性：

me@oddjob:jmx$ cd log4j/root/attributes
me@oddjob:jmx$ cat priority

写一个属性：

me@oddjob:jmx$ echo "WARN" > priority

调用操作：

me@oddjob:jmx$ cd Catalina/none/none/WebModule/localhost/helloworld/operations/addParameter
me@oddjob:jmx$ echo "myParam myValue" > invoke

【参考方案3】：

Syabru Nagios JMX plugin 旨在从 Nagios 中使用，但不需要 Nagios，并且非常方便命令行使用：

~$ ./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;;;;

【讨论】：

这很棒，而且速度非常快。返回值大约需要 0.3 秒，而 jmxterm 需要 3 秒

【参考方案4】：

这可能是用 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[]);    
    

这将编译为单个 .class 并且不需要服务器中的依赖项或任何复杂的 maven 打包。

调用它

javac JmxInvoke.java
java -cp . JmxInvoke [url] [beanName] [method]

【参考方案5】：

有点冒险，但您可以使用来自 JMX 控制台的表单中的值、其 URL 和 http 身份验证（如果需要）运行 curl POST 命令：

curl -s -X POST --user 'myuser:mypass'
  --data "action=invokeOp&name=App:service=ThisServiceOp&methodIndex=3&arg0=value1&arg1=value1&submit=Invoke"
  http://yourhost.domain.com/jmx-console/htmlAdaptor

注意：方法索引可能会随着软件的变化而变化。并且网络表单的实现可能会发生变化。

以上是基于你要执行的操作的JMX服务页面的来源：

http://yourhost.domain.com/jmx-console/HtmlAdaptor?action=inspectMBean&name=YourJMXServiceName

表格来源：

form method="post" action="HtmlAdaptor">
   <input type="hidden" name="action" value="invokeOp">
   <input type="hidden" name="name" value="App:service=ThisServiceOp">
   <input type="hidden" name="methodIndex" value="3">
   <hr align='left' width='80'>
   <h4>void ThisOperation()</h4>
   <p>Operation exposed for management</p>
    <table cellspacing="2" cellpadding="2" border="1">
        <tr class="OperationHeader">
            <th>Param</th>
            <th>ParamType</th>
            <th>ParamValue</th>
            <th>ParamDescription</th>
        </tr>
        <tr>
            <td>p1</td>
           <td>java.lang.String</td>
         <td> 
            <input type="text" name="arg0">
         </td>
         <td>(no description)</td>
        </tr>
        <tr>
            <td>p2</td>
           <td>arg1Type</td>
         <td> 
            <input type="text" name="arg1">
         </td>
         <td>(no description)</td>
        </tr>
    </table>
    <input type="submit" value="Invoke">
</form>

【讨论】：

我使用 HttpURLConnection 从 Java 以这种方式实现了它，我可以确认它有效。 （顺便说一句。submit=Invoke 是不必要的）

能否描述一下它是如何工作的？我的意思是，默认情况下 jmx 使用rmi，我看到http。这是否意味着必须将服务器配置为支持 http 上的 jmx 请求？

【参考方案6】：

看看JManage。它能够执行 MBean 方法并从command line 获取/设置属性。

【讨论】：

唯一的缺点是使用命令行实用程序，它需要运行 JManage 以将命令代理到您的 JMX 服务器。我宁愿直接对 JMX 服务器本身采取更轻量级的方法。

【参考方案7】：

您可能还想看看jmx4perl。它提供对远程 Java EE 服务器的 MBean 的无 Java 访问。但是，需要在目标平台上安装一个小型代理 servlet，它通过 HTTP 和 JSON 有效负载提供了一个安静的 JMX 访问。 （0.50 版将通过实现 JSR-160 代理添加无代理模式）。

与启动本地 Java JVM 相比，优点是启动时间快且易于使用。 jmx4perl 带有一整套 Perl 模块，可以在您自己的脚本中轻松使用：

use JMX::Jmx4Perl;
use JMX::Jmx4Perl::Alias;   # Import certains aliases for MBeans

print "Memory Used: ",
      JMX::Jmx4Perl
          ->new(url => "http://localhost:8080/j4p")
          ->get_attribute(MEMORY_HEAP_USED);

您还可以为常见的 MBean/Attribute/Operation 组合使用别名（例如，对于大多数 MXBeans）。 有关其他功能（Nagios-Plugin、对复杂属性类型的类似 XPath 的访问，...），请参阅 jmx4perl 的文档。

【参考方案8】：

@Dougnukem 的回答对我帮助很大。我采用了 Groovy 方法（使用 groovy 2.3.3）。

我对 Dougnukem 代码进行了一些更改。 这适用于 Java 7，每 10 秒将两个属性打印到标准输出。

        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)
                    

                
            

使用 maven-compiler-plugin 将此代码编译到 jar 中，这样您就不需要 groovy 安装，只需要 groovy-all.jar 。 下面是相关的插件定义和依赖。

   <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <compilerId>groovy-eclipse-compiler</compilerId>
                    <source>1.7</source>
                    <target>1.7</target>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>org.codehaus.groovy</groupId>
                        <artifactId>groovy-eclipse-compiler</artifactId>
                        <version>2.8.0-01</version>
                    </dependency>
                    <dependency>
                        <groupId>org.codehaus.groovy</groupId>
                        <artifactId>groovy-eclipse-batch</artifactId>
                        <version>2.3.4-01</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>
    <dependencies>
        <dependency>
            <groupId>org.codehaus.groovy</groupId>
            <artifactId>groovy-all</artifactId>
            <version>2.4.3</version>
        </dependency>
    </dependencies>

用蝙蝠或外壳包裹它，它将数据打印到标准输出。

【参考方案9】：

我不确定类似 bash 的环境。您可以尝试一些简单的 Java 包装程序（带有程序参数），它们调用远程服务器上的 MBean。然后，您可以从 shell 脚本调用这些包装器

如果您可以使用 Python 或 Perl 之类的东西，您可能会对 JSR-262 感兴趣，它允许您通过 Web 服务公开 JMX 操作。这计划包含在 Java 7 中，但您也许可以使用 reference implementation 的候选发布版