diff options
| -rw-r--r-- | Changelog.md | 7 | ||||
| -rw-r--r-- | Dockerfile | 2 | ||||
| -rwxr-xr-x | bin/run.py | 10 | ||||
| -rw-r--r-- | config_binding_service/__init__.py | 16 | ||||
| -rw-r--r-- | config_binding_service/client.py | 14 | ||||
| -rw-r--r-- | config_binding_service/controller.py | 95 | ||||
| -rw-r--r-- | config_binding_service/logging.py | 56 | ||||
| -rw-r--r-- | pom.xml | 2 | ||||
| -rw-r--r-- | setup.py | 2 | ||||
| -rw-r--r-- | tests/test_binding.py | 3 |
10 files changed, 124 insertions, 83 deletions
diff --git a/Changelog.md b/Changelog.md index 53ccdf0..d5078b7 100644 --- a/Changelog.md +++ b/Changelog.md @@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). +## [2.1.2] +* Log to a file to be picked up by ELK per DCAEGEN2-387 +* Logging not totally finished w.r.t. formats, but this at least logs more and gets them into ELK + +## [2.1.1] +* [Shamefully this entry was missing] + ## [2.1.0] * Add a generic API for getting arbitrary keys * Some PEP8/Pylint compliance @@ -11,4 +11,6 @@ RUN pip install -e . EXPOSE 10000 +RUN mkdir -p /opt/logs/ + CMD run.py @@ -19,15 +19,13 @@ # ECOMP is a trademark and service mark of AT&T Intellectual Property. import connexion -import sys -from config_binding_service import get_logger - -_logger = get_logger(__name__) +from config_binding_service.logging import create_logger, LOGGER if __name__ == '__main__': + create_logger() try: app = connexion.App(__name__, specification_dir='../config_binding_service/swagger/') app.add_api('swagger.yaml', arguments={'title': 'Config Binding Service'}) app.run(host='0.0.0.0', port=10000, debug=False) - except Exception as e: - _logger.error("Fatal error. Could not start webserver due to: {0}".format(e)) + except Exception as exc: + LOGGER.error("Fatal error. Could not start webserver due to: %s", exc) diff --git a/config_binding_service/__init__.py b/config_binding_service/__init__.py index 2835511..5a6b081 100644 --- a/config_binding_service/__init__.py +++ b/config_binding_service/__init__.py @@ -17,17 +17,6 @@ # ECOMP is a trademark and service mark of AT&T Intellectual Property. import os -import logging - -# Configures the module root logger -root = logging.getLogger() -if root.handlers: - root.handlers.clear() -formatter = logging.Formatter('%(asctime)s | %(name)s | %(module)s | %(funcName)s | %(lineno)d | %(levelname)s | %(message)s') -handler = logging.StreamHandler() -handler.setFormatter(formatter) -root.addHandler(handler) -root.setLevel("DEBUG") class BadEnviornmentENVNotFound(Exception): @@ -37,11 +26,6 @@ class BadEnviornmentENVNotFound(Exception): pass -def get_logger(module=None): - '''Returns a module-specific logger or global logger if the module is None''' - return root if module is None else root.getChild(module) - - def get_consul_uri(): """ This method waterfalls reads an envioronmental variable called CONSUL_HOST diff --git a/config_binding_service/client.py b/config_binding_service/client.py index 2c04684..51ce3b1 100644 --- a/config_binding_service/client.py +++ b/config_binding_service/client.py @@ -23,9 +23,10 @@ import copy import json import requests import six -from config_binding_service import get_consul_uri, get_logger +from config_binding_service import get_consul_uri +from config_binding_service.logging import LOGGER + -_logger = get_logger(__name__) CONSUL = get_consul_uri() template_match_rels = re.compile("\{{2}([^\}\{]*)\}{2}") @@ -111,23 +112,20 @@ def _get_connection_info_from_consul(service_component_name): TODO: WARNING: FIXTHIS: CALLINTHENATIONALARMY: This tries to determine that a service_component_name is a cdap application by inspecting service_component_name and name munging. However, this would force all CDAP applications to have cdap_app in their name. A much better way to do this is to do some kind of catalog_lookup here, OR MAYBE change this API so that the component_type is passed in somehow. THis is a gaping TODO. """ - _logger.info("Retrieving connection information for {0}".format( - service_component_name)) + LOGGER.info("Retrieving connection information for %s", service_component_name) res = requests.get( "{0}/v1/catalog/service/{1}".format(CONSUL, service_component_name)) res.raise_for_status() services = res.json() if services == []: - _logger.info("Warning: config and rels keys were both valid, but there is no component named {0} registered in Consul!".format( - service_component_name)) + LOGGER.info("Warning: config and rels keys were both valid, but there is no component named %s registered in Consul!", service_component_name) return None # later will get filtered out ip_addr = services[0]["ServiceAddress"] port = services[0]["ServicePort"] if "cdap_app" in service_component_name: redirectish_url = "http://{0}:{1}/application/{2}".format( ip_addr, port, service_component_name) - _logger.info("component is a CDAP application; trying the broker redirect on {0}".format( - redirectish_url)) + LOGGER.info("component is a CDAP application; trying the broker redirect on %s", redirectish_url) res = requests.get(redirectish_url) res.raise_for_status() details = res.json() diff --git a/config_binding_service/controller.py b/config_binding_service/controller.py index 7bb5f51..68ac1ac 100644 --- a/config_binding_service/controller.py +++ b/config_binding_service/controller.py @@ -16,71 +16,68 @@ # # ECOMP is a trademark and service mark of AT&T Intellectual Property. +import json import requests from flask import Response -import json -from config_binding_service import client, get_consul_uri, get_logger +from config_binding_service import client, get_consul_uri +from config_binding_service.logging import LOGGER + -_logger = get_logger(__name__) +def _get_helper(json_expecting_func, **kwargs): + """ + Helper function used by several functions below + """ + print(kwargs) + try: + payload = json_expecting_func(**kwargs) + response, status_code, mimetype = json.dumps(payload), 200, "application/json" + except client.BadRequest as exc: + response, status_code, mimetype = exc.response, exc.code, "text/plain" + except client.CantGetConfig as exc: + response, status_code, mimetype = exc.response, exc.code, "text/plain" + except Exception as exc: + LOGGER.error(exc) + response, status_code, mimetype = "Unknown error, please report", 500, "text/plain" + return response, status_code, mimetype def bind_all(service_component_name): - try: - allk = client.resolve_all(service_component_name) - return Response(response=json.dumps(allk), - status=200, - mimetype="application/json") - except client.CantGetConfig as e: - return Response(status=e.code, - response=e.response) - except Exception as e: - _logger.error(e) - return Response(response="Unknown error: please report", - status=500) + """ + Get all the keys in Consul for this SCN, and bind the config + """ + response, status_code, mimetype = _get_helper(client.resolve_all, service_component_name=service_component_name) + LOGGER.info("bind_all called for %s, returned code %d", service_component_name, status_code) + return Response(response=response, status=status_code, mimetype=mimetype) def bind_config_for_scn(service_component_name): - try: - bound = client.resolve(service_component_name) - return Response(response=json.dumps(bound), - status=200, - mimetype="application/json") - except client.CantGetConfig as e: - return Response(status=e.code, - response=e.response) - except Exception as e: # should never happen... - _logger.error(e) - return Response(response="Please report this error", - status=500) + """ + Bind just the config for this SCN + """ + response, status_code, mimetype = _get_helper(client.resolve, service_component_name=service_component_name) + LOGGER.info("bind_config_for_scn called for %s, returned code %d", service_component_name, status_code) + return Response(response=response, status=status_code, mimetype=mimetype) def get_key(key, service_component_name): - try: - bound = client.get_key(key, service_component_name) - return Response(response=json.dumps(bound), - status=200, - mimetype="application/json") - except client.CantGetConfig as e: - return Response(status=e.code, - response=e.response) - except client.BadRequest as exc: - return Response(status=exc.code, - response=exc.response, - mimetype="text/plain") - except Exception as e: # should never happen... - _logger.error(e) - return Response(response="Please report this error", - status=500) + """ + Get a single key k of the form service_component_name:k from Consul. + Should not be used and will return a BAD REQUEST for k=policies because it's a complex object + """ + response, status_code, mimetype = _get_helper(client.get_key, key=key, service_component_name=service_component_name) + LOGGER.info("get_key called for %s, returned code %d", service_component_name, status_code) + return Response(response=response, status=status_code, mimetype=mimetype) def healthcheck(): - # got this far, I must be alive... check my connection to Consul by checking myself - CONSUL = get_consul_uri() + """ + CBS Healthcheck + """ + LOGGER.info("healthcheck called") res = requests.get( - "{0}/v1/catalog/service/config_binding_service".format(CONSUL)) + "{0}/v1/catalog/service/config_binding_service".format(get_consul_uri())) if res.status_code == 200: return Response(response="CBS is alive and Consul connection OK", status=200) - else: - return Response(response="CBS is alive but cannot reach Consul", - status=503) + return Response(response="CBS is alive but cannot reach Consul", + status=503) diff --git a/config_binding_service/logging.py b/config_binding_service/logging.py new file mode 100644 index 0000000..e66851d --- /dev/null +++ b/config_binding_service/logging.py @@ -0,0 +1,56 @@ +# ============LICENSE_START======================================================= +# Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved. +# ================================================================================ +# 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. +# See the License for the specific language governing permissions and +# limitations under the License. +# ============LICENSE_END========================================================= +# +# ECOMP is a trademark and service mark of AT&T Intellectual Property. + +from logging import getLogger, StreamHandler, Formatter +from logging.handlers import RotatingFileHandler +from os import makedirs + + +LOGGER = getLogger("defaultlogger") + + +def _create_logger(name, logfile): + """ + Create a RotatingFileHandker + https://docs.python.org/3/library/logging.handlers.html + what's with the non-pythonic naming in these stdlib methods? Shameful. + """ + logger = getLogger(name) + file_handler = RotatingFileHandler(logfile, + maxBytes=10000000, backupCount=2) # 10 meg with one backup.. + file_formatter = Formatter('%(asctime)s | %(name)s | %(module)s | %(funcName)s | %(lineno)d | %(levelname)s | %(message)s') # right now the same, but intending to change + file_handler.setFormatter(file_formatter) + + stream_handler = StreamHandler() + stream_formatter = Formatter('%(asctime)s | %(name)s | %(module)s | %(funcName)s | %(lineno)d | %(levelname)s | %(message)s') + stream_handler.setFormatter(stream_formatter) + logger.setLevel("DEBUG") # a function is going to wrap this anyway + logger.addHandler(file_handler) + logger.addHandler(stream_handler) + return logger + + +def create_logger(): + """ + Public method to set the global logger, launched from Run + """ + LOGFILE = "/opt/logs/log.log" + makedirs("/opt/logs", exist_ok=True) + open(LOGFILE, 'a').close() # this is like "touch" + global LOGGER + LOGGER = _create_logger("config_binding_service", LOGFILE) @@ -29,7 +29,7 @@ ECOMP is a trademark and service mark of AT&T Intellectual Property. <groupId>org.onap.dcaegen2.platform</groupId> <artifactId>configbinding</artifactId> <name>dcaegen2-platform-configbinding</name> - <version>2.1.1</version> + <version>2.1.2</version> <url>http://maven.apache.org</url> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> @@ -20,7 +20,7 @@ from setuptools import setup, find_packages setup( name='config_binding_service', - version='2.1.1', + version='2.1.2', packages=find_packages(exclude=["tests.*", "tests"]), author="Tommy Carpenter", author_email="tommy@research.att.com", diff --git a/tests/test_binding.py b/tests/test_binding.py index 1ed4b0a..94ee1cb 100644 --- a/tests/test_binding.py +++ b/tests/test_binding.py @@ -16,13 +16,12 @@ # # ECOMP is a trademark and service mark of AT&T Intellectual Property. -import pytest import json +import pytest from requests.exceptions import HTTPError from config_binding_service import get_consul_uri from config_binding_service import client, controller - ##### # MONKEYPATCHES ##### |