Classes for handling JMX agent connections.
3 | */ 4 | package com.github.mk23.jmxproxy.jmx; 5 | -------------------------------------------------------------------------------- /src/main/java/com/github/mk23/jmxproxy/util/package-info.java: -------------------------------------------------------------------------------- 1 | /** 2 | *Utility classes for the entire application.
3 | */ 4 | package com.github.mk23.jmxproxy.util; 5 | -------------------------------------------------------------------------------- /src/main/resources/assets/fonts/glyphicons-halflings-regular.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mk23/jmxproxy/HEAD/src/main/resources/assets/fonts/glyphicons-halflings-regular.eot -------------------------------------------------------------------------------- /src/main/resources/assets/fonts/glyphicons-halflings-regular.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mk23/jmxproxy/HEAD/src/main/resources/assets/fonts/glyphicons-halflings-regular.ttf -------------------------------------------------------------------------------- /src/main/java/com/github/mk23/jmxproxy/conf/package-info.java: -------------------------------------------------------------------------------- 1 | /** 2 | *Classes for handling application configuration.
3 | */ 4 | package com.github.mk23.jmxproxy.conf; 5 | -------------------------------------------------------------------------------- /src/main/resources/assets/fonts/glyphicons-halflings-regular.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mk23/jmxproxy/HEAD/src/main/resources/assets/fonts/glyphicons-halflings-regular.woff -------------------------------------------------------------------------------- /src/main/resources/assets/fonts/glyphicons-halflings-regular.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mk23/jmxproxy/HEAD/src/main/resources/assets/fonts/glyphicons-halflings-regular.woff2 -------------------------------------------------------------------------------- /src/test/resources/fixtures/health_check_pass.json: -------------------------------------------------------------------------------- 1 | { 2 | "deadlocks": { 3 | "healthy": true 4 | }, 5 | "manager": { 6 | "healthy": true 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /src/main/java/com/github/mk23/jmxproxy/package-info.java: -------------------------------------------------------------------------------- 1 | /** 2 | *Classes for handling main application lifecycle, resources, and health checks.
3 | */ 4 | package com.github.mk23.jmxproxy; 5 | -------------------------------------------------------------------------------- /src/main/java/com/github/mk23/jmxproxy/core/package-info.java: -------------------------------------------------------------------------------- 1 | /** 2 | *Classes for organizing and tracking core application objects for client retrieval.
3 | */ 4 | package com.github.mk23.jmxproxy.core; 5 | -------------------------------------------------------------------------------- /scripts/server/jmxproxy.yml: -------------------------------------------------------------------------------- 1 | jmxproxy: 2 | allowed_endpoints: 3 | - 'localhost:1123' 4 | history_size: 20 5 | 6 | logging: 7 | level: INFO 8 | 9 | loggers: 10 | "com.github.mk23.jmxproxy": DEBUG 11 | -------------------------------------------------------------------------------- /src/test/resources/fixtures/health_check_fail.json: -------------------------------------------------------------------------------- 1 | { 2 | "deadlocks": { 3 | "healthy": true 4 | }, 5 | "manager": { 6 | "healthy": false, 7 | "message": "connection manager is not started" 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /src/test/resources/logback.xml: -------------------------------------------------------------------------------- 1 |Service health check.
9 | * 10 | * Checks the state of the {@link ConnectionManager}. 11 | * 12 | * @since 2015-05-11 13 | * @author mk23 14 | * @version 3.2.0 15 | */ 16 | public class JMXProxyHealthCheck extends HealthCheck { 17 | /** 18 | * Lifecycle {@link ConnectionManager} object that determines 19 | * the overall service status. 20 | */ 21 | private final ConnectionManager manager; 22 | 23 | /** 24 | *Default constructor.
25 | * 26 | * Uses the {@link ConnectionManager} object to determine 27 | * service status when a health check is requested. 28 | * 29 | * @param manager of the endpoint cache. 30 | */ 31 | public JMXProxyHealthCheck(final ConnectionManager manager) { 32 | this.manager = manager; 33 | } 34 | 35 | /** {@inheritDoc} */ 36 | @Override 37 | protected final Result check() throws Exception { 38 | if (!manager.isStarted()) { 39 | return Result.unhealthy("connection manager is not started"); 40 | } 41 | return Result.healthy(); 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /src/main/java/com/github/mk23/jmxproxy/conf/MainConfig.java: -------------------------------------------------------------------------------- 1 | package com.github.mk23.jmxproxy.conf; 2 | 3 | import com.fasterxml.jackson.annotation.JsonProperty; 4 | 5 | import io.dropwizard.Configuration; 6 | 7 | import javax.validation.Valid; 8 | 9 | /** 10 | *Main top-level configuration.
11 | * 12 | * Maintains the top-level application configuration object. The 13 | * application initializer creates and marshals the object from 14 | * JSON or Yaml config file. 15 | * 16 | * @since 2016-01-28 17 | * @author mk23 18 | * @version 3.2.1 19 | */ 20 | public class MainConfig extends Configuration { 21 | /** 22 | * Application service config. 23 | */ 24 | @Valid 25 | @JsonProperty("jmxproxy") 26 | private AppConfig appConfig = new AppConfig(); 27 | 28 | /** 29 | *Getter for appConfig.
30 | * 31 | * Application service config. 32 | * 33 | * @return Application subsection from the full configuration file. 34 | */ 35 | public final AppConfig getAppConfig() { 36 | return appConfig; 37 | } 38 | /** 39 | *Setter for appConfig.
40 | * 41 | * @param appConfig Application subsection from the full configuration file. 42 | */ 43 | public final void setAppConfig(final AppConfig appConfig) { 44 | this.appConfig = appConfig; 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /src/main/java/com/github/mk23/jmxproxy/conf/DurationSerializer.java: -------------------------------------------------------------------------------- 1 | package com.github.mk23.jmxproxy.conf; 2 | 3 | import com.fasterxml.jackson.core.JsonGenerator; 4 | import com.fasterxml.jackson.core.JsonProcessingException; 5 | import com.fasterxml.jackson.databind.JsonSerializer; 6 | import com.fasterxml.jackson.databind.SerializerProvider; 7 | 8 | import io.dropwizard.util.Duration; 9 | 10 | import java.io.IOException; 11 | 12 | /** 13 | *Custom serializer for configuration Duration fields.
14 | * 15 | * Convertsio.dropwizard.util.Duration types to milliseconds
16 | * for JSON requests.
17 | *
18 | * @see io.dropwizard.util.Duration
19 | * @see com.fasterxml.jackson.databind.JsonSerializer
20 | *
21 | * @since 2016-01-29
22 | * @author mk23
23 | * @version 3.2.1
24 | */
25 | public class DurationSerializer extends JsonSerializerCustom deserializer for configuration Duration fields.
15 | * 16 | * Converts a String or Long intoio.dropwizard.util.Duration types to milliseconds.
17 | *
18 | * @see io.dropwizard.util.Duration
19 | * @see com.fasterxml.jackson.databind.JsonDeserializer
20 | *
21 | * @since 2016-07-02
22 | * @author mk23
23 | * @version 3.3.3
24 | */
25 | public class DurationDeserializer extends JsonDeserializerRemote Method Invocation socket factory with connection timeout.
16 | * 17 | * Extends RMISocketFactory to return a socket that implements a connection timeout, 18 | * preventing black-holed backend agents from piling up connections in the server. 19 | * 20 | * @see java.net.Socket 21 | * @see java.rmi.server.RMISocketFactory 22 | * 23 | * @since 2017-01-20 24 | * @author mk23 25 | * @version 3.3.6 26 | */ 27 | public class TimeoutRMISocketFactory extends RMISocketFactory { 28 | private static final Logger LOG = LoggerFactory.getLogger(TimeoutRMISocketFactory.class); 29 | 30 | private int timeout; 31 | 32 | /** 33 | *Default constructor.
34 | * 35 | * Initializes the timeout to the specified value in milliseconds. 36 | * 37 | * @param timeout milliseconds to pass to Socket's connect() method. 38 | */ 39 | public TimeoutRMISocketFactory(final int timeout) { 40 | super(); 41 | 42 | this.timeout = timeout; 43 | } 44 | 45 | /** 46 | *Setter for timeout.
47 | * 48 | * Resets the timeout to the specified milliseconds value. 49 | * 50 | * @param timeout milliseconds to pass to Socket's connect() method. 51 | * 52 | * @return Modified TimeoutRMISocketFactory for setter chaining. 53 | */ 54 | public final TimeoutRMISocketFactory setTimeout(final int timeout) { 55 | this.timeout = timeout; 56 | return this; 57 | } 58 | 59 | /** {@inheritDoc} */ 60 | @Override 61 | public final Socket createSocket(final String host, final int port) throws IOException { 62 | LOG.debug("creating new socket with " + timeout + "ms timeout"); 63 | 64 | Socket socket = new Socket(); 65 | socket.connect(new InetSocketAddress(host, port), timeout); 66 | 67 | return socket; 68 | } 69 | 70 | /** {@inheritDoc} */ 71 | @Override 72 | public final ServerSocket createServerSocket(final int port) throws IOException { 73 | return new ServerSocket(port); 74 | } 75 | } 76 | -------------------------------------------------------------------------------- /debian/init: -------------------------------------------------------------------------------- 1 | #! /bin/sh 2 | ### BEGIN INIT INFO 3 | # Provides: jmxproxy 4 | # Required-Start: $remote_fs $syslog 5 | # Required-Stop: $remote_fs $syslog 6 | # Default-Start: 2 3 4 5 7 | # Default-Stop: 0 1 6 8 | # Short-Description: JMXProxy service 9 | # Description: Starts and stops the JMX to HTTP proxy 10 | # service. 11 | ### END INIT INFO 12 | 13 | # Author: Max KalikaJMXProxy main application.
17 | * 18 | * Configures application from {@link MainConfig}, initializes, and starts the service. 19 | * 20 | * @see io.dropwizard.Application 21 | * @see io.dropwizard.setup.Bootstrap 22 | * @see io.dropwizard.setup.Environment 23 | * 24 | * @since 2015-05-11 25 | * @author mk23 26 | * @version 3.2.0 27 | */ 28 | public class JMXProxyApplication extends Applicationmain application entrypoint.
33 | * 34 | * Starts main application. 35 | * 36 | * @param args an array of {@link String} command-line parameters. 37 | * 38 | * @throws Exception if initialization fails. 39 | */ 40 | public static void main(final String[] args) throws Exception { 41 | LOG.info("starting jmxproxy service"); 42 | new JMXProxyApplication().run(args); 43 | } 44 | 45 | /** {@inheritDoc} */ 46 | @Override 47 | public final String getName() { 48 | return "jmxproxy"; 49 | } 50 | 51 | /** {@inheritDoc} */ 52 | @Override 53 | public final void initialize(final BootstrapFixed size historical attribute value store.
9 | * 10 | * Saves an object into a fixed size round robin store. Allows clients to retreive latest 11 | * value, a subset of latest values, or the full stored history of values. When number 12 | * of stored values exceeds the fixed size of the store, the oldest values are overwritten. 13 | * 14 | * @paramDefault constructor.
28 | * 29 | * Initializes the {@link Object} store {@link List} to the given history size. 30 | * 31 | * @param length number of {@link Object} values to keep in history. 32 | */ 33 | public History(final int length) { 34 | this.length = length; 35 | 36 | pointer = -1; 37 | objects = new ArrayListAdds a item to the store.
42 | * 43 | * Adds a new item to the history store. If the number of items exceeds the size 44 | * of the store, the oldest item is overwritten. 45 | * 46 | * @param item newest item to add to the store. 47 | */ 48 | public final void add(final T item) { 49 | wrapped = ++pointer == length; 50 | pointer = pointer % length; 51 | 52 | objects.set(pointer, item); 53 | } 54 | 55 | /** 56 | *Gets the latest item from the history store.
57 | * 58 | * Gets the latest single item from the history store. 59 | * 60 | * @return Latest item from the history store or null if empty. 61 | */ 62 | public final T getLast() { 63 | return pointer < 0 ? null : objects.get(pointer % length); 64 | } 65 | 66 | /** 67 | *Gets the full item history from the store.
68 | * 69 | * Gets the full item history from the store as a {@link List}. 70 | * 71 | * @return {@link List} of the full history. May be empty if history has no items. 72 | */ 73 | public final ListGets a limited item history from the store.
79 | * 80 | * Gets a limited history from the store as a {@link List}, based 81 | * on requested item count. If the specified count is less than 0 or greater than 82 | * the number of entries, a full history is returned instead. 83 | * 84 | * @param limit number of items to retreive from the history store. 85 | * 86 | * @return {@link List} of the requested slice of history. May be empty if history has no items. 87 | */ 88 | public final ListJMX Username and Password user input POJO.
9 | * 10 | * Used to marshal JMX agent credentials and provide methods for comparing. 11 | * 12 | * @since 2015-05-11 13 | * @author mk23 14 | * @version 3.2.0 15 | */ 16 | public class ConnectionCredentials { 17 | @NotEmpty 18 | @JsonProperty 19 | private final String username; 20 | 21 | @NotEmpty 22 | @JsonProperty 23 | private final String password; 24 | 25 | private final String combined; 26 | 27 | private final boolean enabled; 28 | 29 | /** 30 | *Default disabled constructor.
31 | * 32 | * Creates a disabled credential object used for anonymous agent access. 33 | */ 34 | public ConnectionCredentials() { 35 | username = null; 36 | password = null; 37 | combined = null; 38 | 39 | enabled = false; 40 | } 41 | 42 | /** 43 | *Default constructor.
44 | * 45 | * Sets the instance username and password {@link String}s from provided parameters. 46 | * Builds a single combined credential string for the hashCode computation. 47 | * 48 | * @param username username {@link String} for the new credential instance. 49 | * @param password password {@link String} for the new credential instance. 50 | */ 51 | public ConnectionCredentials( 52 | @JsonProperty("username") final String username, 53 | @JsonProperty("password") final String password 54 | ) { 55 | if (username == null || password == null) { 56 | this.username = null; 57 | this.password = null; 58 | this.combined = null; 59 | 60 | this.enabled = false; 61 | } else { 62 | this.username = username; 63 | this.password = password; 64 | this.combined = username + "\0" + password; 65 | 66 | this.enabled = true; 67 | } 68 | } 69 | 70 | /** 71 | *Getter for username.
72 | * 73 | * Fetches the stored username {@link String}. 74 | * 75 | * @return username string. 76 | */ 77 | public final String getUsername() { 78 | return username; 79 | } 80 | 81 | /** 82 | *Getter for password.
83 | * 84 | * Fetches the stored password {@link String}. 85 | * 86 | * @return password string. 87 | */ 88 | public final String getPassword() { 89 | return password; 90 | } 91 | 92 | /** 93 | *Getter for enabled.
94 | * 95 | * Fetches enabled status for this credential object. 96 | * 97 | * @return enabled boolean. 98 | */ 99 | public final boolean isEnabled() { 100 | return enabled; 101 | } 102 | 103 | /** {@inheritDoc} */ 104 | @Override 105 | public final boolean equals(final Object obj) { 106 | if (obj != null && !(obj instanceof ConnectionCredentials)) { 107 | return false; 108 | } 109 | 110 | ConnectionCredentials peer = (obj != null) ? (ConnectionCredentials) obj : new ConnectionCredentials(); 111 | 112 | if (!enabled) { 113 | return !peer.isEnabled(); 114 | } 115 | 116 | return username.equals(peer.getUsername()) && password.equals(peer.getPassword()); 117 | } 118 | 119 | /** {@inheritDoc} */ 120 | @Override 121 | public final int hashCode() { 122 | return combined != null ? combined.hashCode() : 0; 123 | } 124 | } 125 | -------------------------------------------------------------------------------- /scripts/graphite/jmxproxy.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2.7 2 | 3 | import argparse 4 | import json 5 | import re 6 | import socket 7 | import time 8 | import urllib 9 | import urllib2 10 | 11 | mbeans = { 12 | 'jvm.thread_count': ('java.lang:type=Threading', 'ThreadCount'), 13 | 'jvm.thread_peak': ('java.lang:type=Threading', 'PeakThreadCount'), 14 | 'jvm.memory_heap_used': ('java.lang:type=Memory', 'HeapMemoryUsage', 'used'), 15 | 'jvm.memory_heap_max': ('java.lang:type=Memory', 'HeapMemoryUsage', 'max'), 16 | 'jvm.gc_count': ('java.lang:type=GarbageCollector,name=.*', 'CollectionCount'), 17 | 'jvm.classes_loaded': ('java.lang:type=ClassLoading', 'LoadedClassCount'), 18 | 'jvm.classes_total': ('java.lang:type=ClassLoading', 'TotalLoadedClassCount'), 19 | 'jvm.classes_unloaded': ('java.lang:type=ClassLoading', 'UnloadedClassCount'), 20 | } 21 | 22 | parser = argparse.ArgumentParser(description='jmxproxy poller for graphite') 23 | parser.add_argument('--service-host', default=socket.gethostname(), 24 | help='jvm jmx agent service host') 25 | parser.add_argument('--service-port', type=int, required=True, 26 | help='jvm jmx agent service port') 27 | parser.add_argument('--service-auth', 28 | help='jvm jmx agent service auth as username:password') 29 | parser.add_argument('--graphite-key', 30 | help='graphite key prefix') 31 | parser.add_argument('--graphite-host', default='localhost', 32 | help='graphite host') 33 | parser.add_argument('--graphite-port', type=int, default=2003, 34 | help='graphite port') 35 | parser.add_argument('--jmxproxy-host', default='localhost', 36 | help='jmxproxy host') 37 | parser.add_argument('--jmxproxy-port', type=int, default=8080, 38 | help='jmxproxy port') 39 | parser.add_argument('--jmxproxy-path', default='jmxproxy', 40 | help='jmxproxy path') 41 | parser.add_argument('-n', '--dry-run', default=False, action='store_true', 42 | help='print results instead of sending to graphite') 43 | 44 | def fetch_jmx(data, service_host, service_port, service_auth, jmxproxy_host, jmxproxy_port, jmxproxy_path): 45 | attrs = {} 46 | creds = None if not service_auth else urllib.urlencode(zip(('username', 'password'), service_auth.split(':'))) 47 | beans = json.loads(urllib2.urlopen('http://%s:%d/%s/%s:%d?full=true' % (jmxproxy_host, jmxproxy_port, jmxproxy_path, service_host, service_port), creds).read()) 48 | 49 | for key, val in data.items(): 50 | for mbean in beans: 51 | if re.match('%s$' % val[0], mbean): 52 | attr = beans[mbean] 53 | for i in xrange(1, len(val)): 54 | attr = attr[val[i]] 55 | 56 | if key not in attrs: 57 | attrs[key] = 0 58 | 59 | attrs[key] += attr 60 | 61 | return attrs 62 | 63 | def send_data(data, path, graphite_host, graphite_port, send=True): 64 | t = int(time.time()) 65 | m = '\n'.join("%s.%s %s %d" % (path, k, v, t) for k, v in sorted(data.items())) 66 | 67 | if send: 68 | s = socket.socket() 69 | s.connect((graphite_host, graphite_port)) 70 | s.send(m) 71 | else: 72 | print m 73 | 74 | 75 | def main(args=None, service='', extra_stats={}): 76 | if args is None: 77 | args = parser.parse_args() 78 | 79 | mbeans.update(extra_stats) 80 | data = fetch_jmx(mbeans, args.service_host, args.service_port, args.service_auth, args.jmxproxy_host, args.jmxproxy_port, args.jmxproxy_path) 81 | path = '.'.join(i for i in (args.graphite_key, args.service_host, service) if i) 82 | 83 | send_data(data, path, args.graphite_host, args.graphite_port, send=not args.dry_run) 84 | 85 | if __name__ == '__main__': 86 | main() 87 | -------------------------------------------------------------------------------- /src/test/java/com/github/mk23/jmxproxy/core/tests/HostTest.java: -------------------------------------------------------------------------------- 1 | package com.github.mk23.jmxproxy.core.tests; 2 | 3 | import com.github.mk23.jmxproxy.core.Host; 4 | 5 | import com.fasterxml.jackson.core.JsonProcessingException; 6 | import com.fasterxml.jackson.databind.JsonNode; 7 | import com.fasterxml.jackson.databind.ObjectMapper; 8 | 9 | import org.junit.Before; 10 | import org.junit.Rule; 11 | import org.junit.Test; 12 | import org.junit.rules.TestName; 13 | 14 | import static org.hamcrest.core.Is.is; 15 | import static org.junit.Assert.assertThat; 16 | import static org.junit.Assert.assertTrue; 17 | 18 | public class HostTest { 19 | private final ObjectMapper om = new ObjectMapper(); 20 | 21 | @Rule public TestName name = new TestName(); 22 | 23 | private String asJson(Object object) throws JsonProcessingException { 24 | return om.writeValueAsString(object); 25 | } 26 | 27 | @Before 28 | public void printTestName() { 29 | System.out.println(" -> " + name.getMethodName()); 30 | } 31 | 32 | @Test 33 | public void checkEmptyHost() throws Exception { 34 | final Host host = new Host(); 35 | final String expected = new String("{}"); 36 | 37 | assertThat("check empty host", asJson(host), is(expected)); 38 | } 39 | 40 | @Test 41 | public void checkEmptyHostMBeanList() throws Exception { 42 | final Host host = new Host(); 43 | final String expected = new String("[]"); 44 | 45 | assertThat("check empty host mbean list", asJson(host.getMBeans()), is(expected)); 46 | } 47 | 48 | @Test 49 | public void checkMissingMBean() throws Exception { 50 | final Host host = new Host(); 51 | final String expected = new String("null"); 52 | 53 | assertThat("check missing mbean", asJson(host.getMBean("bean")), is(expected)); 54 | } 55 | 56 | @Test 57 | public void checkDuplicateMBean() throws Exception { 58 | final Host host = new Host(); 59 | assertTrue(host.addMBean("bean") == host.addMBean("bean")); 60 | } 61 | 62 | @Test 63 | public void checkAddDefaultMBeanFull() throws Exception { 64 | final Host host = new Host(); 65 | host.addMBean("bean"); 66 | 67 | final String expected = new String("{\"bean\":{}}"); 68 | 69 | assertThat("check add default mbean full", asJson(host), is(expected)); 70 | } 71 | 72 | @Test 73 | public void checkAddDefaultMBeanList() throws Exception { 74 | final Host host = new Host(); 75 | host.addMBean("bean"); 76 | 77 | final String expected = new String("[\"bean\"]"); 78 | 79 | assertThat("check add default mbean list", asJson(host.getMBeans()), is(expected)); 80 | } 81 | 82 | @Test 83 | public void checkAddDefaultMBeanBare() throws Exception { 84 | final Host host = new Host(); 85 | host.addMBean("bean"); 86 | 87 | final String expected = new String("{}"); 88 | 89 | assertThat("check add default mbean bare", asJson(host.getMBean("bean")), is(expected)); 90 | } 91 | 92 | @Test 93 | public void checkAddExplicitMBeanFull() throws Exception { 94 | final Host host = new Host(); 95 | host.addMBean("bean", 1); 96 | 97 | final String expected = new String("{\"bean\":{}}"); 98 | 99 | assertThat("check add explicit mbean full", asJson(host), is(expected)); 100 | } 101 | 102 | @Test 103 | public void checkAddExplicitMBeanList() throws Exception { 104 | final Host host = new Host(); 105 | host.addMBean("bean", 1); 106 | 107 | final String expected = new String("[\"bean\"]"); 108 | 109 | assertThat("check add explicit mbean list", asJson(host.getMBeans()), is(expected)); 110 | } 111 | 112 | @Test 113 | public void checkAddExplicitMBeanBare() throws Exception { 114 | final Host host = new Host(); 115 | host.addMBean("bean", 1); 116 | 117 | final String expected = new String("{}"); 118 | 119 | assertThat("check add explicit mbean bare", asJson(host.getMBean("bean")), is(expected)); 120 | } 121 | 122 | @Test 123 | public void checkRemoveMBean() throws Exception { 124 | final Host host = new Host(); 125 | host.addMBean("bean"); 126 | host.removeMBean("bean"); 127 | 128 | final String expected = new String("{}"); 129 | 130 | assertThat("check remove mbean", asJson(host), is(expected)); 131 | } 132 | } 133 | -------------------------------------------------------------------------------- /src/test/java/com/github/mk23/jmxproxy/jmx/tests/ConnectionCredentialsTest.java: -------------------------------------------------------------------------------- 1 | package com.github.mk23.jmxproxy.jmx.tests; 2 | 3 | import com.github.mk23.jmxproxy.jmx.ConnectionCredentials; 4 | 5 | import org.junit.Before; 6 | import org.junit.Rule; 7 | import org.junit.Test; 8 | import org.junit.rules.TestName; 9 | 10 | import static org.junit.Assert.assertTrue; 11 | import static org.junit.Assert.assertFalse; 12 | 13 | public class ConnectionCredentialsTest { 14 | @Rule public TestName name = new TestName(); 15 | 16 | @Before 17 | public void printTestName() { 18 | System.out.println(" -> " + name.getMethodName()); 19 | } 20 | 21 | @Test 22 | public void checkAuthenticatedEquals() throws Exception { 23 | final ConnectionCredentials auth1 = new ConnectionCredentials(new String("user"), new String("pass")); 24 | final ConnectionCredentials auth2 = new ConnectionCredentials(new String("user"), new String("pass")); 25 | 26 | assertTrue(auth1.equals(auth2)); 27 | } 28 | 29 | @Test 30 | public void checkAuthenticatedNotEqualsUser() throws Exception { 31 | final ConnectionCredentials auth1 = new ConnectionCredentials(new String("user"), new String("pass")); 32 | final ConnectionCredentials auth2 = new ConnectionCredentials(new String("pass"), new String("pass")); 33 | 34 | assertFalse(auth1.equals(auth2)); 35 | } 36 | 37 | @Test 38 | public void checkAuthenticatedNotEqualsPass() throws Exception { 39 | final ConnectionCredentials auth1 = new ConnectionCredentials(new String("user"), new String("pass")); 40 | final ConnectionCredentials auth2 = new ConnectionCredentials(new String("user"), new String("user")); 41 | 42 | assertFalse(auth1.equals(auth2)); 43 | } 44 | 45 | @Test 46 | public void checkAuthenticatedNotEqualsBoth() throws Exception { 47 | final ConnectionCredentials auth1 = new ConnectionCredentials(new String("user"), new String("pass")); 48 | final ConnectionCredentials auth2 = new ConnectionCredentials(new String("pass"), new String("user")); 49 | 50 | assertFalse(auth1.equals(auth2)); 51 | } 52 | 53 | @Test 54 | public void checkAuthenticatedNotEqualsNull() throws Exception { 55 | final ConnectionCredentials auth = new ConnectionCredentials(new String("user"), new String("pass")); 56 | 57 | assertFalse(auth.equals(null)); 58 | } 59 | 60 | @Test 61 | public void checkAuthenticatedNotEqualsInvalid() throws Exception { 62 | final ConnectionCredentials auth = new ConnectionCredentials(new String("user"), new String("pass")); 63 | 64 | assertFalse(auth.equals(new String(""))); 65 | } 66 | 67 | @Test 68 | public void checkAuthenticatedEnabled() throws Exception { 69 | final ConnectionCredentials auth = new ConnectionCredentials(new String("user"), new String("pass")); 70 | 71 | assertTrue(auth.isEnabled()); 72 | } 73 | 74 | @Test 75 | public void checkAuthenticatedHashCode() throws Exception { 76 | final ConnectionCredentials auth = new ConnectionCredentials(new String("user"), new String("pass")); 77 | 78 | assertTrue(auth.hashCode() == new String("user\0pass").hashCode()); 79 | } 80 | 81 | @Test 82 | public void checkAnonymousEquals() throws Exception { 83 | final ConnectionCredentials auth1 = new ConnectionCredentials(); 84 | final ConnectionCredentials auth2 = new ConnectionCredentials(); 85 | 86 | assertTrue(auth1.equals(auth2)); 87 | } 88 | 89 | @Test 90 | public void checkAnonymousNotEquals() throws Exception { 91 | final ConnectionCredentials auth1 = new ConnectionCredentials(); 92 | final ConnectionCredentials auth2 = new ConnectionCredentials(new String("user"), new String("pass")); 93 | 94 | assertFalse(auth1.equals(auth2)); 95 | } 96 | 97 | @Test 98 | public void checkAnonymousNotEqualsNull() throws Exception { 99 | final ConnectionCredentials auth = new ConnectionCredentials(); 100 | 101 | assertTrue(auth.equals(null)); 102 | } 103 | 104 | @Test 105 | public void checkAnonymousEnabledUser() throws Exception { 106 | final ConnectionCredentials auth = new ConnectionCredentials(new String("user"), null); 107 | 108 | assertFalse(auth.isEnabled()); 109 | } 110 | 111 | @Test 112 | public void checkAnonymousEnabledPass() throws Exception { 113 | final ConnectionCredentials auth = new ConnectionCredentials(null, new String("pass")); 114 | 115 | assertFalse(auth.isEnabled()); 116 | } 117 | 118 | @Test 119 | public void checkAnonymousEnabledBoth() throws Exception { 120 | final ConnectionCredentials auth = new ConnectionCredentials(); 121 | 122 | assertFalse(auth.isEnabled()); 123 | } 124 | 125 | @Test 126 | public void checkAnonymousHashCode() throws Exception { 127 | final ConnectionCredentials auth = new ConnectionCredentials(); 128 | 129 | assertTrue(auth.hashCode() == 0); 130 | } 131 | } 132 | -------------------------------------------------------------------------------- /src/test/java/com/github/mk23/jmxproxy/tests/JMXProxyApplicationTest.java: -------------------------------------------------------------------------------- 1 | package com.github.mk23.jmxproxy.tests; 2 | 3 | import com.github.mk23.jmxproxy.JMXProxyApplication; 4 | import com.github.mk23.jmxproxy.conf.MainConfig; 5 | import com.github.mk23.jmxproxy.jmx.ConnectionManager; 6 | 7 | import com.fasterxml.jackson.databind.JsonNode; 8 | import com.fasterxml.jackson.databind.ObjectMapper; 9 | 10 | import io.dropwizard.testing.DropwizardTestSupport; 11 | import io.dropwizard.testing.FixtureHelpers; 12 | import io.dropwizard.testing.ResourceHelpers; 13 | 14 | import java.io.FileNotFoundException; 15 | 16 | import javax.ws.rs.client.Client; 17 | import javax.ws.rs.client.ClientBuilder; 18 | import javax.ws.rs.core.Response; 19 | 20 | import org.eclipse.jetty.util.component.LifeCycle; 21 | 22 | import org.junit.After; 23 | import org.junit.Before; 24 | import org.junit.Rule; 25 | import org.junit.Test; 26 | import org.junit.rules.ExpectedException; 27 | import org.junit.rules.TestName; 28 | 29 | import static org.junit.Assert.assertFalse; 30 | import static org.junit.Assert.assertNotNull; 31 | import static org.junit.Assert.assertTrue; 32 | 33 | public class JMXProxyApplicationTest { 34 | 35 | private static final String CONFIG = 36 | ResourceHelpers.resourceFilePath("main_config.yaml"); 37 | public static final DropwizardTestSupportJMX Host tracker and serializer.
17 | * 18 | * Maintains a map of JMX {@link MBean} names and their values. Implements 19 | * JsonSerializable interface to convert the stored map into JSON. 20 | * 21 | * @see com.fasterxml.jackson.databind.JsonSerializable 22 | * 23 | * @since 2018-02-08 24 | * @author mk23 25 | * @version 3.4.0 26 | */ 27 | public class Host implements JsonSerializable { 28 | private final MapDefault constructor.
37 | * 38 | * Creates a map of {@link MBean} name to associated values. 39 | */ 40 | public Host() { 41 | mbeans = new HashMapInserts a new MBean name to value association.
46 | * 47 | * Creates a new {@link MBean} object and inserts into the map store 48 | * associating it to the specified mbean name. Uses default attribute 49 | * {@link com.github.mk23.jmxproxy.util.History} size configuration. 50 | * 51 | * @param mbeanName name of the {@link MBean} used as the map key. 52 | * 53 | * @return the newly created {@link MBean} object. 54 | */ 55 | public final MBean addMBean(final String mbeanName) { 56 | if (!mbeans.containsKey(mbeanName)) { 57 | MBean mbean = new MBean(); 58 | mbeans.put(mbeanName, mbean); 59 | } 60 | 61 | return mbeans.get(mbeanName); 62 | } 63 | 64 | /** 65 | *Inserts a new MBean name to value association.
66 | * 67 | * Creates a new {@link MBean} object and inserts into the map store 68 | * associating it to the specified mbean name. Uses custom attribute 69 | * {@link com.github.mk23.jmxproxy.util.History} size configuration. 70 | * 71 | * @param mbeanName name of the {@link MBean} used as the map key. 72 | * @param historySize number of items to preserve in the associated 73 | * {@link com.github.mk23.jmxproxy.util.History}. 74 | * 75 | * @return the newly created {@link MBean} object. 76 | */ 77 | public final MBean addMBean(final String mbeanName, final int historySize) { 78 | if (!mbeans.containsKey(mbeanName)) { 79 | MBean mbean = new MBean(historySize); 80 | mbeans.put(mbeanName, mbean); 81 | } 82 | 83 | return mbeans.get(mbeanName); 84 | } 85 | 86 | /** 87 | *Deletes an mbean association.
88 | * 89 | * Removes an associated {@link MBean} from the map store for this host. 90 | * 91 | * @param mbeanName name of the {@link MBean} to remove. 92 | */ 93 | public final void removeMBean(final String mbeanName) { 94 | mbeans.remove(mbeanName); 95 | } 96 | 97 | /** 98 | *Sets the thread local history request limit.
99 | * 100 | * Set the thread local limit for all {@link com.github.mk23.jmxproxy.util.History} when 101 | * serializing to JSON. Because this method returns its object, requesting serialization 102 | * can be done * with a single statement. 103 | * 104 | *For example:
105 | * 106 | *return Response.ok(host.setLimit(5)).build();
107 | *
108 | * @see javax.ws.rs.core.Response
109 | *
110 | * @param bound the number of items to retreive from {@link com.github.mk23.jmxproxy.util.History}
111 | * for this thread.
112 | *
113 | * @return this host object for chaining calls.
114 | */
115 | public final Host setLimit(final Integer bound) {
116 | limit.set(bound);
117 | return this;
118 | }
119 |
120 | /**
121 | * Getter for mbean names.
122 | * 123 | * Extracts and returns the unique {@link Set} of all currently stored {@link MBean} names. 124 | * 125 | * @return {@link Set} of {@link MBean} name {@link String}s. 126 | */ 127 | public final SetGetter for specific mbean.
133 | * 134 | * Fetches the specified {@link MBean} from the map store. 135 | * 136 | * @param mbean name of the {@link MBean} to look up in the map store. 137 | * 138 | * @return {@link MBean} object if found, null otherwise. 139 | */ 140 | public final MBean getMBean(final String mbean) { 141 | return mbeans.get(mbean); 142 | } 143 | 144 | /** {@inheritDoc} */ 145 | public final void serialize( 146 | final JsonGenerator jgen, 147 | final SerializerProvider sp 148 | ) throws IOException, JsonProcessingException { 149 | serializeWithType(jgen, sp, null); 150 | } 151 | 152 | /** {@inheritDoc} */ 153 | public final void serializeWithType( 154 | final JsonGenerator jgen, 155 | final SerializerProvider sp, 156 | final TypeSerializer ts 157 | ) throws IOException, JsonProcessingException { 158 | buildJson(jgen); 159 | } 160 | 161 | private void buildJson(final JsonGenerator jgen) throws IOException, JsonProcessingException { 162 | int bound = limit.get(); 163 | 164 | jgen.writeStartObject(); 165 | for (Map.EntryJMX MBean tracker and serializer.
21 | * 22 | * Maintains a map of JMX {@link Attribute} names and a {@link History} of 23 | * their values. Implements JsonSerializable interface to convert the 24 | * stored map into JSON. 25 | * 26 | * @see com.fasterxml.jackson.databind.JsonSerializable 27 | * 28 | * @since 2018-02-08 29 | * @author mk23 30 | * @version 3.4.0 31 | */ 32 | public class MBean implements JsonSerializable { 33 | private final int historySize; 34 | 35 | private final MapDefault constructor.
44 | * 45 | * Creates a map of {@link Attribute} name to {@link History} of associated values. 46 | */ 47 | public MBean() { 48 | this.historySize = 1; 49 | attributes = new HashMapDefault constructor.
54 | * 55 | * Creates a map of {@link Attribute} name to {@link History} of associated values. 56 | * 57 | * @param historySize number of items to preserve in the associated {@link History}. 58 | */ 59 | public MBean(final int historySize) { 60 | this.historySize = historySize; 61 | attributes = new HashMapInserts a new Attribute name to History association.
66 | * 67 | * Optionally creates a new {@link History} object and inserts into the map store associating 68 | * it to the specified attribute name. Appends the specified {@link Attribute} value to the 69 | * {@link History}. 70 | * 71 | * @param attributeName name of the {@link Attribute} used as the map key. 72 | * @param attributeObject value of the {@link Attribute} added to history. 73 | */ 74 | public final void addAttribute(final String attributeName, final Object attributeObject) { 75 | if (!attributes.containsKey(attributeName)) { 76 | attributes.put(attributeName, new HistorySets the thread local history request limit.
84 | * 85 | * Set the thread local limit for all {@link History} when serializing to JSON. 86 | * Because this method returns its object, requesting serialization can be done 87 | * with a single statement. 88 | * 89 | *For example
90 | * 91 | *return Response.ok(mbean.setLimit(5)).build();
92 | *
93 | * @see javax.ws.rs.core.Response
94 | *
95 | * @param bound the number of items to retreive from {@link History} for this thread.
96 | *
97 | * @return this mbean object for chaining calls.
98 | */
99 | public final MBean setLimit(final Integer bound) {
100 | limit.set(bound);
101 | return this;
102 | }
103 |
104 | /**
105 | * Tester for attribute name.
106 | * 107 | * Checks for requested {@link Attribute} name in the map store. 108 | * 109 | * @param attribute name of the {@link Attribute} to look up in the map store. 110 | * 111 | * @return true if the {@link Attribute} exists in the map store, false otherwise. 112 | */ 113 | public final boolean hasAttribute(final String attribute) { 114 | return attributes.containsKey(attribute); 115 | } 116 | 117 | /** 118 | *Getter for attribute names.
119 | * 120 | * Extracts and returns the unique {@link Set} of all currently stored {@link Attribute} names. 121 | * 122 | * @return {@link Set} of {@link Attribute} name {@link String}s. 123 | */ 124 | public final SetGetter for most recent attribute.
130 | * 131 | * Fetches the most recent {@link Attribute} value for the specified name from the 132 | * associated {@link History} in the map store. 133 | * 134 | * @param attribute name of the {@link Attribute} to look up in the map store. 135 | * 136 | * @return latest {@link Attribute} object from {@link History} if found, null otherwise. 137 | */ 138 | public final Attribute getAttribute(final String attribute) { 139 | if (hasAttribute(attribute)) { 140 | return attributes.get(attribute).getLast(); 141 | } 142 | 143 | return null; 144 | } 145 | 146 | /** 147 | *Getter for a subset of historical attribute values.
148 | * 149 | * Fetches an array, limited by the requested bound, of most recent {@link Attribute} values 150 | * for the specified name from the associated {@link History} in the map store. 151 | * 152 | * @param attribute name of the {@link Attribute} to look up in the map store. 153 | * @param bound size of the resulting array or full history if this exceeds capacity or less than 1. 154 | * 155 | * @return {@link List} of the latest {@link Attribute} objects from {@link History} if found, empty otherwise. 156 | */ 157 | public final ListApplication configuration.
19 | * 20 | * Maintains application configuration fields. The application initializer 21 | * creates and marshals the object from JSON or Yaml config file. Setters 22 | * may be chained together for configuration building. 23 | * 24 | *For example:
25 | * 26 | *
27 | * AppConfig cfg = new AppConfig()
28 | * .setCleanInterval(Duration.minutes(5))
29 | * .setCacheDuration(Duration.minutes(10))
30 | * .setHistorySize(20);
31 | *
32 | *
33 | * @see io.dropwizard.util.Duration
34 | *
35 | * @since 2016-01-28
36 | * @author mk23
37 | * @version 3.3.6
38 | */
39 | @JsonSnakeCase
40 | public class AppConfig {
41 | /** Default clean interval minutes. */
42 | private static final int DEFAULT_CLEAN_INTERVAL = 1;
43 | /** Default cache duration minutes. */
44 | private static final int DEFAULT_CACHE_DURATION = 5;
45 | /** Default access duration minutes. */
46 | private static final int DEFAULT_ACCESS_DURATION = 30;
47 | /** Default jmx connect timeout milliseconds. */
48 | private static final int DEFAULT_CONNECT_TIMEOUT = 10000;
49 |
50 | /**
51 | * Configuration for how often to run the task that finds and
52 | * purges stale endpoints.
53 | */
54 | @Valid
55 | @JsonProperty
56 | @JsonDeserialize(using = DurationDeserializer.class)
57 | @JsonSerialize(using = DurationSerializer.class)
58 | private Duration cleanInterval = Duration.minutes(DEFAULT_CLEAN_INTERVAL);
59 |
60 | /**
61 | * Configuration for how often to reconnect to cached endpoints
62 | * and scrape available attributes.
63 | */
64 | @Valid
65 | @JsonProperty
66 | @JsonDeserialize(using = DurationDeserializer.class)
67 | @JsonSerialize(using = DurationSerializer.class)
68 | private Duration cacheDuration = Duration.minutes(DEFAULT_CACHE_DURATION);
69 |
70 | /**
71 | * Configuration for how long an endpoint goes unaccessed before
72 | * the purger tasks removes it from the cache.
73 | */
74 | @Valid
75 | @JsonProperty
76 | @JsonDeserialize(using = DurationDeserializer.class)
77 | @JsonSerialize(using = DurationSerializer.class)
78 | private Duration accessDuration = Duration.minutes(DEFAULT_ACCESS_DURATION);
79 |
80 | /**
81 | * Configuration for how long to wait for a JMX connection to complete
82 | * before declaring the endpoint as inaccessible.
83 | */
84 | @Valid
85 | @JsonProperty
86 | @JsonDeserialize(using = DurationDeserializer.class)
87 | @JsonSerialize(using = DurationSerializer.class)
88 | private Duration connectTimeout = Duration.minutes(DEFAULT_CONNECT_TIMEOUT);
89 |
90 | /**
91 | * Configuration for how many fetched attribute values to keep for
92 | * each cached endpoint.
93 | */
94 | @Min(1)
95 | @JsonProperty
96 | private int historySize = 1;
97 |
98 | /**
99 | * Configuration for whitelisted endpoints, allowing all when this
100 | * is empty.
101 | */
102 | @JsonProperty
103 | private ListGetter for cleanInterval.
107 | * 108 | * Configuration for how often to run the task that finds and 109 | * purges stale endpoints. 110 | * 111 | * @return Configured clean interval. 112 | */ 113 | public final Duration getCleanInterval() { 114 | return cleanInterval; 115 | } 116 | /** 117 | *Setter for cleanInterval.
118 | * 119 | * @param cleanInterval period at which the purger tasks operates. 120 | * 121 | * @return Modified AppConfig for setter chaining. 122 | */ 123 | public final AppConfig setCleanInterval(final Duration cleanInterval) { 124 | this.cleanInterval = cleanInterval; 125 | return this; 126 | } 127 | 128 | /** 129 | *Getter for cacheDuration.
130 | * 131 | * Configuration for how often to reconnect to cached endpoints 132 | * and scrape available attributes. 133 | * 134 | * @return Configured cache duration. 135 | */ 136 | public final Duration getCacheDuration() { 137 | return cacheDuration; 138 | } 139 | /** 140 | *Setter for cacheDuration.
141 | * 142 | * @param cacheDuration period at which the endpoint cache 143 | * refreshes. 144 | * 145 | * @return Modified AppConfig for setter chaining. 146 | */ 147 | public final AppConfig setCacheDuration(final Duration cacheDuration) { 148 | this.cacheDuration = cacheDuration; 149 | return this; 150 | } 151 | 152 | /** 153 | *Getter for accessDuration.
154 | * 155 | * Configuration for how long an endpoint goes unaccessed before 156 | * the purger tasks removes it from the cache. 157 | * 158 | * @return Configured access duration. 159 | */ 160 | public final Duration getAccessDuration() { 161 | return accessDuration; 162 | } 163 | /** 164 | *Setter for accessDuration.
165 | * 166 | * @param accessDuration time before an enpoint is removed 167 | * from the cache. 168 | * 169 | * @return Modified AppConfig for setter chaining. 170 | */ 171 | public final AppConfig setAccessDuration(final Duration accessDuration) { 172 | this.accessDuration = accessDuration; 173 | return this; 174 | } 175 | 176 | /** 177 | *Getter for connectTimeout.
178 | * 179 | * Configuration for how long to wait for a JMX connection to complete 180 | * before declaring the endpoint as inaccessible. 181 | * 182 | * @return Configured connect timeout. 183 | */ 184 | public final Duration getConnectTimeout() { 185 | return connectTimeout; 186 | } 187 | /** 188 | *Setter for connectTimeout.
189 | * 190 | * @param connectTimeout time before an abandoning a new JMX connection. 191 | * 192 | * @return Modified AppConfig for setter chaining. 193 | */ 194 | public final AppConfig setConnectTimeout(final Duration connectTimeout) { 195 | this.connectTimeout = connectTimeout; 196 | return this; 197 | } 198 | 199 | /** 200 | *Getter for historySize.
201 | * 202 | * Configuration for how many fetched attribute values to keep for 203 | * each cached endpoint. 204 | * 205 | * @return Configured history size. 206 | */ 207 | public final int getHistorySize() { 208 | return historySize; 209 | } 210 | /** 211 | *Setter for historySize.
212 | * 213 | * @param historySize number of values to keep for all cached 214 | * attributes at every requested endpoint. 215 | * 216 | * @return Modified AppConfig for setter chaining. 217 | */ 218 | public final AppConfig setHistorySize(final int historySize) { 219 | this.historySize = historySize; 220 | return this; 221 | } 222 | 223 | /** 224 | *Getter for allowedEndpoints.
225 | * 226 | * Configuration for whitelisted endpoints, allowing all when this 227 | * is empty. 228 | * 229 | * @return Configured {@link List} containing whitelisted endpoints. 230 | */ 231 | public final ListSetter for allowedEndpoints.
236 | * 237 | * @param allowedEndpoints {@link List} containing whitelisted endpoints. 238 | * 239 | * @return Modified AppConfig for setter chaining. 240 | */ 241 | public final AppConfig setAllowedEndpoints(final ListJMX Attribute tracker and serializer.
26 | * 27 | * Saves a JMX Attribute value object. Implements JsonSerializable 28 | * interface to convert the stored value into JSON. On serialization, 29 | * recursively inspects the value type and marshals it to JSON using 30 | * the supplied JsonGenerator. For {@link Array}, {@link Iterable}, 31 | * {@link TabularData}, builds a JSON array. For {@link CompositeData}, 32 | * builds a JSON object. For any other native types or null values, builds 33 | * a JSON equivalent. 34 | * 35 | *Special cases:
36 | * 37 | *NaN {@link Double} or {@link Float} value will yield
44 | * a JSON string "NaN".
45 | * infinite {@link Double} or {@link Float} value will
48 | * yield a JSON string "Infinity".
49 | * Default constructor.
65 | * 66 | * Saves the JMX Attribute object for later serialization. 67 | * 68 | * @param attributeValue object for later serialization. 69 | */ 70 | public Attribute(final Object attributeValue) { 71 | this.attributeValue = attributeValue; 72 | } 73 | 74 | /** {@inheritDoc} */ 75 | @Override 76 | public final void serialize( 77 | final JsonGenerator jgen, 78 | final SerializerProvider sp 79 | ) throws IOException, JsonProcessingException { 80 | serializeWithType(jgen, sp, null); 81 | } 82 | 83 | /** {@inheritDoc} */ 84 | @Override 85 | public final void serializeWithType( 86 | final JsonGenerator jgen, 87 | final SerializerProvider sp, 88 | final TypeSerializer ts 89 | ) throws IOException, JsonProcessingException { 90 | buildJson(jgen, attributeValue); 91 | } 92 | 93 | /** 94 | *JMX Attribute value JSON serializer.
95 | * 96 | * Inspects the stored JMX Attribute value type and serializes it to 97 | * JSON using the supplied JsonGenerator. Recursively calls itself 98 | * if finding JMX collections. For an {@link Array}, {@link Iterable}, 99 | * or {@link TabularData}, builds a JSON array. For {@link CompositeData}, 100 | * builds a JSON object. For any other native types or null values, builds 101 | * a JSON equivalent. 102 | * 103 | *Special cases:
104 | * 105 | *NaN {@link Double} or {@link Float} value will yield
112 | * a JSON string "NaN".
113 | * infinite {@link Double} or {@link Float} value will
116 | * yield a JSON string "Infinity".
117 | * JMX fetcher and tracker.
33 | * 34 | * Creates a {@link ScheduledExecutorService} to periodically make to a {@link JMXConnector} 35 | * to a JMX endpoint. At every execution, discovers and fetches all remote registered mbeans 36 | * and populates the local {@link Host} object with assicated {@link MBean}s and their 37 | * {@link com.github.mk23.jmxproxy.core.Attribute}. Also maintains the {@link Host} access 38 | * time to allow reaping of 39 | * unaccessed workers. 40 | * 41 | * @since 2015-05-11 42 | * @author mk23 43 | * @version 3.2.0 44 | */ 45 | public class ConnectionWorker { 46 | private static final Logger LOG = LoggerFactory.getLogger(ConnectionWorker.class); 47 | 48 | private Host host; 49 | private ConnectionCredentials authCreds; 50 | 51 | private boolean authValid; 52 | private IOException connError; 53 | 54 | private final Object fetchLock; 55 | private final int historySize; 56 | private final long cacheDuration; 57 | 58 | private final JMXServiceURL url; 59 | 60 | private long accessTime; 61 | 62 | private ScheduledExecutorService pollerSvc; 63 | 64 | /** 65 | *Default constructor.
66 | * 67 | * Initializes the {@link JMXServiceURL} to the specified hostName 68 | * and starts the {@link ScheduledExecutorService} for periodically 69 | * connecting and fetching JMX objects. 70 | * 71 | * @param hostName host:port {@link String} JMX agent target. 72 | * @param cacheDuration period in milliseconds for how often to connect to the JMX agent. 73 | * @param historySize number of {@link com.github.mk23.jmxproxy.core.Attribute}s to keep 74 | * per {@link MBean} {@link com.github.mk23.jmxproxy.util.History}. 75 | * 76 | * @throws MalformedURLException if the specified host is not a valid host:port {@link String}. 77 | */ 78 | public ConnectionWorker( 79 | final String hostName, 80 | final long cacheDuration, 81 | final int historySize 82 | ) throws MalformedURLException { 83 | this.historySize = historySize; 84 | this.cacheDuration = cacheDuration; 85 | 86 | fetchLock = new Object(); 87 | url = new JMXServiceURL("service:jmx:rmi:///jndi/rmi://" + hostName + "/jmxrmi"); 88 | } 89 | 90 | /** 91 | *Getter for host.
92 | * 93 | * Fetches the tracked {@link Host} object and resets the request access time. 94 | * 95 | * @param testCreds optional {@link ConnectionCredentials} for the provided JMX agent or null if none. 96 | * 97 | * @return {@link Host} as populated by the most recent fetch operation. 98 | * 99 | * @throws IOException if the specified host is unreachable. 100 | * @throws SecurityException if the specified credentials to the host are incorrect. 101 | */ 102 | public final Host getHost(final ConnectionCredentials testCreds) throws IOException, SecurityException { 103 | accessTime = System.currentTimeMillis(); 104 | 105 | if (host == null) { 106 | final CountDownLatch ready = new CountDownLatch(1); 107 | 108 | shutdown(); 109 | 110 | host = new Host(); 111 | authCreds = (testCreds != null) ? testCreds : new ConnectionCredentials(); 112 | 113 | pollerSvc = Executors.newSingleThreadScheduledExecutor(); 114 | pollerSvc.scheduleAtFixedRate(new Runnable() { 115 | @Override 116 | public void run() { 117 | try { 118 | fetchJMXValues(); 119 | } catch (Exception e) { 120 | e.printStackTrace(); 121 | } 122 | ready.countDown(); 123 | } 124 | }, 0, cacheDuration, TimeUnit.MILLISECONDS); 125 | 126 | try { 127 | ready.await(); 128 | } catch (InterruptedException e) { 129 | LOG.error("unable to finish first run", e); 130 | } 131 | } 132 | 133 | if (connError != null) { 134 | throw connError; 135 | } else if (!authCreds.equals(testCreds) && authValid) { 136 | throw new SecurityException(); 137 | } else if (!authValid) { 138 | throw new SecurityException(); 139 | } else { 140 | synchronized (fetchLock) { 141 | return host; 142 | } 143 | } 144 | } 145 | 146 | /** 147 | *
Checks expiration of this worker object.
148 | * 149 | * Checks the last access time against the provided duration limit to determine if this worker 150 | * is expired and can be purged. 151 | * 152 | * @param accessDuration time in milliseconds of no access after which this worker is expired. 153 | * 154 | * @return true if this worker hasn't been accessed recently, false otherwise. 155 | */ 156 | public final boolean isExpired(final long accessDuration) { 157 | return System.currentTimeMillis() - accessTime > accessDuration; 158 | } 159 | 160 | /** 161 | *Stops the scheduled fetcher.
162 | * 163 | * Signals the {@link ScheduledExecutorService} to shutdown for process termination cleanup. 164 | */ 165 | public final void shutdown() { 166 | if (pollerSvc != null && !pollerSvc.isShutdown()) { 167 | pollerSvc.shutdown(); 168 | } 169 | } 170 | 171 | private void fetchJMXValues() { 172 | JMXConnector connection = null; 173 | MBeanServerConnection server = null; 174 | 175 | MapMain application lifecycle object that manages all JMX Agent Connections.
30 | * 31 | * Implements the dropwizard lifecycle Managed interface to create the object responsible 32 | * for all application data management. Creates workers for connecting to JMX endpoints and 33 | * handles requests for data retreival. Controls purging unaccessed endpoints as well as 34 | * their runtime state. 35 | * 36 | * @see io.dropwizard.lifecycle.Managed 37 | * 38 | * @since 2015-05-11 39 | * @author mk23 40 | * @version 3.2.0 41 | */ 42 | public class ConnectionManager implements Managed { 43 | private static final Logger LOG = LoggerFactory.getLogger(ConnectionManager.class); 44 | 45 | private final AppConfig config; 46 | 47 | private final MapDefault constructor.
54 | * 55 | * Called by the application initializer. Creates the map of host:port {@link String}s to 56 | * associated {@link ConnectionWorker} instances. Creates an instance of the unaccessed 57 | * endpoints purge thread. Saves the provided applicaiton configuration for later retreival 58 | * request. 59 | * 60 | * @param config configuration as specified by the administrator at application invocation. 61 | */ 62 | public ConnectionManager(final AppConfig config) { 63 | this.config = config; 64 | 65 | int timeout = (int) config.getConnectTimeout().toMilliseconds(); 66 | try { 67 | RMISocketFactory.setSocketFactory(new TimeoutRMISocketFactory(timeout)); 68 | } catch (IOException e) { 69 | LOG.info("socket factory already defined, resetting timeout to " + timeout + "ms"); 70 | 71 | TimeoutRMISocketFactory sf = (TimeoutRMISocketFactory) RMISocketFactory.getSocketFactory(); 72 | sf.setTimeout(timeout); 73 | } 74 | 75 | hosts = new ConcurrentHashMapGetter for config.
81 | * 82 | * Fetches the application run-time configuration object. 83 | * 84 | * @return application configuration. 85 | */ 86 | public final AppConfig getConfiguration() { 87 | return config; 88 | } 89 | 90 | /** 91 | *Getter for hosts.
92 | * 93 | * Fetches the {@link Set} of {@link ConnectionWorker} name {@link String}s. 94 | * 95 | * @return {@link Set} of {@link ConnectionWorker} name {@link String}s. 96 | */ 97 | public final SetDeleter for host.
103 | * 104 | * Attempts to remove the specified host from the {@link ConnectionWorker} map store. 105 | * 106 | * @param host endpoint host:port {@link String}. 107 | * 108 | * @return true if the key is found in the map store. 109 | * 110 | * @throws WebApplicationException if key is not found in the map store. 111 | */ 112 | public final boolean delHost(final String host) throws WebApplicationException { 113 | ConnectionWorker worker = hosts.remove(host); 114 | if (worker != null) { 115 | LOG.debug("purging " + host); 116 | worker.shutdown(); 117 | 118 | return true; 119 | } else { 120 | throw new WebApplicationException(Response.Status.NOT_FOUND); 121 | } 122 | } 123 | 124 | /** 125 | *Anonymous getter for host.
126 | * 127 | * Fetches the specified {@link Host} with anonymous (null) credentials. 128 | * Equivalent to calling:return getHost(host, null);
131 | *
132 | * @param host endpoint host:port {@link String}.
133 | *
134 | * @return {@link Host} object for the requested endpoint.
135 | *
136 | * @throws WebApplicationException if unauthorized, forbidden, or invalid endpoint.
137 | */
138 | public final Host getHost(final String host) throws WebApplicationException {
139 | return getHost(host, null);
140 | }
141 |
142 | /**
143 | * Authenticated getter for host.
144 | * 145 | * Fetches the specified {@link Host} with provided credentials. Validates endpoint 146 | * access against a configured whitelist. Validates provided credentials against 147 | * previous requests and if different, a new {@link ConnectionWorker} object is 148 | * instanciated and associated with the specified endpoint. Lastly, if specified 149 | * endpoint is not yet in the map store, instanciates a new {@link ConnectionWorker} 150 | * and saves it for later retreival. 151 | * 152 | * @param host endpoint host:port {@link String}. 153 | * @param auth endpoint {@link ConnectionCredentials} or null for anonymous access. 154 | * 155 | * @return {@link Host} object for the requested endpoint. 156 | * 157 | * @throws WebApplicationException if 158 | *Getter for started.
196 | * 197 | * Used by the application health check to verify the manager start() method has been invoked. 198 | * 199 | * @return true if the manager was started, false otherwise. 200 | */ 201 | public final boolean isStarted() { 202 | return started; 203 | } 204 | 205 | /** 206 | *Handler for application startup.
207 | * 208 | * Starts the unaccessed endpoint purge thread at application initialization. 209 | */ 210 | public final void start() { 211 | LOG.info("starting jmx connection manager"); 212 | 213 | LOG.debug("allowedEndpoints: " + config.getAllowedEndpoints().size()); 214 | for (String ae : config.getAllowedEndpoints()) { 215 | LOG.debug(" " + ae); 216 | } 217 | 218 | long cleanInterval = config.getCleanInterval().toMilliseconds(); 219 | 220 | purge.scheduleAtFixedRate(new Runnable() { 221 | @Override 222 | public void run() { 223 | LOG.debug("begin expiring stale hosts"); 224 | for (Map.EntryHandler for application shutdown.
239 | * 240 | * Stops the purge thread and all currently tracked {@link ConnectionWorker} instances. 241 | */ 242 | public final void stop() { 243 | LOG.info("stopping jmx connection manager"); 244 | purge.shutdown(); 245 | for (Map.Entry