disable logs from urllib3 that print on the stdout

Author: Prasanna Santhanam

kubeshell/__init__.py

@@ -1,5 +1,2 @@
 __version__ = '0.0.20'
-from . import logger
-import logging
-import logging.config
-logging.config.dictConfig(logger.loggingConf)
+from . import logger

kubeshell/client.py

@@ -1,7 +1,13 @@
+from urllib3.exceptions import NewConnectionError, ConnectTimeoutError, MaxRetryError
 from kubernetes import client, config
 from kubernetes.client.api_client import ApiException
 
 import logging
+import urllib3
+
+# disable warnings on stdout/stderr from urllib3 connection errors
+ulogger = logging.getLogger("urllib3")
+ulogger.setLevel("ERROR")
 
 
 class KubernetesClient(object):
@@ -23,19 +29,21 @@ def __init__(self):
 
 
     def get_resource(self, resource, namespace="all"):
-        resources = []
+        ret, resources = None, list()
         try:
             ret, namespaced_resource = self._call_api_client(resource)
         except ApiException as ae:
-            self.logger.warning("resource autocomplete disabled, encountered ApiException %d: %s" % (ae.status, ae.reason))
+            self.logger.warning("resource autocomplete disabled, encountered "
+                                "ApiException %d: %s", ae.status, ae.reason)
+        except (NewConnectionError, MaxRetryError, ConnectTimeoutError):
+            self.logger.warning("unable to connect to k8 cluster")
         if ret:
             for i in ret.items:
                 if namespace == "all" or not namespaced_resource:
                     resources.append((i.metadata.name, i.metadata.namespace))
                 elif namespace == i.metadata.namespace:
                     resources.append((i.metadata.name, i.metadata.namespace))
-            return resources
-        return None
+        return resources
 
     def _call_api_client(self, resource):
         namespaced_resource = True

kubeshell/completer.py

@@ -2,13 +2,15 @@
 from subprocess import check_output
 from prompt_toolkit.completion import Completer, Completion
 from fuzzyfinder import fuzzyfinder
+import logging
 import shlex
 import json
 import os
 import os.path
 
 from kubeshell.client import KubernetesClient
 
+
 class KubectlCompleter(Completer):
 
     def __init__(self):
@@ -19,6 +21,7 @@ def __init__(self):
         self.inline_help = True
         self.namespace = ""
         self.kube_client = KubernetesClient()
+        self.logger = logging.getLogger(__name__)
 
         try:
             DATA_DIR = os.path.dirname(os.path.realpath(__file__))
@@ -27,7 +30,7 @@ def __init__(self):
                 self.kubectl_dict = json.load(json_file)
             self.populate_cmds_args_opts(self.kubectl_dict)
         except Exception as ex:
-            print("got an exception" + ex.message)
+            self.logger.error("got an exception" + ex.message)
 
     def set_inline_help(self, val):
         self.inline_help = val

kubeshell/kubeshell.py

@@ -16,10 +16,10 @@
 import sys
 import subprocess
 import yaml
-
+import logging
+logger = logging.getLogger(__name__)
 
 inline_help = True
-
 registry = load_key_bindings_for_prompt()
 completer = KubectlCompleter()
 
@@ -102,17 +102,15 @@ def _(event):
             KubeConfig.switch_to_next_cluster()
             Kubeshell.clustername, Kubeshell.user, Kubeshell.namespace = KubeConfig.parse_kubeconfig()
         except Exception as e:
-            # TODO: log errors to log file
-            pass
+            logger.warning("failed switching clusters", exc_info=1)
 
     @registry.add_binding(Keys.F5)
     def _(event):
         try:
             KubeConfig.switch_to_next_namespace(Kubeshell.namespace)
             Kubeshell.clustername, Kubeshell.user, Kubeshell.namespace = KubeConfig.parse_kubeconfig()
         except Exception as e:
-            # TODO: log errors to log file
-            pass
+            logger.warning("failed namespace switching", exc_info=1)
 
     @registry.add_binding(Keys.F9)
     def _(event):
@@ -141,6 +139,7 @@ def run_cli(self):
         def get_title():
             return "kube-shell"
 
+        logger.info("running kube-shell event loop")
         if not os.path.exists(os.path.expanduser("~/.kube/config")):
             click.secho('Kube-shell uses ~/.kube/config for server side completion. Could not find ~/.kube/config. '
                     'Server side completion functionality may not work.', fg='red', blink=True, bold=True)
@@ -149,8 +148,7 @@ def get_title():
             try:
                 Kubeshell.clustername, Kubeshell.user, Kubeshell.namespace = KubeConfig.parse_kubeconfig()
             except:
-                # TODO: log errors to log file
-                pass
+                logger.error("unable to parse ~/.kube/config %s", exc_info=1)
             completer.set_namespace(self.namespace)
 
             try:

kubeshell/logger.py

@@ -1,37 +1,53 @@
 import os
+import sys
+import logging
+import traceback
+import logging.config
 
-if not os.path.exists(os.path.expanduser("~/.kube-shell")):
+if not os.path.exists(os.path.expanduser("~/.kube/shell")):
     try:
-        os.makedirs(os.path.expanduser("~/.kube-shell"))
+        os.makedirs(os.path.expanduser("~/.kube/shell"))
     except OSError:
-        pass
+        print("failed to make config dirs for kube-shell")
+        traceback.print_exc(file=sys.stdout)
 
-logfile = os.path.expanduser("~/.kube-shell/debug.log")
+logfile = os.path.expanduser("~/.kube/shell/error.log")
 loggingConf = {
     "version": 1,
-    "disable_existing_loggers": False,
     "formatters": {
         "default": {
-            "format": "%(asctime)s %[levelname]-8s %(funcName)s:%(lineno)s - %(message)s",
+            "format": "%(asctime)-15s [%(levelname)-4s] %(name)s %(funcName)s:%(lineno)s - %(message)s",
         }
     },
     "handlers": {
+        "null": {
+            "class": "logging.NullHandler",
+            "level": "ERROR"
+        },
         "file": {
-            "class": "logging.FileHandler",
-            "level": "ERROR",
+            "class": "logging.handlers.RotatingFileHandler",
+            "level": "INFO",
             "formatter": "default",
             "filename": logfile,
+            "backupCount": 3,
+            "maxBytes": 10485760  # 10MB
         }
     },
     "loggers": {
-        "kubeshell": {
+        "": {
             "level": "ERROR",
             "handlers": ["file"],
-            "propagate": "no",
         },
-        "": {
+        "urllib3": {
             "level": "ERROR",
-            "handlers": ["file"]
+            "handlers": ["file"],
+            "propagate": False
+        },
+        "kubeshell": {
+            "level": "INFO",
+            "handlers": ["file"],
+            "propagate": False
         }
     },
 }
+logging.config.dictConfig(loggingConf)