Merge "Add vfc-gvnfmdriver log integration config"

5 files changed, 149 insertions, 21 deletions

diff --git a/gvnfmadapter/driver/log.yml b/gvnfmadapter/driver/log.yml
new file mode 100644
index 0000000..bc18c14
--- /dev/null
+++ b/gvnfmadapter/driver/log.yml
@@ -0,0 +1,50 @@
+version: 1
+disable_existing_loggers: False
+
+loggers:
+    mgr:
+        handlers: [gvnfmdriverlocal_handler, gvnfmdriver_handler]
+        level: "DEBUG"
+        propagate: False
+    django:
+        handlers: [django_handler]
+        level: "DEBUG"
+        propagate: False
+handlers:
+    gvnfmdriverlocal_handler:
+        level: "DEBUG"
+        class:
+            "logging.handlers.RotatingFileHandler"
+        filename: "logs/runtime_gvnfmdriver.log"
+        formatter:
+            "standard"
+        maxBytes: 52428800
+        backupCount: 10
+    gvnfmdriver_handler:
+        level: "DEBUG"
+        class:
+            "logging.handlers.RotatingFileHandler"
+        filename: "/var/log/onap/vfc-gvnfmdriver/runtime_gvnfmdriver.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/gvnfmadapter/driver/middleware.py b/gvnfmadapter/driver/middleware.py
new file mode 100644
index 0000000..707589a
--- /dev/null
+++ b/gvnfmadapter/driver/middleware.py
@@ -0,0 +1,60 @@
+# Copyright (c) 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 driver.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/gvnfmadapter/driver/pub/config/config.py b/gvnfmadapter/driver/pub/config/config.py
index 198ae76..4d6ee9e 100644
--- a/gvnfmadapter/driver/pub/config/config.py
+++ b/gvnfmadapter/driver/pub/config/config.py
@@ -16,6 +16,11 @@
 MSB_SERVICE_IP = '127.0.0.1'
 MSB_SERVICE_PORT = '80'
 
+# [MDC]
+SERVICE_NAME = "gvnfmdriver"
+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/gvnfmadapter/driver/settings.py b/gvnfmadapter/driver/settings.py
index 96a3190..0a43d3c 100644
--- a/gvnfmadapter/driver/settings.py
+++ b/gvnfmadapter/driver/settings.py
@@ -14,6 +14,9 @@
 
 import os
 import sys
+from logging import 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__)))
@@ -53,6 +56,7 @@ MIDDLEWARE_CLASSES = [
     'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    'driver.middleware.LogContextMiddleware',
 ]
 
 ROOT_URLCONF = 'driver.urls'
@@ -103,28 +107,34 @@ TIME_ZONE = 'UTC'
 # https://docs.djangoproject.com/en/1.6/howto/static-files/
 
 STATIC_URL = '/static/'
+#
+# LOGGING = {
+#     'version': 1,
+#     'disable_existing_loggers': True,
+#     'formatters': {
+#         'standard': {
+#             'format': '%(asctime)s:[%(name)s]:[%(filename)s]-[%(lineno)d] [%(levelname)s]:%(message)s', }, },
+#     'filters': {},
+#     'handlers': {
+#         'driver_handler': {
+#             'level': 'DEBUG',
+#             'class': 'logging.handlers.RotatingFileHandler',
+#             'filename': os.path.join(BASE_DIR, 'logs/runtime_driver.log'),
+#             'formatter': 'standard',
+#             'maxBytes': 1024 * 1024 * 50,
+#             'backupCount': 5, }, },
+#
+#     'loggers': {
+#         'driver': {
+#             'handlers': ['driver_handler'],
+#             'level': 'DEBUG',
+#             'propagate': False}, }}
+
+LOGGING_CONFIG = None
+# yaml configuration of logging
+LOGGING_FILE = os.path.join(BASE_DIR, 'driver/log.yml')
+config.yamlConfig(filepath=LOGGING_FILE, watchDog=True)
 
-LOGGING = {
-    'version': 1,
-    'disable_existing_loggers': True,
-    'formatters': {
-        'standard': {
-            'format': '%(asctime)s:[%(name)s]:[%(filename)s]-[%(lineno)d] [%(levelname)s]:%(message)s', }, },
-    'filters': {},
-    'handlers': {
-        'driver_handler': {
-            'level': 'DEBUG',
-            'class': 'logging.handlers.RotatingFileHandler',
-            'filename': os.path.join(BASE_DIR, 'logs/runtime_driver.log'),
-            'formatter': 'standard',
-            'maxBytes': 1024 * 1024 * 50,
-            'backupCount': 5, }, },
-
-    'loggers': {
-        'driver': {
-            'handlers': ['driver_handler'],
-            'level': 'DEBUG',
-            'propagate': False}, }}
 
 if 'test' in sys.argv:
     from driver.pub.config import config
diff --git a/gvnfmadapter/requirements.txt b/gvnfmadapter/requirements.txt
index 6458169..8789a86 100644
--- a/gvnfmadapter/requirements.txt
+++ b/gvnfmadapter/requirements.txt
@@ -16,3 +16,6 @@ drf-yasg>=1.2.2
 # for the validation feature
 flex>=6.11.1
 swagger-spec-validator>=2.1.0
+
+# for onap logging
+onappylog>=1.0.6
\ No newline at end of file