Merge branch 'feature/logger' into develop

Author: avara1986

README.md

@@ -20,7 +20,7 @@ Test the image:
 
 Push to Kubernetes:
 
-    kubectl create -f service.yaml
+    kubectl apply -f service.yaml
 
 
 ## How to contrib

project/__init__.py

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+import logging
 import os
 
 from flasgger import Swagger
@@ -9,13 +10,17 @@
 
 from project.config import CONFIG
 from pyms.healthcheck import healthcheck_blueprint
+from pyms.logger import CustomJsonFormatter
 from pyms.models import db
 from pyms.tracer.main import TracerModule
 
 __author__ = "Alberto Vara"
 __email__ = "a.vara.1986@gmail.com"
 __version__ = "0.0.1"
 
+logger = logging.getLogger('jaeger_tracing')
+logger.setLevel(logging.DEBUG)
+
 ENVIRONMENT = os.environ.get("ENVIRONMENT", "default")
 
 SWAGGER_CONFIG = {
@@ -107,10 +112,19 @@ def create_app():
     app.register_blueprint(views_blueprint)
     app.register_blueprint(healthcheck_blueprint)
 
+    # Inject Modules
     # Inject Modules
     if not app.config["TESTING"] and not app.config["DEBUG"]:
-        injector = Injector([TracerModule(app)])
+        log_handler = logging.StreamHandler()
+        formatter = CustomJsonFormatter('(timestamp) (level) (name) (module) (funcName) (lineno) (message)')
+        formatter.add_service_name(app.config["APP_NAME"])
+        tracer = TracerModule(app)
+        injector = Injector([tracer])
         FlaskInjector(app=app, injector=injector)
+        formatter.add_trace_span(tracer.tracer)
+        log_handler.setFormatter(formatter)
+        app.logger.addHandler(log_handler)
+        app.logger.setLevel(logging.INFO)
 
     with app.test_request_context():
         db.create_all()

project/tests/test_views.py

@@ -25,6 +25,10 @@ def test_home(self):
         response = self.client.get('/')
         self.assertEqual(response.status_code, 404)
 
+    def test_healthcheck(self):
+        response = self.client.get('/healthcheck')
+        self.assertEqual(response.status_code, 200)
+
     def test_list_view(self):
         response = self.client.get('{base_url}/'.format(base_url=self.base_url))
         self.assertEqual(response.status_code, 200)

project/views/views.py

@@ -1,7 +1,7 @@
 # encoding: utf-8
 from __future__ import absolute_import, print_function, unicode_literals
 
-from flask import request, jsonify
+from flask import request, jsonify, current_app
 
 from pyms.models import db
 from project.models.models import Colors
@@ -57,7 +57,7 @@ def list_view():
             ]
           }]
     """
-
+    current_app.logger.info("Return all color list")
     query = Colors.query.all()
 
     return jsonify([i.serialize for i in query])
@@ -107,6 +107,7 @@ def create_view():
             ]
           }
     """
+    current_app.logger.info("Create color")
     color = Colors(name=request.form["name"])
     db.session.add(color)
     db.session.commit()

pyms/healthcheck/healthcheck.py

@@ -1,17 +1,6 @@
-import opentracing
-import requests
-from flask_opentracing import FlaskTracer
-
 from pyms.healthcheck import healthcheck_blueprint
 
 
 @healthcheck_blueprint.route('/healthcheck', methods=['GET'])
-def healthcheck(tracer: FlaskTracer):
-    span = tracer.get_span()
-    headers = {}
-    tracer._tracer.inject(span, opentracing.Format.HTTP_HEADERS, headers)
-    result = requests.post(url="http://localhost:8081/oauth/login", data={
-        "username": "test",
-        "password": "1234"
-    }, headers=headers)
-    return result.content
+def healthcheck():
+    return "OK"

pyms/logger/__init__.py

@@ -0,0 +1 @@
+from pyms.logger.logger import CustomJsonFormatter

pyms/logger/logger.py

@@ -0,0 +1,37 @@
+import datetime
+
+import opentracing
+from flask_opentracing import FlaskTracer
+from pythonjsonlogger import jsonlogger
+
+
+class CustomJsonFormatter(jsonlogger.JsonFormatter):
+    service_name = ""
+    tracer = ""
+
+    def add_fields(self, log_record, record, message_dict):
+        super(CustomJsonFormatter, self).add_fields(log_record, record, message_dict)
+        if not log_record.get('timestamp'):
+            # this doesn't use record.created, so it is slightly off
+            now = datetime.datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%S.%fZ')
+            log_record['timestamp'] = now
+        if log_record.get('level'):
+            log_record['severity'] = log_record['level'].upper()
+        else:
+            log_record['severity'] = record.levelname
+        log_record["service"] = self.service_name
+
+        # Add traces
+        if self.tracer:
+            span = self.tracer.get_span()
+            headers = {}
+            self.tracer._tracer.inject(span, opentracing.Format.HTTP_HEADERS, headers)
+            log_record["trace"] = headers.get('X-B3-TraceId', '')
+            log_record["span"] = headers.get('X-B3-SpanId', '')
+            log_record["parent"] = headers.get('X-B3-ParentSpanId', '')
+
+    def add_service_name(self, project_name):
+        self.service_name = project_name.lower()
+
+    def add_trace_span(self, tracer: FlaskTracer):
+        self.tracer = tracer

pyms/tracer/main.py

@@ -10,15 +10,18 @@ def init_jaeger_tracer(service_name='your-app-name'):
     :return: opentracing.Tracer
     """
     config = Config(config={
+        # 'propagation': 'b3',
         'sampler': {'type': 'const', 'param': 1}, 'logging': True,
     }, service_name=service_name)
     return config.initialize_tracer()
 
 
 class TracerModule(Module):
+    tracer = ""
+
     def __init__(self, app):
         self.app = app
 
     def configure(self, binder):
-        tracer = init_jaeger_tracer(self.app.config["APP_NAME"])
-        binder.bind(FlaskTracer, to=FlaskTracer(tracer, True, self.app))
+        self.tracer = FlaskTracer(init_jaeger_tracer(self.app.config["APP_NAME"]), True, self.app)
+        binder.bind(FlaskTracer, to=self.tracer)

requirements.txt

@@ -5,6 +5,6 @@ Flask-Injector==0.10.1
 Flask-OpenTracing==0.1.8
 Flask-Script==2.0.6
 Flask-SQLAlchemy==2.3.2
-Flask-Testing==0.7.1
 SQLAlchemy==1.2.5
+python-json-logger==0.1.8
 requests==2.18.4

service.yaml

@@ -1,4 +1,3 @@
-# interno
 kind: Service
 apiVersion: v1
 metadata:
@@ -11,21 +10,6 @@ spec:
     port: 80
     targetPort: 5000
 ---
-# externo
-apiVersion: v1
-kind: Service
-metadata:
-  name: template-external
-spec:
-  ports:
-  - port: 80
-    targetPort: 5000
-  selector:
-    app: template
-  type: LoadBalancer
-  loadBalancerSourceRanges:
-  - 62.82.24.134/32
----
 apiVersion: extensions/v1beta1
 kind: Deployment
 metadata: