Merge pull request #51 from lwander/use-logger

Use log4j for logging exceptions

Author: brendandburns

examples/src/main/java/io/kubernetes/client/examples/Example.java

@@ -21,6 +21,7 @@
 import io.kubernetes.client.util.Config;
 
 import java.io.IOException;
+import java.util.logging.Logger;
 
 /**
  * A simple example of how to use the Java API

util/pom.xml

@@ -39,6 +39,11 @@
 			<artifactId>guava</artifactId>
 			<version>22.0</version>
 		</dependency>
+		<dependency>
+			<groupId>log4j</groupId>
+			<artifactId>log4j</artifactId>
+			<version>1.2.17</version>
+		</dependency>
 		<!-- test dependencies -->
 		<dependency>
 			<groupId>junit</groupId>
@@ -85,5 +90,6 @@
 		<java.version>1.7</java.version>
 		<maven.compiler.source>${java.version}</maven.compiler.source>
 		<maven.compiler.target>${java.version}</maven.compiler.target>
+		<slf4jVersion>1.7.7</slf4jVersion>
 	</properties>
 </project>

util/src/main/java/io/kubernetes/client/Exec.java

@@ -1,20 +1,18 @@
 package io.kubernetes.client;
 
-import io.kubernetes.client.Configuration;
 import io.kubernetes.client.models.V1Pod;
 import io.kubernetes.client.util.WebSockets;
+import org.apache.commons.lang.StringUtils;
+import org.apache.log4j.Logger;
 
-import java.io.ByteArrayInputStream;
 import java.io.Closeable;
-import java.io.InputStream;
 import java.io.IOException;
+import java.io.InputStream;
 import java.io.OutputStream;
 import java.io.PipedInputStream;
 import java.io.PipedOutputStream;
 import java.io.Reader;
 
-import org.apache.commons.lang.StringUtils;
-
 public class Exec {
     private ApiClient apiClient;
 
@@ -144,7 +142,9 @@ private static class ExecProcess extends Process implements WebSockets.SocketLis
         private InputStream input;
         private int statusCode;
         private Closeable closer;
-        
+
+        private static final Logger log = Logger.getLogger(ExecProcess.class);
+
         public ExecProcess() throws IOException {
             this.pipeIn = new PipedInputStream();
             this.pipeOut = new PipedOutputStream();
@@ -212,8 +212,7 @@ public void bytesMessage(InputStream in) {
                 }
                 out.flush();
             } catch (IOException ex) {
-                // TODO use a logger here.
-                ex.printStackTrace();
+                log.error("Failure sending bytes message", ex);
             }
         }
 
@@ -230,8 +229,7 @@ public void textMessage(Reader in) {
                 }
                 out.flush();
             } catch (IOException ex) {
-                // TODO use a logger here
-                ex.printStackTrace();
+                log.error("Failure sending text message", ex);
             }
         }
 
@@ -242,8 +240,7 @@ public void close() {
                 pipeOut.close();
                 output.close();
             } catch (IOException ex) {
-                // TODO use a logger here
-                ex.printStackTrace();
+                log.error("Failure closing exec process", ex);
             }
             // TODO: get status code here
             synchronized(this) {

util/src/main/java/io/kubernetes/client/util/Config.java

@@ -13,19 +13,19 @@
 package io.kubernetes.client.util;
 
 import io.kubernetes.client.ApiClient;
+import org.apache.log4j.Logger;
 
+import javax.net.ssl.KeyManager;
 import java.io.BufferedReader;
 import java.io.File;
-import java.io.FileReader;
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
+import java.io.FileReader;
+import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
-import java.io.IOException;
 import java.io.Reader;
 
-import javax.net.ssl.KeyManager;
-
 public class Config {
     public static final String SERVICEACCOUNT_ROOT =
         "/var/run/secrets/kubernetes.io/serviceaccount";
@@ -39,6 +39,8 @@ public class Config {
     // The last resort host to try
     public static final String DEFAULT_FALLBACK_HOST = "http://localhost:8080";
 
+    private static final Logger log = Logger.getLogger(Config.class);
+
     public static ApiClient fromCluster() throws IOException {
         String host = System.getenv(ENV_SERVICE_HOST);
         String port = System.getenv(ENV_SERVICE_PORT);
@@ -97,6 +99,7 @@ public static ApiClient fromConfig(InputStream stream) {
     }
 
     public static ApiClient fromConfig(Reader input) {
+
         KubeConfig config = KubeConfig.loadKubeConfig(input);
         ApiClient client = new ApiClient();
         client.setBasePath(config.getServer());
@@ -111,7 +114,7 @@ public static ApiClient fromConfig(Reader input) {
                 null, null);
             client.setKeyManagers(mgrs);
         } catch (Exception ex) {
-            ex.printStackTrace();
+            log.error("Failed to invoke build key managers", ex);
         }
 
         if (config.verifySSL()) {
@@ -124,8 +127,8 @@ public static ApiClient fromConfig(Reader input) {
             if (caCert != null || caCertFile != null) {
                 try {
                     client.setSslCaCert(SSLUtils.getInputStreamFromDataOrFile(caCert, caCertFile));
-                } catch (FileNotFoundException e) {
-                    e.printStackTrace();
+                } catch (FileNotFoundException ex) {
+                    log.error("Failed to find CA Cert file", ex);
                 }
             }
         } else {

util/src/main/java/io/kubernetes/client/util/KubeConfig.java

@@ -12,24 +12,22 @@
 */
 package io.kubernetes.client.util;
 
-import com.google.common.io.CharStreams;
+import io.kubernetes.client.util.authenticators.Authenticator;
+import org.apache.log4j.Logger;
+import org.yaml.snakeyaml.Yaml;
+import org.yaml.snakeyaml.constructor.SafeConstructor;
+
 import java.io.File;
 import java.io.FileNotFoundException;
 import java.io.FileReader;
 import java.io.IOException;
 import java.io.Reader;
-import java.nio.file.Files;
 import java.nio.file.FileSystems;
+import java.nio.file.Files;
 import java.util.ArrayList;
-import java.util.Date;
 import java.util.HashMap;
 import java.util.Map;
 
-import org.yaml.snakeyaml.Yaml;
-import org.yaml.snakeyaml.constructor.SafeConstructor;
-
-import io.kubernetes.client.util.authenticators.Authenticator;
-
 /**
  * KubeConfig represents a kubernetes client configuration
  */
@@ -51,6 +49,8 @@ public class KubeConfig {
     Map<String, Object> currentCluster;
     Map<String, Object> currentUser;
 
+    private static final Logger log = Logger.getLogger(KubeConfig.class);
+
     public static void registerAuthenticator(Authenticator auth) {
         synchronized (authenticators) {
             authenticators.put(auth.getName(), auth);
@@ -190,8 +190,7 @@ public String getAccessToken() {
                 byte[] data = Files.readAllBytes(FileSystems.getDefault().getPath(tokenFile));
                 return new String(data, "UTF-8");
             } catch (IOException ex) {
-                // TODO use logger here
-                ex.printStackTrace();
+                log.error("Failed to read token file", ex);
             }
         }
         return null;

util/src/main/java/io/kubernetes/client/util/SSLUtils.java

@@ -21,6 +21,10 @@
 
 package io.kubernetes.client.util;
 
+import org.apache.commons.codec.binary.Base64;
+
+import javax.net.ssl.KeyManager;
+import javax.net.ssl.KeyManagerFactory;
 import java.io.BufferedReader;
 import java.io.ByteArrayInputStream;
 import java.io.File;
@@ -44,11 +48,6 @@
 import java.security.spec.PKCS8EncodedKeySpec;
 import java.security.spec.RSAPrivateCrtKeySpec;
 
-import javax.net.ssl.KeyManager;
-import javax.net.ssl.KeyManagerFactory;
-
-import org.apache.commons.codec.binary.Base64;
-
 public class SSLUtils {
     public static boolean isNotNullOrEmpty(String val) {
         return val != null && val.length() > 0;
@@ -258,17 +257,9 @@ private static void loadDefaultKeyStoreFile(KeyStore keyStore, char[] keyStorePa
 
     private static boolean loadDefaultStoreFile(KeyStore keyStore, File fileToLoad, char[] passphrase)
             throws CertificateException, NoSuchAlgorithmException, IOException {
-
-        String notLoadedMessage = "There is a problem with reading default keystore/truststore file %s with the passphrase %s "
-                + "- the file won't be loaded. The reason is: %s";
-
         if (fileToLoad.exists() && fileToLoad.isFile() && fileToLoad.length() > 0) {
-            //try {
             keyStore.load(new FileInputStream(fileToLoad), passphrase);
             return true;
-            //} catch (Exception e) {
-            //    e.printStackTrace();
-            //}
         }
         return false;
     }

util/src/main/java/io/kubernetes/client/util/WebSockets.java

@@ -12,35 +12,29 @@
 */
 package io.kubernetes.client.util;
 
-import io.kubernetes.client.ApiClient;
-import io.kubernetes.client.ApiException;
-import io.kubernetes.client.Pair;
-import io.kubernetes.client.util.Config;
-
 import com.google.common.net.HttpHeaders;
-
-import com.squareup.okhttp.MediaType;
 import com.squareup.okhttp.Request;
 import com.squareup.okhttp.Response;
 import com.squareup.okhttp.ResponseBody;
 import com.squareup.okhttp.ws.WebSocket;
 import com.squareup.okhttp.ws.WebSocketCall;
 import com.squareup.okhttp.ws.WebSocketListener;
+import io.kubernetes.client.ApiClient;
+import io.kubernetes.client.ApiException;
+import io.kubernetes.client.Pair;
 import okio.Buffer;
+import org.apache.log4j.Logger;
 
-import static com.squareup.okhttp.ws.WebSocket.BINARY;
-import static com.squareup.okhttp.ws.WebSocket.TEXT;
-
-import java.io.BufferedReader;
 import java.io.Closeable;
 import java.io.IOException;
 import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.io.OutputStream;
 import java.io.Reader;
 import java.util.ArrayList;
 import java.util.HashMap;
 
+import static com.squareup.okhttp.ws.WebSocket.BINARY;
+import static com.squareup.okhttp.ws.WebSocket.TEXT;
+
 public class WebSockets {
     public static final String V4_STREAM_PROTOCOL = "v4.channel.k8s.io";
     public static final String V3_STREAM_PROTOCOL = "v3.channel.k8s.io";
@@ -49,6 +43,8 @@ public class WebSockets {
     public static final String STREAM_PROTOCOL_HEADER = "X-Stream-Protocol-Version";
     public static final String SPDY_3_1 = "SPDY/3.1";
 
+    private static final Logger log = Logger.getLogger(WebSockets.class);
+
     /**
      * A simple interface for a listener on a web socket
      */
@@ -110,7 +106,7 @@ public void close() {
                     try {
                         webSocket.close(200, "User closed connection");
                     } catch (IOException ex) {
-                        ex.printStackTrace();
+                        log.error("Failure closing websocket", ex);
                     }
                 }
             });

util/src/main/java/io/kubernetes/client/util/authenticators/GCPAuthenticator.java

@@ -12,11 +12,11 @@
 */
 package io.kubernetes.client.util.authenticators;
 
+import io.kubernetes.client.util.KubeConfig;
+
 import java.util.Date;
 import java.util.Map;
 
-import io.kubernetes.client.util.KubeConfig;
-
 /**
  * The Authenticator interface represents a plugin that can handle
  * a specific type of authentication information (e.g. 'gcp')

util/src/main/resources/log4j.properties

@@ -0,0 +1,8 @@
+# Root logger option
+log4j.rootLogger=INFO, stdout
+
+# Redirect log messages to console
+log4j.appender.stdout=org.apache.log4j.ConsoleAppender
+log4j.appender.stdout.Target=System.out
+log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
+log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n