Add vfc-catalog log integration config

Change-Id: I7c4e287b6dc537c49c0cc3a20e15004a988c1dbb
Issue-ID: VFC-839
Signed-off-by: ying.yunlong <ying.yunlong@zte.com.cn>

5 files changed, 162 insertions, 35 deletions

diff --git a/catalog/log.yml b/catalog/log.yml
new file mode 100644
index 00000000..2daea32c
--- /dev/null
+++ b/catalog/log.yml
@@ -0,0 +1,50 @@
+version: 1
+disable_existing_loggers: False
+
+loggers:
+    catalog:
+        handlers: [cataloglocal_handler, catalog_handler]
+        level: "DEBUG"
+        propagate: False
+    django:
+        handlers: [django_handler]
+        level: "DEBUG"
+        propagate: False
+handlers:
+    cataloglocal_handler:
+        level: "DEBUG"
+        class:
+            "logging.handlers.RotatingFileHandler"
+        filename: "logs/runtime_catalog.log"
+        formatter:
+            "standard"
+        maxBytes: 52428800
+        backupCount: 10
+    catalog_handler:
+        level: "DEBUG"
+        class:
+            "logging.handlers.RotatingFileHandler"
+        filename: "/var/log/onap/vfc/catalog/runtime_catalog.log"
+        formatter:
+            "mdcFormat"
+        maxBytes: 52428800
+        backupCount: 10
+    django_handler:
+        level: "DEBUG"
+        class:
+            "logging.handlers.RotatingFileHandler"
+        filename: "logs/django.log"
+        formatter:
+            "standard"
+        maxBytes: 52428800
+        backupCount: 10
+formatters:
+    standard:
+        format:
+            "%(asctime)s:[%(name)s]:[%(filename)s]-[%(lineno)d] [%(levelname)s]:%(message)s"
+    mdcFormat:
+        format:
+            "%(asctime)s|||||%(name)s||%(thread)s||%(funcName)s||%(levelname)s||%(message)s||||%(mdc)s \t"
+        mdcfmt: "{requestID} {invocationID} {serviceName} {serviceIP}"
+        datefmt: "%Y-%m-%d %H:%M:%S"
+        (): onaplogging.mdcformatter.MDCFormatter
diff --git a/catalog/middleware.py b/catalog/middleware.py
new file mode 100644
index 00000000..0617fead
--- /dev/null
+++ b/catalog/middleware.py
@@ -0,0 +1,60 @@
+# Copyright (c) 2017-2018 ZTE, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+
+import uuid
+from onaplogging.mdcContext import MDC
+
+from catalog.pub.config.config import FORWARDED_FOR_FIELDS, SERVICE_NAME
+
+
+class LogContextMiddleware(object):
+    #  the last IP behind multiple proxies,  if no exist proxies
+    #  get local host ip.
+    def _getLastIp(self, request):
+
+        ip = ""
+        try:
+            for field in FORWARDED_FOR_FIELDS:
+                if field in request.META:
+                    if ',' in request.META[field]:
+                        parts = request.META[field].split(',')
+                        ip = parts[-1].strip().split(":")[0]
+                    else:
+                        ip = request.META[field].split(":")[0]
+
+            if ip == "":
+                ip = request.META.get("HTTP_HOST").split(":")[0]
+
+        except Exception:
+            pass
+
+        return ip
+
+    def process_request(self, request):
+        # Fetch TRANSACTIONID Id and pass to plugin server
+        ReqeustID = request.META.get("HTTP_X_TRANSACTIONID", None)
+        if ReqeustID is None:
+            ReqeustID = uuid.uuid3(uuid.NAMESPACE_URL, SERVICE_NAME)
+            request.META["HTTP_X_TRANSACTIONID"] = ReqeustID
+        MDC.put("requestID", ReqeustID)
+        # generate the unique  id
+        InovocationID = uuid.uuid3(uuid.NAMESPACE_DNS, SERVICE_NAME)
+        MDC.put("invocationID", InovocationID)
+        MDC.put("serviceName", SERVICE_NAME)
+        # access ip
+        MDC.put("serviceIP", self._getLastIp(request))
+
+        return None
+
+    def process_response(self, request, response):
+        MDC.clear()
+        return response
diff --git a/catalog/pub/config/config.py b/catalog/pub/config/config.py
index da0dfade..0086e99a 100644
--- a/catalog/pub/config/config.py
+++ b/catalog/pub/config/config.py
@@ -28,6 +28,11 @@ DB_NAME = "nfvocatalog"
 DB_USER = "nfvocatalog"
 DB_PASSWD = "nfvocatalog"
 
+# [MDC]
+SERVICE_NAME = "catalog"
+FORWARDED_FOR_FIELDS = ["HTTP_X_FORWARDED_FOR", "HTTP_X_FORWARDED_HOST",
+                        "HTTP_X_FORWARDED_SERVER"]
+
 # [register]
 REG_TO_MSB_WHEN_START = True
 REG_TO_MSB_REG_URL = "/api/microservices/v1/services"
diff --git a/catalog/settings.py b/catalog/settings.py
index 913f308c..ff19ff25 100644
--- a/catalog/settings.py
+++ b/catalog/settings.py
@@ -19,7 +19,10 @@ import redisco
 
 from catalog.pub.config.config import REDIS_HOST, REDIS_PORT, REDIS_PASSWD
 from catalog.pub.config.config import DB_NAME, DB_IP, DB_USER, DB_PASSWD, DB_PORT
-from catalog.pub.config import config
+from catalog.pub.config import config as pub_config
+from logging import config as log_config
+from onaplogging import monkey
+monkey.patch_all()
 
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
@@ -84,6 +87,7 @@ MIDDLEWARE_CLASSES = [
     'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    'catalog.middleware.LogContextMiddleware',
 ]
 
 ROOT_URLCONF = 'catalog.urls'
@@ -128,41 +132,46 @@ STATICFILES_DIRS = [
     os.path.join(BASE_DIR, "static")
 ]
 
-config.CATALOG_ROOT_PATH = os.path.join(STATICFILES_DIRS[0], "catalog")
-config.CATALOG_URL_PATH = "static/catalog"
-
-LOGGING = {
-    'version': 1,
-    'disable_existing_loggers': True,
-    'formatters': {
-        'standard': {
-            'format': '%(asctime)s:[%(name)s]:[%(filename)s]-[%(lineno)d] [%(levelname)s]:%(message)s',
-        },
-    },
-    'filters': {
-    },
-    'handlers': {
-        'catalog_handler': {
-            'level': 'DEBUG',
-            'class': 'logging.handlers.RotatingFileHandler',
-            'filename': os.path.join(BASE_DIR, 'logs/runtime_catalog.log'),
-            'formatter': 'standard',
-            'maxBytes': 1024 * 1024 * 50,
-            'backupCount': 5,
-        },
-    },
-
-    'loggers': {
-        'catalog': {
-            'handlers': ['catalog_handler'],
-            'level': 'DEBUG',
-            'propagate': False
-        },
-    }
-}
+pub_config.CATALOG_ROOT_PATH = os.path.join(STATICFILES_DIRS[0], "catalog")
+pub_config.CATALOG_URL_PATH = "static/catalog"
+#
+# LOGGING = {
+#     'version': 1,
+#     'disable_existing_loggers': True,
+#     'formatters': {
+#         'standard': {
+#             'format': '%(asctime)s:[%(name)s]:[%(filename)s]-[%(lineno)d] [%(levelname)s]:%(message)s',
+#         },
+#     },
+#     'filters': {
+#     },
+#     'handlers': {
+#         'catalog_handler': {
+#             'level': 'DEBUG',
+#             'class': 'logging.handlers.RotatingFileHandler',
+#             'filename': os.path.join(BASE_DIR, 'logs/runtime_catalog.log'),
+#             'formatter': 'standard',
+#             'maxBytes': 1024 * 1024 * 50,
+#             'backupCount': 5,
+#         },
+#     },
+#
+#     'loggers': {
+#         'catalog': {
+#             'handlers': ['catalog_handler'],
+#             'level': 'DEBUG',
+#             'propagate': False
+#         },
+#     }
+# }
+
+LOGGING_CONFIG = None
+# yaml configuration of logging
+LOGGING_FILE = os.path.join(BASE_DIR, 'catalog/log.yml')
+log_config.yamlConfig(filepath=LOGGING_FILE, watchDog=True)
 
 if 'test' in sys.argv:
-    config.REG_TO_MSB_WHEN_START = False
+    pub_config.REG_TO_MSB_WHEN_START = False
     DATABASES = {}
     DATABASES['default'] = {
         'ENGINE': 'django.db.backends.sqlite3',
diff --git a/requirements.txt b/requirements.txt
index 97575326..319d3263 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -28,4 +28,7 @@ nfv-toscaparser==0.5.1.dev25
 # for auto swagger
 drf-yasg>=1.2.2
 flex>=6.11.1
-swagger-spec-validator>=2.1.0
\ No newline at end of file
+swagger-spec-validator>=2.1.0
+
+# for onap logging
+onappylog>=1.0.6
\ No newline at end of file