Merge pull request #1 from ustudio/initial-implementation

Make standard kubernetes logging configuration a library

Author: spiralman

circle.yml

@@ -0,0 +1,15 @@
+machine:
+  post:
+    - pyenv global 2.7.11 3.5.2
+dependencies:
+  override:
+    - pip install tox
+test:
+  override:
+    - tox
+deployment:
+  release:
+    tag: /v[0-9]+(\.[0-9]+)*/
+    owner: ustudio
+    commands:
+      - ./publish_to_pypi.sh

publish_to_pypi.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+set -e
+
+is_package_installed() {
+    python -c "import $1";
+}
+
+die() {
+    echo "$1. Deployment failed.";
+
+    exit 2;
+}
+
+
+[ -n "$PYPI_USERNAME" ] || die '$PYPI_USERNAME is required';
+
+[ -n "$PYPI_PASSWORD" ] || die '$PYPI_PASSWORD is required';
+
+if ! is_package_installed twine; then
+    echo 'Installing twine';
+    pip install twine || die 'Twine failed to install';
+fi
+
+python setup.py sdist || die 'setup.py sdist failed'
+
+twine upload --username $PYPI_USERNAME --password $PYPI_PASSWORD dist/* ||  die 'Twine upload failed';

setup.py

@@ -0,0 +1,18 @@
+try:
+    from setuptools import setup
+except ImportError:
+    from distutils.core import setup
+
+
+install_requires = [
+    "datadog-logger",
+    "kubernetes-downward-api",
+    "datadog"
+]
+
+setup(name="ustack-logging",
+      version="0.1.0",
+      description="Default logging configuration for uStack style Python applications.",
+      url="https://github.com/ustudio/ustack-logging",
+      packages=["ustack_logging"],
+      install_requires=install_requires)

tests/__init__.py

@@ -0,0 +1,65 @@
+import logging
+import unittest
+
+try:
+    from unittest import mock
+except ImportError:
+    import mock
+
+from ustack_logging.logging_configuration import configure_logging
+
+
+class TestLogging(unittest.TestCase):
+    @mock.patch("ustack_logging.logging_configuration.log_error_events", autospec=True)
+    @mock.patch("kubernetes_downward_api.parse", autospec=True)
+    @mock.patch("datadog.initialize", autospec=True)
+    @mock.patch("logging.basicConfig", autospec=True)
+    def test_configures_logging_format_and_logs_errors_to_datadog(
+            self, mock_log_config, mock_dd_init, mock_k8s_parse, mock_log_errors):
+        mock_k8s_parse.return_value = {
+            "namespace": "dev",
+            "labels": {
+                "app": "my_app",
+                "role": "app"
+            }
+        }
+
+        configure_logging({
+            "DATADOG_API_KEY": "dd-api-key",
+            "DATADOG_APP_KEY": "dd-app-key"
+        })
+
+        mock_log_config.assert_called_once_with(
+            format="%(asctime)s %(levelname)s:%(module)s:%(message)s",
+            datefmt="%Y-%m-%d %H:%M:%S%z", level=logging.INFO)
+
+        mock_dd_init.assert_called_once_with(api_key="dd-api-key", app_key="dd-app-key")
+
+        mock_k8s_parse.assert_called_once_with(["/etc/podinfo"])
+        mock_log_errors.assert_called_once_with(
+            tags=["environment:dev", "service:my_app", "role:app"])
+
+    @mock.patch("ustack_logging.logging_configuration.log_error_events", autospec=True)
+    @mock.patch("kubernetes_downward_api.parse", autospec=True)
+    @mock.patch("datadog.initialize", autospec=True)
+    @mock.patch("logging.basicConfig", autospec=True)
+    def test_ignores_errors_from_datadog_initialization(
+            self, mock_log_config, mock_dd_init, mock_k8s_parse, mock_log_errors):
+        mock_k8s_parse.return_value = {
+            "namespace": "dev",
+            "labels": {
+                "app": "my_app",
+                "role": "app"
+            }
+        }
+
+        mock_dd_init.side_effect = RuntimeError
+
+        configure_logging({
+            "DATADOG_API_KEY": "dd-api-key",
+            "DATADOG_APP_KEY": "dd-app-key"
+        })
+
+        mock_log_config.assert_called_once_with(
+            format="%(asctime)s %(levelname)s:%(module)s:%(message)s",
+            datefmt="%Y-%m-%d %H:%M:%S%z", level=logging.INFO)

tests/test_ustack_logging.py

@@ -0,0 +1,17 @@
+# Tox (http://tox.testrun.org/) is a tool for running tests
+# in multiple virtualenvs. This configuration file will run the
+# test suite on all supported python versions. To use it, "pip install tox"
+# and then run "tox" from this directory.
+
+[tox]
+envlist = py27, py35
+
+[testenv]
+commands = nosetests
+deps =
+    nose
+
+[testenv:py27]
+deps =
+    nose
+    mock

tox.ini

@@ -0,0 +1,23 @@
+import datadog
+from datadog_logger import log_error_events
+import kubernetes_downward_api
+import logging
+
+
+def configure_logging(environ):
+    logging.basicConfig(
+        format="%(asctime)s %(levelname)s:%(module)s:%(message)s",
+        datefmt="%Y-%m-%d %H:%M:%S%z", level=logging.INFO)
+
+    try:
+        datadog.initialize(api_key=environ["DATADOG_API_KEY"], app_key=environ["DATADOG_APP_KEY"])
+
+        podinfo = kubernetes_downward_api.parse(["/etc/podinfo"])
+
+        log_error_events(tags=[
+            "environment:{0}".format(podinfo["namespace"]),
+            "service:{0}".format(podinfo["labels"]["app"]),
+            "role:{0}".format(podinfo["labels"]["role"])
+        ])
+    except:
+        logging.warning("Could not initialize DataDog error logging, with error:", exc_info=True)