| <!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"> * Licensed to the Apache Software Foundation (ASF) under one or more</a> |
| <span class="sourceLineNo">003</span><a name="line.3"> * contributor license agreements. See the NOTICE file distributed with</a> |
| <span class="sourceLineNo">004</span><a name="line.4"> * this work for additional information regarding copyright ownership.</a> |
| <span class="sourceLineNo">005</span><a name="line.5"> * The ASF licenses this file to You under the Apache license, Version 2.0</a> |
| <span class="sourceLineNo">006</span><a name="line.6"> * (the "License"); you may not use this file except in compliance with</a> |
| <span class="sourceLineNo">007</span><a name="line.7"> * the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">008</span><a name="line.8"> *</a> |
| <span class="sourceLineNo">009</span><a name="line.9"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">010</span><a name="line.10"> *</a> |
| <span class="sourceLineNo">011</span><a name="line.11"> * Unless required by applicable law or agreed to in writing, software</a> |
| <span class="sourceLineNo">012</span><a name="line.12"> * distributed under the License is distributed on an "AS IS" BASIS,</a> |
| <span class="sourceLineNo">013</span><a name="line.13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a> |
| <span class="sourceLineNo">014</span><a name="line.14"> * See the license for the specific language governing permissions and</a> |
| <span class="sourceLineNo">015</span><a name="line.15"> * limitations under the license.</a> |
| <span class="sourceLineNo">016</span><a name="line.16"> */</a> |
| <span class="sourceLineNo">017</span><a name="line.17">package org.apache.logging.log4j.kubernetes;</a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19">import java.net.URL;</a> |
| <span class="sourceLineNo">020</span><a name="line.20">import java.nio.file.Paths;</a> |
| <span class="sourceLineNo">021</span><a name="line.21">import java.util.Map;</a> |
| <span class="sourceLineNo">022</span><a name="line.22">import java.util.concurrent.locks.Lock;</a> |
| <span class="sourceLineNo">023</span><a name="line.23">import java.util.concurrent.locks.ReentrantLock;</a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span><a name="line.25">import org.apache.logging.log4j.LogManager;</a> |
| <span class="sourceLineNo">026</span><a name="line.26">import org.apache.logging.log4j.Logger;</a> |
| <span class="sourceLineNo">027</span><a name="line.27">import org.apache.logging.log4j.core.LogEvent;</a> |
| <span class="sourceLineNo">028</span><a name="line.28">import org.apache.logging.log4j.core.config.plugins.Plugin;</a> |
| <span class="sourceLineNo">029</span><a name="line.29">import org.apache.logging.log4j.core.lookup.AbstractLookup;</a> |
| <span class="sourceLineNo">030</span><a name="line.30">import org.apache.logging.log4j.core.lookup.StrLookup;</a> |
| <span class="sourceLineNo">031</span><a name="line.31">import org.apache.logging.log4j.status.StatusLogger;</a> |
| <span class="sourceLineNo">032</span><a name="line.32">import org.apache.logging.log4j.util.LoaderUtil;</a> |
| <span class="sourceLineNo">033</span><a name="line.33">import org.apache.logging.log4j.util.Strings;</a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35">import io.fabric8.kubernetes.api.model.Container;</a> |
| <span class="sourceLineNo">036</span><a name="line.36">import io.fabric8.kubernetes.api.model.ContainerStatus;</a> |
| <span class="sourceLineNo">037</span><a name="line.37">import io.fabric8.kubernetes.api.model.Namespace;</a> |
| <span class="sourceLineNo">038</span><a name="line.38">import io.fabric8.kubernetes.api.model.Pod;</a> |
| <span class="sourceLineNo">039</span><a name="line.39">import io.fabric8.kubernetes.client.Config;</a> |
| <span class="sourceLineNo">040</span><a name="line.40">import io.fabric8.kubernetes.client.KubernetesClient;</a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span><a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43">/**</a> |
| <span class="sourceLineNo">044</span><a name="line.44"> * Retrieve various Kubernetes attributes. Supported keys are:</a> |
| <span class="sourceLineNo">045</span><a name="line.45"> * accountName, containerId, containerName, clusterName, host, hostIp, labels, labels.app,</a> |
| <span class="sourceLineNo">046</span><a name="line.46"> * labels.podTemplateHash, masterUrl, namespaceId, namespaceName, podId, podIp, podName,</a> |
| <span class="sourceLineNo">047</span><a name="line.47"> * imageId, imageName.</a> |
| <span class="sourceLineNo">048</span><a name="line.48"> */</a> |
| <span class="sourceLineNo">049</span><a name="line.49">@Plugin(name = "k8s", category = StrLookup.CATEGORY)</a> |
| <span class="sourceLineNo">050</span><a name="line.50">public class KubernetesLookup extends AbstractLookup {</a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"> private static final Logger LOGGER = StatusLogger.getLogger();</a> |
| <span class="sourceLineNo">053</span><a name="line.53"> private static final String HOSTNAME = "HOSTNAME";</a> |
| <span class="sourceLineNo">054</span><a name="line.54"> private static final String SPRING_ENVIRONMENT_KEY = "SpringEnvironment";</a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"> private static volatile KubernetesInfo kubernetesInfo;</a> |
| <span class="sourceLineNo">057</span><a name="line.57"> private static Lock initLock = new ReentrantLock();</a> |
| <span class="sourceLineNo">058</span><a name="line.58"> private static boolean isSpringIncluded =</a> |
| <span class="sourceLineNo">059</span><a name="line.59"> LoaderUtil.isClassAvailable("org.apache.logging.log4j.spring.cloud.config.client.SpringEnvironmentHolder");</a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"> private boolean initialize() {</a> |
| <span class="sourceLineNo">062</span><a name="line.62"> if (kubernetesInfo == null || (isSpringIncluded && !kubernetesInfo.isSpringActive)) {</a> |
| <span class="sourceLineNo">063</span><a name="line.63"> initLock.lock();</a> |
| <span class="sourceLineNo">064</span><a name="line.64"> boolean isSpringActive = isSpringActive();</a> |
| <span class="sourceLineNo">065</span><a name="line.65"> if (kubernetesInfo == null || (!kubernetesInfo.isSpringActive && isSpringActive)) {</a> |
| <span class="sourceLineNo">066</span><a name="line.66"> try {</a> |
| <span class="sourceLineNo">067</span><a name="line.67"> KubernetesClient client = new KubernetesClientBuilder().createClient();</a> |
| <span class="sourceLineNo">068</span><a name="line.68"> if (client != null) {</a> |
| <span class="sourceLineNo">069</span><a name="line.69"> KubernetesInfo info = new KubernetesInfo();</a> |
| <span class="sourceLineNo">070</span><a name="line.70"> info.isSpringActive = isSpringActive;</a> |
| <span class="sourceLineNo">071</span><a name="line.71"> info.hostName = getHostname();</a> |
| <span class="sourceLineNo">072</span><a name="line.72"> Pod pod = getCurrentPod(info.hostName, client);</a> |
| <span class="sourceLineNo">073</span><a name="line.73"> if (pod != null) {</a> |
| <span class="sourceLineNo">074</span><a name="line.74"> info.app = pod.getMetadata().getLabels().get("app");</a> |
| <span class="sourceLineNo">075</span><a name="line.75"> final String app = info.app != null ? info.app : "";</a> |
| <span class="sourceLineNo">076</span><a name="line.76"> info.podTemplateHash = pod.getMetadata().getLabels().get("pod-template-hash");</a> |
| <span class="sourceLineNo">077</span><a name="line.77"> info.accountName = pod.getSpec().getServiceAccountName();</a> |
| <span class="sourceLineNo">078</span><a name="line.78"> info.clusterName = pod.getMetadata().getClusterName();</a> |
| <span class="sourceLineNo">079</span><a name="line.79"> info.hostIp = pod.getStatus().getHostIP();</a> |
| <span class="sourceLineNo">080</span><a name="line.80"> info.labels = pod.getMetadata().getLabels();</a> |
| <span class="sourceLineNo">081</span><a name="line.81"> info.podId = pod.getMetadata().getUid();</a> |
| <span class="sourceLineNo">082</span><a name="line.82"> info.podIp = pod.getStatus().getPodIP();</a> |
| <span class="sourceLineNo">083</span><a name="line.83"> info.podName = pod.getMetadata().getName();</a> |
| <span class="sourceLineNo">084</span><a name="line.84"> Container container = pod.getSpec().getContainers().stream()</a> |
| <span class="sourceLineNo">085</span><a name="line.85"> .filter(c -> c.getName().equals(app)).findFirst().orElse(null);</a> |
| <span class="sourceLineNo">086</span><a name="line.86"> if (container != null) {</a> |
| <span class="sourceLineNo">087</span><a name="line.87"> info.containerName = container.getName();</a> |
| <span class="sourceLineNo">088</span><a name="line.88"> info.imageName = container.getImage();</a> |
| <span class="sourceLineNo">089</span><a name="line.89"> }</a> |
| <span class="sourceLineNo">090</span><a name="line.90"> info.masterUrl = client.getMasterUrl();</a> |
| <span class="sourceLineNo">091</span><a name="line.91"> info.namespace = pod.getMetadata().getNamespace();</a> |
| <span class="sourceLineNo">092</span><a name="line.92"> Namespace namespace = client.namespaces().withName(info.namespace).get();</a> |
| <span class="sourceLineNo">093</span><a name="line.93"> if (namespace != null) {</a> |
| <span class="sourceLineNo">094</span><a name="line.94"> info.namespaceId = namespace.getMetadata().getUid();</a> |
| <span class="sourceLineNo">095</span><a name="line.95"> }</a> |
| <span class="sourceLineNo">096</span><a name="line.96"> ContainerStatus containerStatus = pod.getStatus().getContainerStatuses().stream()</a> |
| <span class="sourceLineNo">097</span><a name="line.97"> .filter(cs -> cs.getName().equals(app)).findFirst().orElse(null);</a> |
| <span class="sourceLineNo">098</span><a name="line.98"> if (containerStatus != null) {</a> |
| <span class="sourceLineNo">099</span><a name="line.99"> info.containerId = containerStatus.getContainerID();</a> |
| <span class="sourceLineNo">100</span><a name="line.100"> info.imageId = containerStatus.getImageID();</a> |
| <span class="sourceLineNo">101</span><a name="line.101"> }</a> |
| <span class="sourceLineNo">102</span><a name="line.102"> kubernetesInfo = info;</a> |
| <span class="sourceLineNo">103</span><a name="line.103"> }</a> |
| <span class="sourceLineNo">104</span><a name="line.104"> }</a> |
| <span class="sourceLineNo">105</span><a name="line.105"> } finally {</a> |
| <span class="sourceLineNo">106</span><a name="line.106"> initLock.unlock();</a> |
| <span class="sourceLineNo">107</span><a name="line.107"> }</a> |
| <span class="sourceLineNo">108</span><a name="line.108"> }</a> |
| <span class="sourceLineNo">109</span><a name="line.109"> }</a> |
| <span class="sourceLineNo">110</span><a name="line.110"> return kubernetesInfo != null;</a> |
| <span class="sourceLineNo">111</span><a name="line.111"> }</a> |
| <span class="sourceLineNo">112</span><a name="line.112"></a> |
| <span class="sourceLineNo">113</span><a name="line.113"> @Override</a> |
| <span class="sourceLineNo">114</span><a name="line.114"> public String lookup(LogEvent event, String key) {</a> |
| <span class="sourceLineNo">115</span><a name="line.115"> if (!initialize()) {</a> |
| <span class="sourceLineNo">116</span><a name="line.116"> return null;</a> |
| <span class="sourceLineNo">117</span><a name="line.117"> }</a> |
| <span class="sourceLineNo">118</span><a name="line.118"> switch (key) {</a> |
| <span class="sourceLineNo">119</span><a name="line.119"> case "accountName": {</a> |
| <span class="sourceLineNo">120</span><a name="line.120"> return kubernetesInfo.accountName;</a> |
| <span class="sourceLineNo">121</span><a name="line.121"> }</a> |
| <span class="sourceLineNo">122</span><a name="line.122"> case "containerId": {</a> |
| <span class="sourceLineNo">123</span><a name="line.123"> return kubernetesInfo.containerId;</a> |
| <span class="sourceLineNo">124</span><a name="line.124"> }</a> |
| <span class="sourceLineNo">125</span><a name="line.125"> case "containerName": {</a> |
| <span class="sourceLineNo">126</span><a name="line.126"> return kubernetesInfo.containerName;</a> |
| <span class="sourceLineNo">127</span><a name="line.127"> }</a> |
| <span class="sourceLineNo">128</span><a name="line.128"> case "clusterName": {</a> |
| <span class="sourceLineNo">129</span><a name="line.129"> return kubernetesInfo.clusterName;</a> |
| <span class="sourceLineNo">130</span><a name="line.130"> }</a> |
| <span class="sourceLineNo">131</span><a name="line.131"> case "host": {</a> |
| <span class="sourceLineNo">132</span><a name="line.132"> return kubernetesInfo.hostName;</a> |
| <span class="sourceLineNo">133</span><a name="line.133"> }</a> |
| <span class="sourceLineNo">134</span><a name="line.134"> case "hostIp": {</a> |
| <span class="sourceLineNo">135</span><a name="line.135"> return kubernetesInfo.hostIp;</a> |
| <span class="sourceLineNo">136</span><a name="line.136"> }</a> |
| <span class="sourceLineNo">137</span><a name="line.137"> case "labels": {</a> |
| <span class="sourceLineNo">138</span><a name="line.138"> return kubernetesInfo.labels.toString();</a> |
| <span class="sourceLineNo">139</span><a name="line.139"> }</a> |
| <span class="sourceLineNo">140</span><a name="line.140"> case "labels.app": {</a> |
| <span class="sourceLineNo">141</span><a name="line.141"> return kubernetesInfo.app;</a> |
| <span class="sourceLineNo">142</span><a name="line.142"> }</a> |
| <span class="sourceLineNo">143</span><a name="line.143"> case "labels.podTemplateHash": {</a> |
| <span class="sourceLineNo">144</span><a name="line.144"> return kubernetesInfo.podTemplateHash;</a> |
| <span class="sourceLineNo">145</span><a name="line.145"> }</a> |
| <span class="sourceLineNo">146</span><a name="line.146"> case "masterUrl": {</a> |
| <span class="sourceLineNo">147</span><a name="line.147"> return kubernetesInfo.masterUrl.toString();</a> |
| <span class="sourceLineNo">148</span><a name="line.148"> }</a> |
| <span class="sourceLineNo">149</span><a name="line.149"> case "namespaceId": {</a> |
| <span class="sourceLineNo">150</span><a name="line.150"> return kubernetesInfo.namespaceId;</a> |
| <span class="sourceLineNo">151</span><a name="line.151"> }</a> |
| <span class="sourceLineNo">152</span><a name="line.152"> case "namespaceName": {</a> |
| <span class="sourceLineNo">153</span><a name="line.153"> return kubernetesInfo.namespace;</a> |
| <span class="sourceLineNo">154</span><a name="line.154"> }</a> |
| <span class="sourceLineNo">155</span><a name="line.155"> case "podId": {</a> |
| <span class="sourceLineNo">156</span><a name="line.156"> return kubernetesInfo.podId;</a> |
| <span class="sourceLineNo">157</span><a name="line.157"> }</a> |
| <span class="sourceLineNo">158</span><a name="line.158"> case "podIp": {</a> |
| <span class="sourceLineNo">159</span><a name="line.159"> return kubernetesInfo.podIp;</a> |
| <span class="sourceLineNo">160</span><a name="line.160"> }</a> |
| <span class="sourceLineNo">161</span><a name="line.161"> case "podName": {</a> |
| <span class="sourceLineNo">162</span><a name="line.162"> return kubernetesInfo.podName;</a> |
| <span class="sourceLineNo">163</span><a name="line.163"> }</a> |
| <span class="sourceLineNo">164</span><a name="line.164"> case "imageId": {</a> |
| <span class="sourceLineNo">165</span><a name="line.165"> return kubernetesInfo.imageId;</a> |
| <span class="sourceLineNo">166</span><a name="line.166"> }</a> |
| <span class="sourceLineNo">167</span><a name="line.167"> case "imageName": {</a> |
| <span class="sourceLineNo">168</span><a name="line.168"> return kubernetesInfo.imageName;</a> |
| <span class="sourceLineNo">169</span><a name="line.169"> }</a> |
| <span class="sourceLineNo">170</span><a name="line.170"> default:</a> |
| <span class="sourceLineNo">171</span><a name="line.171"> return null;</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"> private String getHostname() {</a> |
| <span class="sourceLineNo">176</span><a name="line.176"> return System.getenv(HOSTNAME);</a> |
| <span class="sourceLineNo">177</span><a name="line.177"> }</a> |
| <span class="sourceLineNo">178</span><a name="line.178"></a> |
| <span class="sourceLineNo">179</span><a name="line.179"> private Pod getCurrentPod(String hostName, KubernetesClient kubernetesClient) {</a> |
| <span class="sourceLineNo">180</span><a name="line.180"> try {</a> |
| <span class="sourceLineNo">181</span><a name="line.181"> if (isServiceAccount() && Strings.isNotBlank(hostName)) {</a> |
| <span class="sourceLineNo">182</span><a name="line.182"> return kubernetesClient.pods().withName(hostName).get();</a> |
| <span class="sourceLineNo">183</span><a name="line.183"> }</a> |
| <span class="sourceLineNo">184</span><a name="line.184"> } catch (Throwable t) {</a> |
| <span class="sourceLineNo">185</span><a name="line.185"> LOGGER.debug("Unable to locate pod with name {}.", hostName);</a> |
| <span class="sourceLineNo">186</span><a name="line.186"> }</a> |
| <span class="sourceLineNo">187</span><a name="line.187"> return null;</a> |
| <span class="sourceLineNo">188</span><a name="line.188"> }</a> |
| <span class="sourceLineNo">189</span><a name="line.189"></a> |
| <span class="sourceLineNo">190</span><a name="line.190"> private boolean isServiceAccount() {</a> |
| <span class="sourceLineNo">191</span><a name="line.191"> return Paths.get(Config.KUBERNETES_SERVICE_ACCOUNT_TOKEN_PATH).toFile().exists()</a> |
| <span class="sourceLineNo">192</span><a name="line.192"> && Paths.get(Config.KUBERNETES_SERVICE_ACCOUNT_CA_CRT_PATH).toFile().exists();</a> |
| <span class="sourceLineNo">193</span><a name="line.193"> }</a> |
| <span class="sourceLineNo">194</span><a name="line.194"></a> |
| <span class="sourceLineNo">195</span><a name="line.195"> private boolean isSpringActive() {</a> |
| <span class="sourceLineNo">196</span><a name="line.196"> return isSpringIncluded && LogManager.getFactory() != null</a> |
| <span class="sourceLineNo">197</span><a name="line.197"> && LogManager.getFactory().hasContext(KubernetesLookup.class.getName(), null, false)</a> |
| <span class="sourceLineNo">198</span><a name="line.198"> && LogManager.getContext(false).getObject(SPRING_ENVIRONMENT_KEY) != null;</a> |
| <span class="sourceLineNo">199</span><a name="line.199"> }</a> |
| <span class="sourceLineNo">200</span><a name="line.200"></a> |
| <span class="sourceLineNo">201</span><a name="line.201"> private static class KubernetesInfo {</a> |
| <span class="sourceLineNo">202</span><a name="line.202"> boolean isSpringActive;</a> |
| <span class="sourceLineNo">203</span><a name="line.203"> String accountName;</a> |
| <span class="sourceLineNo">204</span><a name="line.204"> String app;</a> |
| <span class="sourceLineNo">205</span><a name="line.205"> String clusterName;</a> |
| <span class="sourceLineNo">206</span><a name="line.206"> String containerId;</a> |
| <span class="sourceLineNo">207</span><a name="line.207"> String containerName;</a> |
| <span class="sourceLineNo">208</span><a name="line.208"> String hostName;</a> |
| <span class="sourceLineNo">209</span><a name="line.209"> String hostIp;</a> |
| <span class="sourceLineNo">210</span><a name="line.210"> String imageId;</a> |
| <span class="sourceLineNo">211</span><a name="line.211"> String imageName;</a> |
| <span class="sourceLineNo">212</span><a name="line.212"> Map<String, String> labels;</a> |
| <span class="sourceLineNo">213</span><a name="line.213"> URL masterUrl;</a> |
| <span class="sourceLineNo">214</span><a name="line.214"> String namespace;</a> |
| <span class="sourceLineNo">215</span><a name="line.215"> String namespaceId;</a> |
| <span class="sourceLineNo">216</span><a name="line.216"> String podId;</a> |
| <span class="sourceLineNo">217</span><a name="line.217"> String podIp;</a> |
| <span class="sourceLineNo">218</span><a name="line.218"> String podName;</a> |
| <span class="sourceLineNo">219</span><a name="line.219"> String podTemplateHash;</a> |
| <span class="sourceLineNo">220</span><a name="line.220"> }</a> |
| <span class="sourceLineNo">221</span><a name="line.221">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
