From 3b3bcf80a61245c63670c5b9eddcf5b52230423e Mon Sep 17 00:00:00 2001 From: "ying.yunlong" Date: Mon, 26 Mar 2018 08:55:51 +0800 Subject: Add vfc-vnfres log integration config Change-Id: I96c0b84fc04d86a2f60493372efff42bdfcf7132 Issue-ID: VFC-839 Signed-off-by: ying.yunlong --- res/requirements.txt | 5 +++- res/res/log.yml | 50 +++++++++++++++++++++++++++++++++ res/res/middleware.py | 60 +++++++++++++++++++++++++++++++++++++++ res/res/pub/config/config.py | 5 ++++ res/res/settings.py | 67 +++++++++++++++++++++++++------------------- 5 files changed, 157 insertions(+), 30 deletions(-) create mode 100644 res/res/log.yml create mode 100644 res/res/middleware.py (limited to 'res') diff --git a/res/requirements.txt b/res/requirements.txt index b20fefc..47f8e4b 100644 --- a/res/requirements.txt +++ b/res/requirements.txt @@ -23,4 +23,7 @@ unittest_xml_reporting==1.12.0 # 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 diff --git a/res/res/log.yml b/res/res/log.yml new file mode 100644 index 0000000..d3a4667 --- /dev/null +++ b/res/res/log.yml @@ -0,0 +1,50 @@ +version: 1 +disable_existing_loggers: False + +loggers: + res: + handlers: [vnfreslocal_handler, vnfres_handler] + level: "DEBUG" + propagate: False + django: + handlers: [django_handler] + level: "DEBUG" + propagate: False +handlers: + vnfreslocal_handler: + level: "DEBUG" + class: + "logging.handlers.RotatingFileHandler" + filename: "logs/runtime_res.log" + formatter: + "standard" + maxBytes: 52428800 + backupCount: 10 + vnfres_handler: + level: "DEBUG" + class: + "logging.handlers.RotatingFileHandler" + filename: "/var/log/onap/vfc-gvnfm-vnfres/runtime_res.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/res/res/middleware.py b/res/res/middleware.py new file mode 100644 index 0000000..8aa9faf --- /dev/null +++ b/res/res/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 res.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/res/res/pub/config/config.py b/res/res/pub/config/config.py index dacb0fc..9aa2e19 100644 --- a/res/res/pub/config/config.py +++ b/res/res/pub/config/config.py @@ -28,6 +28,11 @@ DB_NAME = "gvnfm" DB_USER = "gvnfm" DB_PASSWD = "gvnfm" +# [MDC] +SERVICE_NAME = "vnfres" +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/res/res/settings.py b/res/res/settings.py index b62dad0..f15deff 100644 --- a/res/res/settings.py +++ b/res/res/settings.py @@ -19,6 +19,9 @@ import redisco from res.pub.config.config import REDIS_HOST, REDIS_PORT, REDIS_PASSWD from res.pub.config.config import DB_NAME, DB_IP, DB_USER, DB_PASSWD, DB_PORT +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__))) @@ -58,6 +61,7 @@ MIDDLEWARE_CLASSES = [ 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', + 'res.middleware.LogContextMiddleware', ] ROOT_URLCONF = 'res.urls' @@ -118,36 +122,41 @@ 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': { +# 'res_handler': { +# 'level': 'DEBUG', +# 'class': 'logging.handlers.RotatingFileHandler', +# 'filename': os.path.join(BASE_DIR, 'logs/runtime_res.log'), +# 'formatter': 'standard', +# 'maxBytes': 1024 * 1024 * 50, +# 'backupCount': 5, +# }, +# }, +# +# 'loggers': { +# 'res': { +# 'handlers': ['res_handler'], +# 'level': 'DEBUG', +# 'propagate': False +# }, +# } +# } +LOGGING_CONFIG = None +# yaml configuration of logging +LOGGING_FILE = os.path.join(BASE_DIR, 'res/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': { - 'res_handler': { - 'level': 'DEBUG', - 'class': 'logging.handlers.RotatingFileHandler', - 'filename': os.path.join(BASE_DIR, 'logs/runtime_res.log'), - 'formatter': 'standard', - 'maxBytes': 1024 * 1024 * 50, - 'backupCount': 5, - }, - }, - - 'loggers': { - 'res': { - 'handlers': ['res_handler'], - 'level': 'DEBUG', - 'propagate': False - }, - } -} if 'test' in sys.argv: from res.pub.config import config -- cgit 1.2.3-korg