Google Git
Sign in
apache / hbase-site / 2e3aaee18b357604e6f6797bafb8e59d3025ccb0 / . / devapidocs / src-html / org / apache / hadoop / hbase / JMXListener.html
blob: 60585f46f611f01825c176ce89eea44597bbad76 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a>
<span class="sourceLineNo">002</span> *<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a>
<span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a>
<span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a>
<span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a>
<span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a>
<span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a>
<span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a>
<span class="sourceLineNo">012</span> *<a name="line.12"></a>
<span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a>
<span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a>
<span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a>
<span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a>
<span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.lang.management.ManagementFactory;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.rmi.registry.LocateRegistry;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.rmi.registry.Registry;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.rmi.server.RMIClientSocketFactory;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.rmi.server.RMIServerSocketFactory;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.rmi.server.UnicastRemoteObject;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.HashMap;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import javax.management.MBeanServer;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import javax.management.remote.JMXConnectorServer;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import javax.management.remote.JMXConnectorServerFactory;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import javax.management.remote.JMXServiceURL;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import javax.management.remote.rmi.RMIConnectorServer;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.conf.Configuration;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.coprocessor.MasterCoprocessor;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.coprocessor.MasterCoprocessorEnvironment;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.coprocessor.RegionServerCoprocessor;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.coprocessor.RegionServerCoprocessorEnvironment;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.slf4j.Logger;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.slf4j.LoggerFactory;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>/**<a name="line.44"></a>
<span class="sourceLineNo">045</span> * Pluggable JMX Agent for HBase(to fix the 2 random TCP ports issue<a name="line.45"></a>
<span class="sourceLineNo">046</span> * of the out-of-the-box JMX Agent):<a name="line.46"></a>
<span class="sourceLineNo">047</span> * 1)connector port can share with the registry port if SSL is OFF<a name="line.47"></a>
<span class="sourceLineNo">048</span> * 2)support password authentication<a name="line.48"></a>
<span class="sourceLineNo">049</span> * 3)support subset of SSL (with default configuration)<a name="line.49"></a>
<span class="sourceLineNo">050</span> */<a name="line.50"></a>
<span class="sourceLineNo">051</span>@InterfaceAudience.Private<a name="line.51"></a>
<span class="sourceLineNo">052</span>public class JMXListener implements MasterCoprocessor, RegionServerCoprocessor {<a name="line.52"></a>
<span class="sourceLineNo">053</span> private static final Logger LOG = LoggerFactory.getLogger(JMXListener.class);<a name="line.53"></a>
<span class="sourceLineNo">054</span> public static final String RMI_REGISTRY_PORT_CONF_KEY = ".rmi.registry.port";<a name="line.54"></a>
<span class="sourceLineNo">055</span> public static final String RMI_CONNECTOR_PORT_CONF_KEY = ".rmi.connector.port";<a name="line.55"></a>
<span class="sourceLineNo">056</span> public static final int defMasterRMIRegistryPort = 10101;<a name="line.56"></a>
<span class="sourceLineNo">057</span> public static final int defRegionserverRMIRegistryPort = 10102;<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> /**<a name="line.59"></a>
<span class="sourceLineNo">060</span> * workaround for HBASE-11146<a name="line.60"></a>
<span class="sourceLineNo">061</span> * master and regionserver are in 1 JVM in standalone mode<a name="line.61"></a>
<span class="sourceLineNo">062</span> * only 1 JMX instance is allowed, otherwise there is port conflict even if<a name="line.62"></a>
<span class="sourceLineNo">063</span> * we only load regionserver coprocessor on master<a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span> private static JMXConnectorServer JMX_CS = null;<a name="line.65"></a>
<span class="sourceLineNo">066</span> private Registry rmiRegistry = null;<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span> public static JMXServiceURL buildJMXServiceURL(int rmiRegistryPort,<a name="line.68"></a>
<span class="sourceLineNo">069</span> int rmiConnectorPort) throws IOException {<a name="line.69"></a>
<span class="sourceLineNo">070</span> // Build jmxURL<a name="line.70"></a>
<span class="sourceLineNo">071</span> StringBuilder url = new StringBuilder();<a name="line.71"></a>
<span class="sourceLineNo">072</span> url.append("service:jmx:rmi://localhost:");<a name="line.72"></a>
<span class="sourceLineNo">073</span> url.append(rmiConnectorPort);<a name="line.73"></a>
<span class="sourceLineNo">074</span> url.append("/jndi/rmi://localhost:");<a name="line.74"></a>
<span class="sourceLineNo">075</span> url.append(rmiRegistryPort);<a name="line.75"></a>
<span class="sourceLineNo">076</span> url.append("/jmxrmi");<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> return new JMXServiceURL(url.toString());<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> }<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> public void startConnectorServer(int rmiRegistryPort, int rmiConnectorPort)<a name="line.82"></a>
<span class="sourceLineNo">083</span> throws IOException {<a name="line.83"></a>
<span class="sourceLineNo">084</span> boolean rmiSSL = false;<a name="line.84"></a>
<span class="sourceLineNo">085</span> boolean authenticate = true;<a name="line.85"></a>
<span class="sourceLineNo">086</span> String passwordFile = null;<a name="line.86"></a>
<span class="sourceLineNo">087</span> String accessFile = null;<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> System.setProperty("java.rmi.server.randomIDs", "true");<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> String rmiSSLValue = System.getProperty("com.sun.management.jmxremote.ssl",<a name="line.91"></a>
<span class="sourceLineNo">092</span> "false");<a name="line.92"></a>
<span class="sourceLineNo">093</span> rmiSSL = Boolean.parseBoolean(rmiSSLValue);<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> String authenticateValue =<a name="line.95"></a>
<span class="sourceLineNo">096</span> System.getProperty("com.sun.management.jmxremote.authenticate", "false");<a name="line.96"></a>
<span class="sourceLineNo">097</span> authenticate = Boolean.parseBoolean(authenticateValue);<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> passwordFile = System.getProperty("com.sun.management.jmxremote.password.file");<a name="line.99"></a>
<span class="sourceLineNo">100</span> accessFile = System.getProperty("com.sun.management.jmxremote.access.file");<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> LOG.info("rmiSSL:" + rmiSSLValue + ",authenticate:" + authenticateValue<a name="line.102"></a>
<span class="sourceLineNo">103</span> + ",passwordFile:" + passwordFile + ",accessFile:" + accessFile);<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> // Environment map<a name="line.105"></a>
<span class="sourceLineNo">106</span> HashMap&lt;String, Object&gt; jmxEnv = new HashMap&lt;&gt;();<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> RMIClientSocketFactory csf = null;<a name="line.108"></a>
<span class="sourceLineNo">109</span> RMIServerSocketFactory ssf = null;<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> if (rmiSSL) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> if (rmiRegistryPort == rmiConnectorPort) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> throw new IOException("SSL is enabled. " +<a name="line.113"></a>
<span class="sourceLineNo">114</span> "rmiConnectorPort cannot share with the rmiRegistryPort!");<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span> csf = new SslRMIClientSocketFactorySecure();<a name="line.116"></a>
<span class="sourceLineNo">117</span> ssf = new SslRMIServerSocketFactorySecure();<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> if (csf != null) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> jmxEnv.put(RMIConnectorServer.RMI_CLIENT_SOCKET_FACTORY_ATTRIBUTE, csf);<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span> if (ssf != null) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> jmxEnv.put(RMIConnectorServer.RMI_SERVER_SOCKET_FACTORY_ATTRIBUTE, ssf);<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> // Configure authentication<a name="line.127"></a>
<span class="sourceLineNo">128</span> if (authenticate) {<a name="line.128"></a>
<span class="sourceLineNo">129</span> jmxEnv.put("jmx.remote.x.password.file", passwordFile);<a name="line.129"></a>
<span class="sourceLineNo">130</span> jmxEnv.put("jmx.remote.x.access.file", accessFile);<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span> // Create the RMI registry<a name="line.133"></a>
<span class="sourceLineNo">134</span> rmiRegistry = LocateRegistry.createRegistry(rmiRegistryPort);<a name="line.134"></a>
<span class="sourceLineNo">135</span> // Retrieve the PlatformMBeanServer.<a name="line.135"></a>
<span class="sourceLineNo">136</span> MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();<a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span> // Build jmxURL<a name="line.138"></a>
<span class="sourceLineNo">139</span> JMXServiceURL serviceUrl = buildJMXServiceURL(rmiRegistryPort, rmiConnectorPort);<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> try {<a name="line.141"></a>
<span class="sourceLineNo">142</span> // Start the JMXListener with the connection string<a name="line.142"></a>
<span class="sourceLineNo">143</span> synchronized(JMXListener.class) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> if (JMX_CS != null) {<a name="line.144"></a>
<span class="sourceLineNo">145</span> throw new RuntimeException("Started by another thread?");<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span> JMX_CS = JMXConnectorServerFactory.newJMXConnectorServer(serviceUrl, jmxEnv, mbs);<a name="line.147"></a>
<span class="sourceLineNo">148</span> JMX_CS.start();<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span> LOG.info("JMXConnectorServer started!");<a name="line.150"></a>
<span class="sourceLineNo">151</span> } catch (IOException e) {<a name="line.151"></a>
<span class="sourceLineNo">152</span> LOG.error("Failed start of JMXConnectorServer!", e);<a name="line.152"></a>
<span class="sourceLineNo">153</span> // deregister the RMI registry<a name="line.153"></a>
<span class="sourceLineNo">154</span> if (rmiRegistry != null) {<a name="line.154"></a>
<span class="sourceLineNo">155</span> UnicastRemoteObject.unexportObject(rmiRegistry, true);<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span> }<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span> public void stopConnectorServer() throws IOException {<a name="line.161"></a>
<span class="sourceLineNo">162</span> synchronized (JMXListener.class) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> if (JMX_CS != null) {<a name="line.163"></a>
<span class="sourceLineNo">164</span> JMX_CS.stop();<a name="line.164"></a>
<span class="sourceLineNo">165</span> LOG.info("ConnectorServer stopped!");<a name="line.165"></a>
<span class="sourceLineNo">166</span> JMX_CS = null;<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span> // deregister the RMI registry<a name="line.168"></a>
<span class="sourceLineNo">169</span> if (rmiRegistry != null) {<a name="line.169"></a>
<span class="sourceLineNo">170</span> UnicastRemoteObject.unexportObject(rmiRegistry, true);<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span> }<a name="line.172"></a>
<span class="sourceLineNo">173</span> }<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span><a name="line.175"></a>
<span class="sourceLineNo">176</span> @Override<a name="line.176"></a>
<span class="sourceLineNo">177</span> public void start(CoprocessorEnvironment env) throws IOException {<a name="line.177"></a>
<span class="sourceLineNo">178</span> int rmiRegistryPort = -1;<a name="line.178"></a>
<span class="sourceLineNo">179</span> int rmiConnectorPort = -1;<a name="line.179"></a>
<span class="sourceLineNo">180</span> Configuration conf = env.getConfiguration();<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span> if (env instanceof MasterCoprocessorEnvironment) {<a name="line.182"></a>
<span class="sourceLineNo">183</span> // running on Master<a name="line.183"></a>
<span class="sourceLineNo">184</span> rmiRegistryPort =<a name="line.184"></a>
<span class="sourceLineNo">185</span> conf.getInt("master" + RMI_REGISTRY_PORT_CONF_KEY, defMasterRMIRegistryPort);<a name="line.185"></a>
<span class="sourceLineNo">186</span> rmiConnectorPort = conf.getInt("master" + RMI_CONNECTOR_PORT_CONF_KEY, rmiRegistryPort);<a name="line.186"></a>
<span class="sourceLineNo">187</span> LOG.info("Master rmiRegistryPort:" + rmiRegistryPort + ",Master rmiConnectorPort:"<a name="line.187"></a>
<span class="sourceLineNo">188</span> + rmiConnectorPort);<a name="line.188"></a>
<span class="sourceLineNo">189</span> } else if (env instanceof RegionServerCoprocessorEnvironment) {<a name="line.189"></a>
<span class="sourceLineNo">190</span> // running on RegionServer<a name="line.190"></a>
<span class="sourceLineNo">191</span> rmiRegistryPort =<a name="line.191"></a>
<span class="sourceLineNo">192</span> conf.getInt("regionserver" + RMI_REGISTRY_PORT_CONF_KEY,<a name="line.192"></a>
<span class="sourceLineNo">193</span> defRegionserverRMIRegistryPort);<a name="line.193"></a>
<span class="sourceLineNo">194</span> rmiConnectorPort =<a name="line.194"></a>
<span class="sourceLineNo">195</span> conf.getInt("regionserver" + RMI_CONNECTOR_PORT_CONF_KEY, rmiRegistryPort);<a name="line.195"></a>
<span class="sourceLineNo">196</span> LOG.info("RegionServer rmiRegistryPort:" + rmiRegistryPort<a name="line.196"></a>
<span class="sourceLineNo">197</span> + ",RegionServer rmiConnectorPort:" + rmiConnectorPort);<a name="line.197"></a>
<span class="sourceLineNo">198</span><a name="line.198"></a>
<span class="sourceLineNo">199</span> } else if (env instanceof RegionCoprocessorEnvironment) {<a name="line.199"></a>
<span class="sourceLineNo">200</span> LOG.error("JMXListener should not be loaded in Region Environment!");<a name="line.200"></a>
<span class="sourceLineNo">201</span> return;<a name="line.201"></a>
<span class="sourceLineNo">202</span> }<a name="line.202"></a>
<span class="sourceLineNo">203</span><a name="line.203"></a>
<span class="sourceLineNo">204</span> synchronized(JMXListener.class) {<a name="line.204"></a>
<span class="sourceLineNo">205</span> if (JMX_CS != null) {<a name="line.205"></a>
<span class="sourceLineNo">206</span> LOG.info("JMXListener has been started at Registry port " + rmiRegistryPort);<a name="line.206"></a>
<span class="sourceLineNo">207</span> }<a name="line.207"></a>
<span class="sourceLineNo">208</span> else {<a name="line.208"></a>
<span class="sourceLineNo">209</span> startConnectorServer(rmiRegistryPort, rmiConnectorPort);<a name="line.209"></a>
<span class="sourceLineNo">210</span> }<a name="line.210"></a>
<span class="sourceLineNo">211</span> }<a name="line.211"></a>
<span class="sourceLineNo">212</span> }<a name="line.212"></a>
<span class="sourceLineNo">213</span><a name="line.213"></a>
<span class="sourceLineNo">214</span> @Override<a name="line.214"></a>
<span class="sourceLineNo">215</span> public void stop(CoprocessorEnvironment env) throws IOException {<a name="line.215"></a>
<span class="sourceLineNo">216</span> stopConnectorServer();<a name="line.216"></a>
<span class="sourceLineNo">217</span> }<a name="line.217"></a>
<span class="sourceLineNo">218</span><a name="line.218"></a>
<span class="sourceLineNo">219</span>}<a name="line.219"></a>
</pre>
</div>
</body>
</html>