同一服务器上的许多应用程序具有相同的 JMX Mbean 类

Question

我有超过 5 个 Spring Web 应用程序，它们都在使用另一个通用库。这个公共库有它自己的 MBean。由于强制的唯一 objectName 约束，我的应用程序无法部署在同一服务器上。

我使用 MBean 的方式是这样的：

@ManagedResource(objectName = "com.org.city:name=City", description = "City related operations")

我想为所有应用程序使用具有不同 objectNames 的相同 MBean 类。在不重复我的 MBean 的情况下使用它的正确方法是什么？

谢谢

Answer 1

我遇到了同样的问题，并基于 Cemo 的解决方案构建。这是一个示例实现。

context.xml

<!-- Set up jmx bean auto scanning -->
<!-- Note: we're not using <context:mbean-export /> because we need to provide our own naming strategy -->
<bean id="mbeanExporter" class="org.springframework.jmx.export.annotation.AnnotationMBeanExporter">
    <property name="namingStrategy">
        <bean class="com.foo.MultiAppMetadataNamingStrategy">
            <property name="applicationName" value="${application.name}" />
        </bean>
    </property>
</bean>

MultiAppMetadataNamingStrategy.java

public class MultiAppMetadataNamingStrategy implements ObjectNamingStrategy, InitializingBean {

    private String applicationName;

    public MultiAppMetadataNamingStrategy() {
    }

    public MultiAppMetadataNamingStrategy(String applicationName) {
        this.applicationName = Preconditions.checkNotNull(applicationName, "applicationName must not be null");
    }

    public void setApplicationName(String applicationName) {
        this.applicationName = Preconditions.checkNotNull(applicationName, "applicationName must not be null");
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        if (applicationName == null) {
            throw new IllegalArgumentException("Property 'applicationName' is required");
        }
    }

    @Override
    public ObjectName getObjectName(Object managedBean, String beanKey) throws MalformedObjectNameException {
        Class managedClass = AopUtils.getTargetClass(managedBean);
        String domain = ClassUtils.getPackageName(managedClass);

        Hashtable<String, String> properties = new Hashtable<>();
        properties.put("type", ClassUtils.getShortName(managedClass));
        properties.put("name", beanKey);
        // ensure the application name is included as a property in the object name
        properties.put("app", applicationName);
        return ObjectNameManager.getInstance(domain, properties);
    }
}

这允许设置一个 mbean，如下所示：

package com.foo;

@ManagedResource(description = "Bean description")
public class MyBean {
    ...
}

它将使用对象名称注册一个 mbean com.foo:name=myBean,type=MyBean,app=CustomAppName

Answer 2

我已经为自定义行为实现了 ObjectNamingStrategy。

   @Override
  public ObjectName getObjectName(Object managedBean, String beanKey) throws MalformedObjectNameException {
     Class managedClass = AopUtils.getTargetClass(managedBean);
     Hashtable<String, String> properties = new Hashtable<String, String>();
     properties.put("type",ClassUtils.getPackageName(managedClass).concat(".").concat(ClassUtils.getShortName(managedClass)));
     properties.put("name", beanKey);
     return ObjectNameManager.getInstance(domain, properties);
  }

Answer 3

您需要更改 mbean 导出器的注册行为：

<property name="registrationBehaviorName" value="REGISTRATION_REPLACE_EXISTING"/>

但这仍然意味着只有一个应用程序注册该 bean。从逻辑上讲，您不能在多个应用程序中拥有多个同名的 mbean。如何确定调用哪个应用程序？使用应用程序名称作为 mbean 名称的前缀。

Answer 4

您可以使用占位符根据属性定义简单的命名策略。
每场战争都会有它自己的 app.properties 副本
例如，

使用属性文件：app.properties

appName=MyApp1 #Every app will have it own value e.g,MyApp2,MyApp3,MyApp4,MyApp5

和 PropertiesPlaceHolder

<bean id="placeholderConfig" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
     <property name="placeholderPrefix" value="$app{" />    
     <property name="location" value="classpath:app.properties"/>
</bean>

定义 objectName

@ManagedResource(objectName=com.mycompany:name=$app{appName}-MyBean")
public class MyBean {}

您的 bean 将被命名

com.mycompany
    +MyApp1-MyBean
    +MyApp2-MyBean
    +MyApp3-MyBean
    +MyApp4-MyBean
    +MyApp5-MyBean

您可以使用多个属性占位符。
适用于 Spring 4.0.2

Answer 5

这些答案帮助我指明了正确的方向，但是基于注释的设置缺少一些内容（但是我没有使用 Spring Boot）

关于此主题的 Spring 文档 说：

如果您更喜欢使用基于注释的方法来定义管理接口，则可以使用 MBeanExporter 的便捷子类：AnnotationMBeanExporter。定义此子类的实例时，不再需要namingStrategy、assembler和attributeSource配置，因为它将始终使用标准的基于Java注释的元数据（也始终启用自动检测）。事实上，@EnableMBeanExport @Configuration 注释支持更简单的语法，而不是定义 MBeanExporter bean。

但是使用 @EnableMBeanExport 会阻止您定义自己的 NamingStrategy 的能力，

所以不要只设置一个返回我的 @Bean 方法>MBeanExporter 具有使用上下文路径的自定义命名策略。

@Configuration
public class JmxUtil {

    @Value("#{servletContext.contextPath}")
    private String contextPath;
    private String domain = "foo.bar";

    @Bean
    public MBeanExporter mbeanExporter() {
        AnnotationMBeanExporter exporter = new AnnotationMBeanExporter();
        exporter.setNamingStrategy((managedBean, beanKey) -> {
            return ObjectNameManager.getInstance(domain, new Hashtable<>(ImmutableMap.of(
                "name", beanKey,
                "instance", contextPath
            )));
        });
        exporter.setDefaultDomain(domain);
        return exporter;
    }
}