From ddbbd05be0070629d211aecbc40fd5910790bba0 Mon Sep 17 00:00:00 2001
From: Christian Berendt <berendt@betacloud-solutions.de>
Date: Mon, 12 Sep 2016 22:35:52 +0200
Subject: [PATCH] Document how to add logging for a service

TrivialFix

Change-Id: I2e912176174538fb1aded27e54c6a10acaf7d34b
---
 doc/CONTRIBUTING.rst | 34 ++++++++++++++++++++++++++++------
 1 file changed, 28 insertions(+), 6 deletions(-)

diff --git a/doc/CONTRIBUTING.rst b/doc/CONTRIBUTING.rst
index f99e730784..7791d30992 100644
--- a/doc/CONTRIBUTING.rst
+++ b/doc/CONTRIBUTING.rst
@@ -137,18 +137,40 @@ that Kolla uses throughout that should be followed.
     include service specific setup and steps as not all services can be upgraded
     in the same way.
 
-Other than the above, most roles follow the following pattern::
+* Log delivery
 
-  -  ``Register`` : Involves registering the service with Keystone, creating endpoints, roles,
+  - For OpenStack services the service has be added oo the ``file_match`` paramater
+    in the ``openstack_logstreamer_input`` section in the ``heka-openstack.toml.j2``
+    template file in ``ansible/roles/comm/templates`` to deliver log messages to
+    Elasticsearch.
+
+* Logrotation
+
+  - For OpenStack services there should be a ``cron-logrotate-PROJECT.conf.j2``
+    template file in ``ansible/roles/common/templates`` with the following
+    content:
+
+    .. code::
+
+       "/var/log/kolla/PROJECT/*.log"
+       {
+       }
+
+  - For OpenStack services there should be a entry in the ``services`` list
+    in the ``cron.json.j2`` template file in ``ansible/roles/common/templates``.
+
+Other than the above, most roles follow the following pattern:
+
+  -  ``Register``: Involves registering the service with Keystone, creating endpoints, roles,
     users, etc.
 
-  -  ``Config`` : Distributes the config files to the nodes to be pulled into the container on
+  -  ``Config``: Distributes the config files to the nodes to be pulled into the container on
     startup.
 
-  - ``Bootstrap`` : Creating the database (but not tables), database user for the service,
+  - ``Bootstrap``: Creating the database (but not tables), database user for the service,
     permissions, etc.
 
-  - ``Bootstrap Service`` : Starts a one shot container on the host to create the database tables,
+  - ``Bootstrap Service``: Starts a one shot container on the host to create the database tables,
     and other initial run time config.
 
-  - ``Start`` : Start the service(s).
+  - ``Start``: Start the service(s).