Merge pull request #42 from python-microservices/feature/replace_tracer_jaeger

Replace tracer Jaeger with Lightstep

Author: avara1986

Pipfile

@@ -5,14 +5,13 @@ name = "pypi"
 
 [packages]
 flask = "*"
-jaeger-client = "==3.13.0"
 python-json-logger = ">=0.1.10"
 pyyaml = ">=4.2b4"
 anyconfig = ">=0.9.8"
 swagger-ui-bundle = ">=0.0.2"
 connexion = {extras = ["swagger-ui"],version = ">=2.2.0"}
-flask-opentracing = "==0.2.0"
-tornado = "==4.5.3"
+lightstep = "*"
+flask-opentracing = "*"
 
 [dev-packages]
 requests-mock = "*"

Pipfile.lock

@@ -12,7 +12,7 @@
 PyMS, Python MicroService, is a collections of libraries, best practices and recommended ways to build 
 microservices with Python.
 
-To know how use, install or build a porject see the docs (TODO: add url to readthedocs)
+To know how use, install or build a project see the docs: https://py-ms.readthedocs.io/en/latest/
 
 ## Installation 
 ```bash

README.md

@@ -1,5 +1,6 @@
 pyms:
-  requests: true
+  requests:
+    data: ""
   swagger:
     path: ""
     file: "swagger.yaml"

examples/microservice_requests/config.yml

@@ -1,5 +1,8 @@
 from examples.microservice_requests import ms
-
+from flask import current_app
 
 def example():
-    return ms.requests.get_for_object("https://ghibliapi.herokuapp.com/films/2baf70d1-42bb-4437-b551-e5fed5a87abe")
+    current_app.logger.info("start request")
+    result = ms.requests.get_for_object("https://ghibliapi.herokuapp.com/films/2baf70d1-42bb-4437-b551-e5fed5a87abe")
+    current_app.logger.info("end request")
+    return result

examples/microservice_requests/views.py

@@ -4,13 +4,16 @@
 
 import connexion
 from flask import Flask
-from flask_opentracing import FlaskTracer
+from flask_opentracing import FlaskTracing
 
 from pyms.config.conf import get_conf
+from pyms.constants import LOGGER_NAME
 from pyms.flask.healthcheck import healthcheck_blueprint
 from pyms.flask.services.driver import ServicesManager
 from pyms.logger import CustomJsonFormatter
-from pyms.tracer.main import init_jaeger_tracer
+from pyms.tracer.main import init_lightstep_tracer
+
+logger = logging.getLogger(LOGGER_NAME)
 
 
 class Microservice:
@@ -32,15 +35,18 @@ def init_libs(self):
         return self.application
 
     def init_tracer(self):
-        self.application.tracer = FlaskTracer(init_jaeger_tracer(), True, self.application)
+        self.application.opentracing_tracer = init_lightstep_tracer(self.application.config["APP_NAME"])
+        self.application.tracer = FlaskTracing(self.application.opentracing_tracer, True, self.application)
 
     def init_logger(self):
+        self.application.logger = logger
+        os.environ['WERKZEUG_RUN_MAIN'] = "true"
+
         formatter = CustomJsonFormatter('(timestamp) (level) (name) (module) (funcName) (lineno) (message)')
         formatter.add_service_name(self.application.config["APP_NAME"])
-        if getattr(self.application, "tracer", False):
-            formatter.add_trace_span(self.application.tracer)
         log_handler = logging.StreamHandler()
         log_handler.setFormatter(formatter)
+
         self.application.logger.addHandler(log_handler)
         self.application.logger.propagate = False
         self.application.logger.setLevel(logging.INFO)
@@ -78,8 +84,7 @@ def create_app(self):
         self.init_libs()
         self.add_error_handlers()
 
-        if not self.application.config["TESTING"]:
-            self.init_tracer()
+        self.init_tracer()
 
         self.init_logger()
 

pyms/flask/app/__init__.py

@@ -1,11 +1,16 @@
 """Encapsulate common rest operations between business services propagating trace headers if configured.
 """
+import logging
+
 import opentracing
 import requests
-from flask import current_app
+from flask import current_app, request
 
+from pyms.constants import LOGGER_NAME
 from pyms.flask.services.driver import DriverService
 
+logger = logging.getLogger(LOGGER_NAME)
+
 
 class Service(DriverService):
     service = "requests"
@@ -27,10 +32,10 @@ def insert_trace_headers(self, headers):
 
         try:
             # FLASK https://github.com/opentracing-contrib/python-flask
-            span = self._tracer.get_span()
-            self._tracer._tracer.inject(span, opentracing.Format.HTTP_HEADERS, headers)
+            span = self._tracer.get_span(request)
+            self._tracer.tracer.inject(span.context, opentracing.Format.HTTP_HEADERS, headers)
         except Exception as ex:
-            current_app.logger.warning("Tracer error {}".format(ex))
+            logger.debug("Tracer error {}".format(ex))
         return headers
 
     def _get_headers(self, headers):
@@ -87,7 +92,7 @@ def get(self, url, path_params=None, params=None, headers=None, **kwargs):
         :param params: (optional) Dictionary, list of tuples or bytes to send in the body of the :class:`Request` (as query
                     string parameters)
         :param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`.
-        :param \*\*kwargs: Optional arguments that ``request`` takes.
+        :param kwargs: Optional arguments that ``request`` takes.
         :return: :class:`Response <Response>` object
         :rtype: requests.Response
         """
@@ -109,7 +114,7 @@ def get_for_object(self, url, path_params=None, params=None, headers=None, **kwa
         :param params: (optional) Dictionary, list of tuples or bytes to send in the body of the :class:`Request` (as query
                     string parameters)
         :param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`.
-        :param \*\*kwargs: Optional arguments that ``request`` takes.
+        :param kwargs: Optional arguments that ``request`` takes.
         :return: :class:`Response <Response>` object
         :rtype: requests.Response
         """
@@ -126,7 +131,7 @@ def post(self, url, path_params=None, data=None, json=None, headers=None, **kwar
                     :class:`Request`.
         :param json: (optional) json data to send in the body of the :class:`Request`.
         :param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`.
-        :param \*\*kwargs: Optional arguments that ``request`` takes.
+        :param kwargs: Optional arguments that ``request`` takes.
         :return: :class:`Response <Response>` object
         :rtype: requests.Response
         """
@@ -149,7 +154,7 @@ def post_for_object(self, url, path_params=None, data=None, json=None, headers=N
                     :class:`Request`.
         :param json: (optional) json data to send in the body of the :class:`Request`.
         :param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`.
-        :param \*\*kwargs: Optional arguments that ``request`` takes.
+        :param kwargs: Optional arguments that ``request`` takes.
         :return: :class:`Response <Response>` object
         :rtype: requests.Response
         """
@@ -166,7 +171,7 @@ def put(self, url, path_params=None, data=None, headers=None, **kwargs):
             object to send in the body of the :class:`Request`.
         :param json: (optional) json data to send in the body of the :class:`Request`.
         :param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`.
-        :param \*\*kwargs: Optional arguments that ``request`` takes.
+        :param kwargs: Optional arguments that ``request`` takes.
         :return: :class:`Response <Response>` object
         :rtype: requests.Response
         """
@@ -189,7 +194,7 @@ def put_for_object(self, url, path_params=None, data=None, headers=None, **kwarg
             object to send in the body of the :class:`Request`.
         :param json: (optional) json data to send in the body of the :class:`Request`.
         :param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`.
-        :param \*\*kwargs: Optional arguments that ``request`` takes.
+        :param kwargs: Optional arguments that ``request`` takes.
         :return: :class:`Response <Response>` object
         :rtype: requests.Response
         """
@@ -203,7 +208,7 @@ def delete(self, url, path_params=None, headers=None, **kwargs):
         :param url: URL for the new :class:`Request` object. Could contain path parameters
         :param path_params: (optional) Dictionary, list of tuples with path parameters values to compose url
         :param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`.
-        :param \*\*kwargs: Optional arguments that ``request`` takes.
+        :param kwargs: Optional arguments that ``request`` takes.
         :return: :class:`Response <Response>` object
         :rtype: requests.Response
         """