org.glowroot.agent.util.LazyPlatformMBeanServer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of glowroot-agent-it-harness Show documentation
Show all versions of glowroot-agent-it-harness Show documentation
Glowroot Agent Integration Test Harness
/*
* Copyright 2014-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.glowroot.agent.util;
import java.lang.management.ManagementFactory;
import java.util.List;
import java.util.ListIterator;
import java.util.Set;
import org.glowroot.agent.shaded.org.glowroot.agent.it.harness.shaded.javax.annotation.concurrent.GuardedBy;
import javax.management.InstanceAlreadyExistsException;
import javax.management.InstanceNotFoundException;
import javax.management.MBeanInfo;
import javax.management.MBeanServer;
import javax.management.MBeanServerFactory;
import javax.management.MalformedObjectNameException;
import javax.management.NotCompliantMBeanException;
import javax.management.ObjectName;
import javax.management.QueryExp;
import org.glowroot.agent.shaded.org.glowroot.agent.it.harness.shaded.com.google.common.base.Stopwatch;
import org.glowroot.agent.shaded.org.glowroot.agent.it.harness.shaded.com.google.common.cache.CacheBuilder;
import org.glowroot.agent.shaded.org.glowroot.agent.it.harness.shaded.com.google.common.cache.CacheLoader;
import org.glowroot.agent.shaded.org.glowroot.agent.it.harness.shaded.com.google.common.cache.LoadingCache;
import org.glowroot.agent.shaded.org.glowroot.agent.it.harness.shaded.com.google.common.collect.Lists;
import org.glowroot.agent.shaded.org.glowroot.agent.it.harness.shaded.com.google.common.collect.Sets;
import org.glowroot.agent.shaded.org.checkerframework.checker.nullness.qual.EnsuresNonNull;
import org.glowroot.agent.shaded.org.checkerframework.checker.nullness.qual.MonotonicNonNull;
import org.glowroot.agent.shaded.org.checkerframework.checker.nullness.qual.Nullable;
import org.immutables.value.Value;
import org.glowroot.agent.shaded.org.glowroot.agent.shaded.org.slf4j.Logger;
import org.glowroot.agent.shaded.org.glowroot.agent.shaded.org.slf4j.LoggerFactory;
import org.glowroot.agent.shaded.org.glowroot.common.util.OnlyUsedByTests;
import org.glowroot.agent.shaded.org.glowroot.common.util.Styles;
import static org.glowroot.agent.shaded.org.glowroot.agent.it.harness.shaded.com.google.common.base.Preconditions.checkNotNull;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
import static java.util.concurrent.TimeUnit.SECONDS;
// this is needed for jboss-modules because calling ManagementFactory.getPlatformMBeanServer()
// before jboss-modules has set up its own logger will trigger the default JUL LogManager to be
// used, and then jboss/wildfly will fail to start
//
// it is also needed for glassfish because it sets the "javax.management.builder.initial" system
// property during startup (instead of from command line)
// see com.sun.enterprise.admin.launcher.JvmOptions.filter() that filters out from command line
// and see com.sun.enterprise.v3.server.SystemTasksImpl.resolveJavaConfig() that adds it back during
// startup
public class LazyPlatformMBeanServer {
private static final Logger logger = LoggerFactory.getLogger(LazyPlatformMBeanServer.class);
@GuardedBy("initListeners")
private final List initListeners = Lists.newArrayList();
private final boolean waitForContainerToCreatePlatformMBeanServer;
private final boolean needsManualPatternMatching;
private final List toBeRegistered = Lists.newCopyOnWriteArrayList();
private final List toBeUnregistered = Lists.newCopyOnWriteArrayList();
private volatile @MonotonicNonNull MBeanServer platformMBeanServer;
private final Object platformMBeanServerAvailability = new Object();
@GuardedBy("platformMBeanServerAvailability")
private boolean platformMBeanServerAvailable;
private final LoadingCache webSphereUnwrappedMBeanServers =
CacheBuilder.newBuilder()
.weakKeys()
.weakValues()
.build(new CacheLoader() {
@Override
public MBeanServer load(MBeanServer mbeanServer) {
try {
return (MBeanServer) checkNotNull(mbeanServer.getClass()
.getMethod("getDefaultMBeanServer").invoke(mbeanServer));
} catch (Exception e) {
logger.error(e.getMessage(), e);
return mbeanServer;
}
}
});
public static LazyPlatformMBeanServer create(@Nullable String mainClass) throws Exception {
LazyPlatformMBeanServer lazyPlatformMBeanServer = new LazyPlatformMBeanServer(mainClass);
if (!lazyPlatformMBeanServer.waitForContainerToCreatePlatformMBeanServer) {
// it is useful to init right away in this case in order to avoid condition where really
// should wait for container, but works most of the time by luck due to timing of when
// ensureInit() is first called
lazyPlatformMBeanServer.ensureInit();
}
return lazyPlatformMBeanServer;
}
private LazyPlatformMBeanServer(@Nullable String mainClass) {
boolean jbossModules = "org.jboss.modules.Main".equals(mainClass);
boolean wildflySwarm = "org.wildfly.swarm.bootstrap.Main".equals(mainClass);
boolean oldJBoss = "org.jboss.Main".equals(mainClass);
boolean glassfish = "com.sun.enterprise.glassfish.bootstrap.ASMain".equals(mainClass);
boolean weblogic = "weblogic.Server".equals(mainClass);
boolean websphere = "com.ibm.wsspi.bootstrap.WSPreLauncher".equals(mainClass);
waitForContainerToCreatePlatformMBeanServer =
jbossModules || wildflySwarm || oldJBoss || glassfish || weblogic || websphere;
needsManualPatternMatching = oldJBoss;
}
public void lazyRegisterMBean(Object object, String name) {
ObjectName objectName;
try {
objectName = ObjectName.getInstance(name);
} catch (MalformedObjectNameException e) {
logger.warn(e.getMessage(), e);
return;
}
synchronized (initListeners) {
if (platformMBeanServer == null) {
toBeRegistered.add(ImmutableObjectNamePair.of(object, objectName));
toBeUnregistered.add(objectName);
} else {
try {
safeRegisterMBean(platformMBeanServer, object, objectName);
toBeUnregistered.add(objectName);
} catch (Throwable t) {
logger.warn(t.getMessage(), t);
}
}
}
}
public Object invoke(ObjectName name, String operationName, @Nullable Object[] params,
String[] signature) throws Exception {
ensureInit();
return platformMBeanServer.invoke(name, operationName, params, signature);
}
public Set queryNames(@Nullable ObjectName name, @Nullable QueryExp query,
List mbeanServers) throws Exception {
ensureInit();
if (needsManualPatternMatching && name != null && name.isPattern()) {
return queryNamesAcrossAll(null, new ObjectNamePatternQueryExp(name), mbeanServers);
} else {
return queryNamesAcrossAll(name, query, mbeanServers);
}
}
public MBeanInfo getMBeanInfo(ObjectName name, List mbeanServers)
throws Exception {
ensureInit();
return getMBeanInfoAcrossAll(name, mbeanServers);
}
public Object getAttribute(ObjectName name, String attribute, List mbeanServers)
throws Exception {
ensureInit();
return getAttributeAcrossAll(name, attribute, mbeanServers);
}
public void addInitListener(InitListener initListener) {
synchronized (initListeners) {
if (platformMBeanServer == null) {
initListeners.add(initListener);
} else {
try {
initListener.postInit(platformMBeanServer);
} catch (Throwable t) {
logger.error(t.getMessage(), t);
}
}
}
}
public void setPlatformMBeanServerAvailable() {
synchronized (platformMBeanServerAvailability) {
platformMBeanServerAvailable = true;
platformMBeanServerAvailability.notifyAll();
}
}
@EnsuresNonNull("platformMBeanServer")
private void ensureInit() throws Exception {
if (platformMBeanServer != null) {
return;
}
// don't hold initListeners lock while waiting for platform mbean server to be created
// as this blocks lazyRegisterMBean
if (waitForContainerToCreatePlatformMBeanServer) {
waitForContainerToCreatePlatformMBeanServer();
}
synchronized (initListeners) {
if (platformMBeanServer != null) {
return;
}
platformMBeanServer = init();
}
}
private void waitForContainerToCreatePlatformMBeanServer() throws Exception {
synchronized (platformMBeanServerAvailability) {
if (platformMBeanServerAvailable) {
return;
}
Stopwatch stopwatch = Stopwatch.createStarted();
// looping to guard against "spurious wakeup" from Object.wait()
while (!platformMBeanServerAvailable) {
long remaining = SECONDS.toMillis(60) - stopwatch.elapsed(MILLISECONDS);
if (remaining < 1000) {
// less that one second remaining
break;
}
platformMBeanServerAvailability.wait(remaining);
}
if (!platformMBeanServerAvailable) {
logger.error("platform mbean server was never created by container");
}
}
}
private MBeanServer init() {
MBeanServer platformMBeanServer = ManagementFactory.getPlatformMBeanServer();
for (InitListener initListener : initListeners) {
try {
initListener.postInit(platformMBeanServer);
} catch (Throwable t) {
logger.error(t.getMessage(), t);
}
}
initListeners.clear();
for (ObjectNamePair objectNamePair : toBeRegistered) {
safeRegisterMBean(platformMBeanServer, objectNamePair.object(),
objectNamePair.name());
}
toBeRegistered.clear();
return platformMBeanServer;
}
@OnlyUsedByTests
public void close() throws Exception {
ensureInit();
for (ObjectName name : toBeUnregistered) {
platformMBeanServer.unregisterMBean(name);
}
}
public List findAllMBeanServers() throws Exception {
ensureInit();
List mbeanServers = MBeanServerFactory.findMBeanServer(null);
for (ListIterator i = mbeanServers.listIterator(); i.hasNext();) {
MBeanServer mbeanServer = i.next();
if (mbeanServer.getClass().getName()
.equals("com.ibm.ws.management.PlatformMBeanServer")) {
i.set(webSphereUnwrappedMBeanServers.get(mbeanServer));
}
}
return mbeanServers;
}
private static void safeRegisterMBean(MBeanServer mbeanServer, Object object, ObjectName name) {
try {
mbeanServer.registerMBean(object, name);
} catch (InstanceAlreadyExistsException e) {
// this happens during unit tests when a non-shared local container is used
// (so that then there are two local containers in the same jvm)
//
// log exception at debug level
logger.debug(e.getMessage(), e);
} catch (NotCompliantMBeanException e) {
StackTraceElement /*@Nullable*/ [] stackTraceElements = e.getStackTrace();
if (stackTraceElements != null && stackTraceElements.length > 0 && stackTraceElements[0]
.getClassName().equals("org.jboss.mx.metadata.MBeanCapability")) {
// this happens in jboss 4.2.3 because it doesn't know about Java 6 "MXBean"
// naming convention
// it's not really that important if glowroot mbeans aren't registered
logger.debug(e.getMessage(), e);
} else {
logger.warn(e.getMessage(), e);
}
} catch (Throwable t) {
logger.warn(t.getMessage(), t);
}
}
private static Set queryNamesAcrossAll(@Nullable ObjectName name,
@Nullable QueryExp query, List mbeanServers) {
Set objects = Sets.newHashSet();
for (MBeanServer mbeanServer : mbeanServers) {
objects.addAll(mbeanServer.queryNames(name, query));
}
return objects;
}
private static MBeanInfo getMBeanInfoAcrossAll(ObjectName name, List mbeanServers)
throws Exception {
InstanceNotFoundException firstException = null;
for (MBeanServer mbeanServer : mbeanServers) {
try {
return mbeanServer.getMBeanInfo(name);
} catch (InstanceNotFoundException e) {
logger.debug(e.getMessage(), e);
if (firstException == null) {
firstException = e;
}
}
}
throw checkNotNull(firstException);
}
private static Object getAttributeAcrossAll(ObjectName name, String attribute,
List mbeanServers) throws Exception {
InstanceNotFoundException firstException = null;
for (MBeanServer mbeanServer : mbeanServers) {
try {
return mbeanServer.getAttribute(name, attribute);
} catch (InstanceNotFoundException e) {
logger.debug(e.getMessage(), e);
if (firstException == null) {
firstException = e;
}
}
}
throw checkNotNull(firstException);
}
public interface InitListener {
void postInit(MBeanServer mbeanServer) throws Exception;
}
@Value.Immutable
@Styles.AllParameters
interface ObjectNamePair {
Object object();
ObjectName name();
}
@SuppressWarnings("serial")
private static class ObjectNamePatternQueryExp implements QueryExp {
private final ObjectName pattern;
private ObjectNamePatternQueryExp(ObjectName pattern) {
this.pattern = pattern;
}
@Override
public boolean apply(ObjectName name) {
return pattern.apply(name);
}
@Override
public void setMBeanServer(MBeanServer s) {}
}
}