8075926: Add a sun.management.JMXConnectorServer perf counter to track its state
Reviewed-by: duke
--- a/jdk/src/java.management/share/classes/sun/management/Agent.java Sat May 16 13:22:40 2015 -0700
+++ b/jdk/src/java.management/share/classes/sun/management/Agent.java Fri Apr 03 15:39:38 2015 +0200
@@ -345,6 +345,7 @@
if (jmxServer != null) {
ConnectorBootstrap.unexportRegistry();
+ ConnectorAddressLink.unexportRemote();
// Attempt to stop already stopped agent
// Don't cause any errors.
--- a/jdk/src/java.management/share/classes/sun/management/ConnectorAddressLink.java Sat May 16 13:22:40 2015 -0700
+++ b/jdk/src/java.management/share/classes/sun/management/ConnectorAddressLink.java Fri Apr 03 15:39:38 2015 +0200
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -27,6 +27,7 @@
import java.io.IOException;
import java.nio.ByteBuffer;
+import java.nio.ByteOrder;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
@@ -45,9 +46,26 @@
* @since 1.5
*/
public class ConnectorAddressLink {
+ /**
+ * A simple wrapper for the perf-counter backing {@linkplain ByteBuffer}
+ */
+ private static final class PerfHandle {
+ private ByteBuffer bb;
+
+ private PerfHandle(ByteBuffer bb) {
+ this.bb = bb.order(ByteOrder.nativeOrder());
+ }
+
+ private void putLong(long l) {
+ this.bb = bb.clear();
+ this.bb.asLongBuffer().put(l);
+ }
+ }
private static final String CONNECTOR_ADDRESS_COUNTER =
"sun.management.JMXConnectorServer.address";
+ private static final String REMOTE_CONNECTOR_STATE_COUNTER =
+ "sun.management.JMXConnectorServer.remote.enabled";
/*
* The format of the jvmstat counters representing the properties of
@@ -78,7 +96,9 @@
* JMX remote connector counter (it will be incremented every
* time a new out-of-the-box JMX remote connector is created).
*/
- private static AtomicInteger counter = new AtomicInteger();
+ private static final AtomicInteger counter = new AtomicInteger();
+
+ private static PerfHandle remotePerfHandle = null;
/**
* Exports the specified connector address to the instrumentation buffer
@@ -93,7 +113,17 @@
}
Perf perf = Perf.getPerf();
perf.createString(
- CONNECTOR_ADDRESS_COUNTER, 1, Units.STRING.intValue(), address);
+ CONNECTOR_ADDRESS_COUNTER, 1, Units.STRING.intValue(), address);
+ }
+
+ public static void unexportRemote() {
+ unexport(remotePerfHandle);
+ }
+
+ private static void unexport(PerfHandle ph) {
+ if (ph != null) {
+ ph.putLong(-1L);
+ }
}
/**
@@ -143,6 +173,13 @@
perf.createString(REMOTE_CONNECTOR_COUNTER_PREFIX + index + "." +
entry.getKey(), 1, Units.STRING.intValue(), entry.getValue());
}
+ if (remotePerfHandle != null) {
+ remotePerfHandle.putLong(index);
+ } else {
+ remotePerfHandle = new PerfHandle(
+ perf.createLong(REMOTE_CONNECTOR_STATE_COUNTER, 1, Units.NONE.intValue(), (long)index)
+ );
+ }
}
/**
--- a/jdk/test/sun/management/jmxremote/bootstrap/JvmstatCountersTest.java Sat May 16 13:22:40 2015 -0700
+++ b/jdk/test/sun/management/jmxremote/bootstrap/JvmstatCountersTest.java Fri Apr 03 15:39:38 2015 +0200
@@ -116,10 +116,10 @@
throw new IllegalArgumentException("Test case 3 failed");
}
for (String key : remoteData.keySet()) {
- if (!key.startsWith("sun.management.JMXConnectorServer.0.")) {
+ if (!isKeyAcceptable(key)) {
System.out.println("Test FAILED! The OOTB management " +
"agent shouldn't publish anything which isn't " +
- "related to the remote connector.");
+ "related to the remote connector (" + key + ").");
throw new IllegalArgumentException("Test case 3 failed");
}
}
@@ -165,10 +165,10 @@
throw new IllegalArgumentException("Test case 4 failed");
}
for (String key : remoteData2.keySet()) {
- if (!key.startsWith("sun.management.JMXConnectorServer.0.")) {
+ if (!isKeyAcceptable(key)) {
System.out.println("Test FAILED! The OOTB management " +
"agent shouldn't publish anything which isn't " +
- "related to the remote connector.");
+ "related to the remote connector (" + key + ").");
throw new IllegalArgumentException("Test case 4 failed");
}
}
@@ -184,4 +184,9 @@
}
System.out.println("Bye! Bye!");
}
+
+ private static boolean isKeyAcceptable(String key) {
+ return key.startsWith("sun.management.JMXConnectorServer.0.") ||
+ key.startsWith("sun.management.JMXConnectorServer.remote.enabled");
+ }
}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/jdk/test/sun/management/jmxremote/startstop/JMXStatusPerfCountersTest.java Fri Apr 03 15:39:38 2015 +0200
@@ -0,0 +1,188 @@
+/*
+ * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+import java.io.IOException;
+import java.net.BindException;
+import java.util.Properties;
+import java.util.function.Predicate;
+import static org.testng.Assert.*;
+import org.testng.annotations.AfterMethod;
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.BeforeMethod;
+import org.testng.annotations.BeforeTest;
+import org.testng.annotations.Test;
+
+import jdk.testlibrary.ProcessTools;
+
+
+/**
+ * @test
+ * @bug 8075926
+ * @summary Makes sure that the current management agent status is reflected
+ * in the related performance counters.
+ * @library /lib/testlibrary
+ * @build jdk.testlibrary.* PortAllocator TestApp ManagementAgentJcmd
+ * @run testng/othervm -XX:+UsePerfData JMXStatusPerfCountersTest
+ */
+public class JMXStatusPerfCountersTest {
+ private final static String TEST_APP_NAME = "TestApp";
+
+ private final static String REMOTE_STATUS_KEY = "sun.management.JMXConnectorServer.remote.enabled";
+
+ private static ProcessBuilder testAppPb;
+ private Process testApp;
+
+ private ManagementAgentJcmd jcmd;
+
+ @BeforeClass
+ public static void setupClass() throws Exception {
+ testAppPb = ProcessTools.createJavaProcessBuilder(
+ "-XX:+UsePerfData",
+ "-cp", System.getProperty("test.class.path"),
+ TEST_APP_NAME
+ );
+ }
+
+ @BeforeTest
+ public void setup() {
+ jcmd = new ManagementAgentJcmd(TEST_APP_NAME, false);
+ }
+
+ @BeforeMethod
+ public void startTestApp() throws Exception {
+ testApp = ProcessTools.startProcess(
+ TEST_APP_NAME, testAppPb,
+ (Predicate<String>)l->l.trim().equals("main enter")
+ );
+ }
+
+ @AfterMethod
+ public void stopTestApp() throws Exception {
+ testApp.getOutputStream().write(1);
+ testApp.getOutputStream().flush();
+ testApp.waitFor();
+ testApp = null;
+ }
+
+ /**
+ * The 'sun.management.JMXConnectorServer.remote.enabled' counter must not be
+ * exported if the remote agent is not enabled.
+ * @throws Exception
+ */
+ @Test
+ public void testNotInitializedRemote() throws Exception {
+ assertFalse(
+ getCounters().containsKey(REMOTE_STATUS_KEY),
+ "Unexpected occurrence of " + REMOTE_STATUS_KEY + " in perf counters"
+ );
+ }
+
+ /**
+ * After enabling the remote agent the 'sun.management.JMXConnectorServer.remote.enabled'
+ * counter will be exported with value of '0' - corresponding to the actual
+ * version of the associated remote connector perf counters.
+ * @throws Exception
+ */
+ @Test
+ public void testRemoteEnabled() throws Exception {
+ while (true) {
+ try {
+ int[] ports = PortAllocator.allocatePorts(1);
+ jcmd.start(
+ "jmxremote.port=" + ports[0],
+ "jmxremote.authenticate=false",
+ "jmxremote.ssl=false"
+ );
+ String v = getCounters().getProperty(REMOTE_STATUS_KEY);
+ assertNotNull(v);
+ assertEquals("0", v);
+ return;
+ } catch (BindException e) {
+ System.out.println("Failed to allocate ports. Retrying ...");
+ }
+ }
+ }
+
+ /**
+ * After disabling the remote agent the value of 'sun.management.JMXConnectorServer.remote.enabled'
+ * counter will become '-1'.
+ * @throws Exception
+ */
+ @Test
+ public void testRemoteDisabled() throws Exception {
+ while (true) {
+ try {
+ int[] ports = PortAllocator.allocatePorts(1);
+ jcmd.start(
+ "jmxremote.port=" + ports[0],
+ "jmxremote.authenticate=false",
+ "jmxremote.ssl=false"
+ );
+ jcmd.stop();
+ String v = getCounters().getProperty(REMOTE_STATUS_KEY);
+ assertNotNull(v);
+ assertEquals("-1", v);
+ return;
+ } catch (BindException e) {
+ System.out.println("Failed to allocate ports. Retrying ...");
+ }
+ }
+ }
+
+ /**
+ * Each subsequent re-enablement of the remote agent must keep the value of
+ * 'sun.management.JMXConnectorServer.remote.enabled' counter in sync with
+ * the actual version of the associated remote connector perf counters.
+ * @throws Exception
+ */
+ @Test
+ public void testRemoteReEnabled() throws Exception {
+ while (true) {
+ try {
+ int[] ports = PortAllocator.allocatePorts(1);
+ jcmd.start(
+ "jmxremote.port=" + ports[0],
+ "jmxremote.authenticate=false",
+ "jmxremote.ssl=false"
+ );
+ jcmd.stop();
+ jcmd.start(
+ "jmxremote.port=" + ports[0],
+ "jmxremote.authenticate=false",
+ "jmxremote.ssl=false"
+ );
+
+ String v = getCounters().getProperty(REMOTE_STATUS_KEY);
+ assertNotNull(v);
+ assertEquals("1", v);
+ return;
+ } catch (BindException e) {
+ System.out.println("Failed to allocate ports. Retrying ...");
+ }
+ }
+ }
+
+ private Properties getCounters() throws IOException, InterruptedException {
+ return jcmd.perfCounters("sun\\.management\\.JMXConnectorServer\\..*");
+ }
+}
\ No newline at end of file
--- a/jdk/test/sun/management/jmxremote/startstop/ManagementAgentJcmd.java Sat May 16 13:22:40 2015 -0700
+++ b/jdk/test/sun/management/jmxremote/startstop/ManagementAgentJcmd.java Fri Apr 03 15:39:38 2015 +0200
@@ -25,8 +25,10 @@
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
+import java.util.Properties;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Consumer;
+import java.util.regex.Pattern;
import java.util.stream.Collectors;
import sun.management.Agent;
import sun.management.AgentConfigurationError;
@@ -43,6 +45,7 @@
private static final String CMD_START = "ManagementAgent.start";
private static final String CMD_START_LOCAL = "ManagementAgent.start_local";
private static final String CMD_STATUS = "ManagementAgent.status";
+ private static final String CMD_PRINTPERF = "PerfCounter.print";
private final String id;
private final boolean verbose;
@@ -63,6 +66,39 @@
}
/**
+ * `jcmd PerfCounter.print`
+ * @return Returns the available performance counters with their values as
+ * {@linkplain Properties} instance
+ * @throws IOException
+ * @throws InterruptedException
+ */
+ public Properties perfCounters() throws IOException, InterruptedException {
+ return perfCounters(".*");
+ }
+
+ /**
+ * `jcmd PerfCounter.print | grep {exp}>`
+ * @param regex Regular expression for including perf counters in the result
+ * @return Returns the matching performance counters with their values
+ * as {@linkplain Properties} instance
+ * @throws IOException
+ * @throws InterruptedException
+ */
+ public Properties perfCounters(String regex) throws IOException, InterruptedException {
+ Pattern pat = Pattern.compile(regex);
+ Properties p = new Properties();
+ for(String l : jcmd(CMD_PRINTPERF).split("\\n")) {
+ String[] kv = l.split("=");
+ if (kv.length > 1) {
+ if (pat.matcher(kv[0]).matches()) {
+ p.setProperty(kv[0], kv[1].replace("\"", ""));
+ }
+ }
+ }
+ return p;
+ }
+
+ /**
* `jcmd <app> ManagementAgent.stop`
* @return The JCMD output
* @throws IOException