org.jolokia.kubernetes.client.KubernetesJmxConnectionProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jolokia-client-kubernetes Show documentation

Jolokia :: Client :: Kubernetes

There is a newer version: 2.1.1

Show newest version

package org.jolokia.kubernetes.client;

import java.io.IOException;
import java.net.MalformedURLException;
import java.util.Map;
import javax.management.remote.JMXConnector;
import javax.management.remote.JMXConnectorProvider;
import javax.management.remote.JMXServiceURL;

/**
 * This provides support for handling JMX urls over the Jolokia protocol to JVMs running in kubernetes pods
 * Syntax examples
 * 
 *   service:jmx:kubernetes:///mynamespace/mypodname-abcd-efgh/actuator/jolokia/
 *   service:jmx:kubernetes:///mynamespace/mypodname-.+/actuator/jolokia/
 * 
 *
 * Regular expressions in service url is supported so you can have working URLs across deploys.
 * Regular expression URLs will connect to the first pod/service that matches expession.
 * Prerequesite: You should have configuration and valid credentiatls for k8s cluster
 * readily in place, so you have access to the kubernetes api. You can validate this independently with a tool such as kubectl.
 * This jar file contains a service loader, so that Jolokia JMX protocol is supported
 * as long as my jar (jmx-adapter-version-standalone.jar) is on the classpath
 *
 *  *   Example:
 *   //NB: include trailing slash to jolokia endpoint
 *   JMXConnector connector = JMXConnectorFactory
 *             .connect(new JMXServiceURL("service:jmx:kubernetes:///mynamespace/mypodname-.+/actuator/jolokia/")));
 *         connector.connect();
 *         connector.getMBeanServerConnection();
 *
 * 
 */
public class KubernetesJmxConnectionProvider implements JMXConnectorProvider {
    @Override
    public JMXConnector newJMXConnector(JMXServiceURL serviceURL, Map environment) throws IOException {
        //the exception will be handled by JMXConnectorFactory so that other handlers are allowed to handle
        //other protocols
        if(!"kubernetes".equals(serviceURL.getProtocol())) {
            throw new MalformedURLException(String.format("Invalid URL %s : Only protocol \"kubernetes\" is supported (not %s)",  serviceURL, serviceURL.getProtocol()));
        }
        return new KubernetesJmxConnector(serviceURL, environment);
    }
}