-
Notifications
You must be signed in to change notification settings - Fork 288
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support Websphere JMX admin metrics (#7235)
Co-authored-by: Stuart McCulloch <[email protected]>
- Loading branch information
Showing
11 changed files
with
231 additions
and
6 deletions.
There are no files selected for viewing
17 changes: 17 additions & 0 deletions
17
...tstrap/src/main/java/datadog/trace/bootstrap/instrumentation/jmx/MBeanServerRegistry.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
package datadog.trace.bootstrap.instrumentation.jmx; | ||
|
||
import java.util.concurrent.ConcurrentHashMap; | ||
import java.util.concurrent.ConcurrentMap; | ||
import javax.management.MBeanServer; | ||
|
||
public class MBeanServerRegistry { | ||
private static final ConcurrentMap<String, MBeanServer> serverMap = new ConcurrentHashMap<>(); | ||
|
||
public static MBeanServer getServer(final String serverClass) { | ||
return serverMap.get(serverClass); | ||
} | ||
|
||
public static void putServer(final String serverClass, final MBeanServer server) { | ||
serverMap.putIfAbsent(serverClass, server); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 36 additions & 0 deletions
36
...ent/agent-jmxfetch/src/main/java/datadog/trace/agent/jmxfetch/AgentConnectionFactory.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
package datadog.trace.agent.jmxfetch; | ||
|
||
import datadog.trace.bootstrap.instrumentation.jmx.MBeanServerRegistry; | ||
import java.io.IOException; | ||
import java.util.Map; | ||
import javax.management.MBeanServer; | ||
import org.datadog.jmxfetch.Connection; | ||
import org.datadog.jmxfetch.ConnectionFactory; | ||
import org.datadog.jmxfetch.DefaultConnectionFactory; | ||
import org.datadog.jmxfetch.JvmDirectConnection; | ||
import org.slf4j.Logger; | ||
import org.slf4j.LoggerFactory; | ||
|
||
public class AgentConnectionFactory implements ConnectionFactory { | ||
private static final Logger log = LoggerFactory.getLogger(AgentConnectionFactory.class); | ||
|
||
private final ConnectionFactory defaultConnectionFactory = new DefaultConnectionFactory(); | ||
|
||
public AgentConnectionFactory() {} | ||
|
||
@Override | ||
public Connection createConnection(Map<String, Object> connectionParams) throws IOException { | ||
Object mbeanServerClass = connectionParams.get("mbean_server_class"); | ||
if (mbeanServerClass != null) { | ||
MBeanServer mbeanServer = MBeanServerRegistry.getServer(mbeanServerClass.toString()); | ||
if (mbeanServer != null) { | ||
return new InitialMBeanServerConnection(mbeanServer); | ||
} | ||
log.warn( | ||
"Unable to provide a MBean server instance of {}. Falling back to platform default", | ||
mbeanServerClass); | ||
return new JvmDirectConnection(); | ||
} | ||
return defaultConnectionFactory.createConnection(connectionParams); | ||
} | ||
} |
18 changes: 18 additions & 0 deletions
18
...ent-jmxfetch/src/main/java/datadog/trace/agent/jmxfetch/InitialMBeanServerConnection.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
package datadog.trace.agent.jmxfetch; | ||
|
||
import java.io.IOException; | ||
import javax.annotation.Nonnull; | ||
import javax.management.MBeanServerConnection; | ||
import org.datadog.jmxfetch.JvmDirectConnection; | ||
|
||
public class InitialMBeanServerConnection extends JvmDirectConnection { | ||
|
||
public InitialMBeanServerConnection(@Nonnull final MBeanServerConnection mbs) throws IOException { | ||
this.mbs = mbs; | ||
} | ||
|
||
@Override | ||
protected void createConnection() { | ||
// already connected | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
35 changes: 35 additions & 0 deletions
35
dd-java-agent/agent-jmxfetch/src/main/resources/jmxfetch-websphere-config.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
init_config: | ||
is_jmx: true | ||
|
||
instances: | ||
- jvm_direct: true | ||
mbean_server_class: com.ibm.ws.management.PlatformMBeanServer | ||
name: dd-java-agent for websphere | ||
collect_default_jvm_metrics: false | ||
conf: | ||
# The metrics are included for now. When we'll have a dedicate core integration we can | ||
# remove that, but we'll need to keep shipping the connection factory | ||
- include: | ||
domain: WebSphere | ||
type: ThreadPool | ||
attribute: | ||
stats.PoolSize.lowerBound: | ||
alias: websphere.thread_pool.lower_bound | ||
stats.PoolSize.upperBound: | ||
alias: websphere.thread_pool.upper_bound | ||
stats.PoolSize.highWaterMark: | ||
alias: websphere.thread_pool.high_water_mark | ||
stats.PoolSize.lowWaterMark: | ||
alias: websphere.thread_pool.low_water_mark | ||
stats.PoolSize.current: | ||
alias: websphere.thread_pool.current | ||
stats.ActiveCount.lowerBound: | ||
alias: websphere.thread_pool.active.lower_bound | ||
stats.ActiveCount.upperBound: | ||
alias: websphere.thread_pool.active.upper_bound | ||
stats.ActiveCount.highWaterMark: | ||
alias: websphere.thread_pool.active.high_water_mark | ||
stats.ActiveCount.lowWaterMark: | ||
alias: websphere.thread_pool.active.low_water_mark | ||
stats.ActiveCount.current: | ||
alias: websphere.thread_pool.active.current |
49 changes: 49 additions & 0 deletions
49
...datadog/trace/instrumentation/java/lang/management/CustomMBeanBuilderInstrumentation.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
package datadog.trace.instrumentation.java.lang.management; | ||
|
||
import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named; | ||
import static net.bytebuddy.matcher.ElementMatchers.isMethod; | ||
import static net.bytebuddy.matcher.ElementMatchers.returns; | ||
|
||
import com.google.auto.service.AutoService; | ||
import datadog.trace.agent.tooling.Instrumenter; | ||
import datadog.trace.agent.tooling.InstrumenterModule; | ||
import datadog.trace.bootstrap.instrumentation.jmx.MBeanServerRegistry; | ||
import javax.management.MBeanServer; | ||
import net.bytebuddy.asm.Advice; | ||
|
||
@AutoService(InstrumenterModule.class) | ||
public class CustomMBeanBuilderInstrumentation extends InstrumenterModule.Tracing | ||
implements Instrumenter.ForConfiguredType { | ||
|
||
private final String customBuilder; | ||
|
||
public CustomMBeanBuilderInstrumentation() { | ||
super("java-lang-management"); | ||
|
||
customBuilder = System.getProperty("javax.management.builder.initial"); | ||
} | ||
|
||
@Override | ||
public boolean isEnabled() { | ||
return super.isEnabled() && customBuilder != null && !customBuilder.isEmpty(); | ||
} | ||
|
||
@Override | ||
public void methodAdvice(MethodTransformer transformer) { | ||
transformer.applyAdvice( | ||
isMethod().and(named("newMBeanServer")).and(returns(named("javax.management.MBeanServer"))), | ||
this.getClass().getName() + "$StoreMBeanServerAdvice"); | ||
} | ||
|
||
@Override | ||
public String configuredMatchingType() { | ||
return customBuilder; | ||
} | ||
|
||
public static class StoreMBeanServerAdvice { | ||
@Advice.OnMethodExit(suppress = Throwable.class) | ||
public static void afterCreation(@Advice.Return final MBeanServer mbeanServer) { | ||
MBeanServerRegistry.putServer(mbeanServer.getClass().getName(), mbeanServer); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
apply from: "$rootDir/gradle/java.gradle" |
61 changes: 61 additions & 0 deletions
61
...in/java/datadog/trace/instrumentation/websphere_jmx/WebsphereSecurityInstrumentation.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
package datadog.trace.instrumentation.websphere_jmx; | ||
|
||
import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named; | ||
import static net.bytebuddy.matcher.ElementMatchers.isMethod; | ||
import static net.bytebuddy.matcher.ElementMatchers.returns; | ||
|
||
import com.google.auto.service.AutoService; | ||
import datadog.trace.agent.tooling.Instrumenter; | ||
import datadog.trace.agent.tooling.InstrumenterModule; | ||
import datadog.trace.bootstrap.config.provider.ConfigProvider; | ||
import datadog.trace.util.AgentThreadFactory; | ||
import java.util.Collections; | ||
import net.bytebuddy.asm.Advice; | ||
|
||
/** | ||
* Grant JMXFetch access to the WebSphere Admin MBean without changing the server security config. | ||
*/ | ||
@AutoService(InstrumenterModule.class) | ||
public class WebsphereSecurityInstrumentation extends InstrumenterModule.Tracing | ||
implements Instrumenter.ForSingleType { | ||
|
||
private final String customBuilder; | ||
|
||
public WebsphereSecurityInstrumentation() { | ||
super("websphere-jmx"); | ||
|
||
customBuilder = System.getProperty("javax.management.builder.initial"); | ||
} | ||
|
||
@Override | ||
public String instrumentedType() { | ||
return "com.ibm.ws.management.util.SecurityHelper"; | ||
} | ||
|
||
@Override | ||
public boolean isEnabled() { | ||
return super.isEnabled() | ||
&& "com.ibm.ws.management.PlatformMBeanServerBuilder".equals(customBuilder) | ||
// we must avoid loading the global Config while setting up instrumentation, so use the same | ||
// underlying provider call as Config.get().isJmxFetchIntegrationEnabled("websphere", false) | ||
&& ConfigProvider.getInstance() | ||
.isEnabled(Collections.singletonList("websphere"), "jmxfetch.", ".enabled", false); | ||
} | ||
|
||
@Override | ||
public void methodAdvice(MethodTransformer transformer) { | ||
transformer.applyAdvice( | ||
isMethod().and(named("isSecurityEnabled")).and(returns(boolean.class)), | ||
this.getClass().getName() + "$DisableSecurityAdvice"); | ||
} | ||
|
||
public static class DisableSecurityAdvice { | ||
@Advice.OnMethodExit(suppress = Throwable.class) | ||
public static void after(@Advice.Return(readOnly = false) boolean securityEnabled) { | ||
// only grant access when we know the call is coming from one of our agent threads | ||
if (AgentThreadFactory.AGENT_THREAD_GROUP == Thread.currentThread().getThreadGroup()) { | ||
securityEnabled = false; | ||
} | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters