Merge lp:~thomir-deactivatedaccount/core-image-publisher/trunk-configure-logging into lp:core-image-publisher

[Thomi Richards]

Configure logging for this service, including logstash handling.

Configure logging for this service, including logstash handling.

[lp:~thomir-deactivatedaccount/core-image-publisher/trunk-configure-logging]

7. By Thomi Richards on 2015-03-25

Document logstash logging options in README.

[Celso Providelo (cprov)]

Very good, thanks for working on this.

This pattern works fine with LS+ELK and since it will be available soon in production we can figure out ways to make the logs look sane across services.

review: Approve

=== modified file 'README.rst'
--- README.rst	2015-03-25 23:55:03 +0000
+++ README.rst	2015-03-25 23:55:03 +0000
@@ -54,6 +54,12 @@
 
 The sample configuration file in 'core-service.conf'::
 
-   [amqp]
-   uris = amqp://guest:guest@localhost:5672//
-
+  [amqp]
+  uris = amqp://guest:guest@localhost:5672//
+
+...optionally, add a logstash section, which will turn on the logstash handler::
+
+  [logstash]
+  host = 127.0.0.1
+  port = 1234
+  version = 1
\ No newline at end of file

=== modified file 'core_image_publisher/__init__.py'
--- core_image_publisher/__init__.py	2015-03-25 23:55:03 +0000
+++ core_image_publisher/__init__.py	2015-03-25 23:55:03 +0000
@@ -15,10 +15,12 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-import logging
-
 import argparse
 import configparser
+import logging
+import os
+
+import logstash
 
 from core_image_publisher.queue import (
     create_connection_from_config,
@@ -44,6 +46,37 @@
     return config
 
 
+def configure_logging(config):
+    root_logger = logging.getLogger()
+    root_logger.setLevel(logging.INFO)
+
+    # If there is no ./logs directory, fallback to stderr.
+    log_path = os.path.abspath(
+        os.path.join(__file__, '../../logs/core-image-publisher.log'))
+    log_dir = os.path.dirname(log_path)
+    if os.path.exists(log_dir):
+        handler = logging.FileHandler(log_path)
+    else:
+        print("'logs' directory '{}' does not exist, using stderr "
+              "for app log.".format(log_dir))
+        handler = logging.StreamHandler()
+
+    handler.setFormatter(
+        logging.Formatter(
+            '%(asctime)s  %(name)s %(levelname)s: %(message)s'
+        )
+    )
+    root_logger.addHandler(handler)
+    if 'logstash' in config:
+        root_logger.addHandler(
+            logstash.LogstashHandler(
+                config['logstash']['host'],
+                int(config['logstash']['port']),
+                int(config['logstash']['version'])
+            )
+        )
+
+
 def logging_worker(message):
     logger.info("Got %r", message.payload, extra=message.payload)
     message.ack()
@@ -51,6 +84,7 @@
 
 def main():
     config = read_config()
+    configure_logging(config)
     connection = create_connection_from_config(config)
     try:
         with connection:

=== modified file 'core_image_publisher/queue.py'
--- core_image_publisher/queue.py	2015-03-25 23:55:03 +0000
+++ core_image_publisher/queue.py	2015-03-25 23:55:03 +0000
@@ -67,7 +67,7 @@
         Run requested tests and posts results to the 'adt_results' queue
         for later checking.
         """
-        logger.info('Got: {}'.format(body), extra=body)
+        logger.info('Got: %r', body, extra=body)
         try:
             self.on_message_cb(message)
         except Exception as e:

=== modified file 'requirements.txt'
--- requirements.txt	2015-03-25 21:36:10 +0000
+++ requirements.txt	2015-03-25 23:55:03 +0000
@@ -1,1 +1,2 @@
-kombu==3.0.24
\ No newline at end of file
+kombu==3.0.24
+python-logstash==0.4.2
\ No newline at end of file