Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ coverage = "==4.4.0"
pytest = "*"
pytest-cov = "*"
pylint = "*"
flake8 = "*"
tox = "*"
safety = "*"
bandit = "*"
Expand Down
59 changes: 45 additions & 14 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions pylintrc
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ confidence=
# no Warning level messages displayed, use"--disable=all --enable=classes
# --disable=W"
disable=logging-format-interpolation,broad-except,unnecessary-pass,no-member,line-too-long,invalid-name,
missing-module-docstring,missing-class-docstring,missing-function-docstring
missing-module-docstring,missing-class-docstring,missing-function-docstring,too-few-public-methods

# Enable the message, report, category or checker with the given id(s). You can
# either give multiple identifier separated by comma (,) or put this option
Expand Down Expand Up @@ -398,7 +398,7 @@ valid-metaclass-classmethod-first-arg=mcs
[DESIGN]

# Maximum number of arguments for function / method
max-args=5
max-args=7

# Maximum number of attributes for a class (see R0902).
max-attributes=7
Expand Down
3 changes: 3 additions & 0 deletions pyms/flask/healthcheck/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
from pyms.flask.healthcheck.healthcheck import healthcheck_blueprint


__all__ = ['healthcheck_blueprint']
Empty file added pyms/flask/services/__init__.py
Empty file.
8 changes: 5 additions & 3 deletions pyms/flask/services/metrics.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,20 +42,22 @@ def __init__(self, service, *args, **kwargs):
self.metrics_blueprint = Blueprint("metrics", __name__)
self.serve_metrics()

def monitor(self, app):
@staticmethod
def monitor(app):
app.before_request(before_request)
app.after_request(after_request)

def serve_metrics(self):
@self.metrics_blueprint.route("/metrics", methods=["GET"])
def metrics():
def metrics(): # pylint: disable=unused-variable
return Response(
generate_latest(),
mimetype="text/print()lain",
content_type="text/plain; charset=utf-8",
)

def add_logger_handler(self, logger, service_name):
@staticmethod
def add_logger_handler(logger, service_name):
logger.addHandler(MetricsLogHandler(service_name))
return logger

Expand Down
53 changes: 24 additions & 29 deletions pyms/flask/services/requests.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,29 @@
"""
import logging

import opentracing
import requests
from flask import current_app, request
from opentracing_instrumentation import get_current_span
from flask import request
from requests.adapters import HTTPAdapter
from requests.packages.urllib3.util.retry import Retry
from urllib3.util.retry import Retry

from pyms.constants import LOGGER_NAME
from pyms.flask.services.driver import DriverService
from pyms.flask.services.tracer import inject_span_in_headers

logger = logging.getLogger(LOGGER_NAME)

DEFAULT_RETRIES = 3

DEFAULT_STATUS_RETRIES = (500, 502, 504)
DEFAULTstatus_retries = (500, 502, 504)


def retry(f):
def wrapper(*args, **kwargs):
response = False
i = 0
response_ok = False
retries = args[0]._retries
status_retries = args[0]._status_retries
retries = args[0].retries
status_retries = args[0].status_retries
while i < retries and response_ok is False:
response = f(*args, **kwargs)
i += 1
Expand All @@ -45,16 +44,16 @@ class Service(DriverService):
"data": ""
}
tracer = None
_retries = DEFAULT_RETRIES
_status_retries = DEFAULT_STATUS_RETRIES
retries = DEFAULT_RETRIES
status_retries = DEFAULTstatus_retries
_propagate_headers = False

def __init__(self, service, *args, **kwargs):
"""Initialization for trace headers propagation"""
super().__init__(service, *args, **kwargs)
if self.exists_config():
self._retries = self.config.retries or DEFAULT_RETRIES
self._status_retries = self.config.status_retries or DEFAULT_STATUS_RETRIES
self.retries = self.config.retries or DEFAULT_RETRIES
self.status_retries = self.config.status_retries or DEFAULTstatus_retries
self._propagate_headers = self.config.propagate_headers

def requests(self, session: requests.Session):
Expand All @@ -67,19 +66,20 @@ def requests(self, session: requests.Session):
:return:
"""
session_r = session or requests.Session()
retry = Retry(
total=self._retries,
read=self._retries,
connect=self._retries,
max_retries = Retry(
total=self.retries,
read=self.retries,
connect=self.retries,
backoff_factor=0.3,
status_forcelist=self._status_retries,
status_forcelist=self.status_retries,
)
adapter = HTTPAdapter(max_retries=retry)
adapter = HTTPAdapter(max_retries=max_retries)
session_r.mount('http://', adapter)
session_r.mount('https://', adapter)
return session_r

def insert_trace_headers(self, headers: dict) -> dict:
@staticmethod
def insert_trace_headers(headers: dict) -> dict:
"""Inject trace headers if enabled.

:param headers: dictionary of HTTP Headers to send.
Expand All @@ -88,14 +88,7 @@ def insert_trace_headers(self, headers: dict) -> dict:
"""

try:
# FLASK https://github.com/opentracing-contrib/python-flask
span = self.tracer.get_span(request=request)
if not span: # pragma: no cover
span = get_current_span()
if not span:
span = self.tracer.tracer.start_span()
context = span.context if span else None
self._tracer.tracer.inject(context, opentracing.Format.HTTP_HEADERS, headers)
headers = inject_span_in_headers(headers)
except Exception as ex:
logger.debug("Tracer error {}".format(ex))
return headers
Expand All @@ -118,9 +111,6 @@ def _get_headers(self, headers, propagate_headers=False):
if not headers:
headers = {}

self.tracer = current_app.tracer
if self.tracer:
headers = self.insert_trace_headers(headers)
if self._propagate_headers or propagate_headers:
headers = self.propagate_headers(headers)
return headers
Expand Down Expand Up @@ -163,13 +153,15 @@ def get(self, url, path_params=None, params=None, headers=None, propagate_header
: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 propagate_headers: Optional arguments that ``request`` takes.
:param kwargs: Optional arguments that ``request`` takes.
:return: :class:`Response <Response>` object
:rtype: requests.Response
"""

full_url = self._build_url(url, path_params)
headers = self._get_headers(headers=headers, propagate_headers=propagate_headers)
headers = self.insert_trace_headers(headers)
logger.debug("Get with url {}, params {}, headers {}, kwargs {}".
format(full_url, params, headers, kwargs))

Expand Down Expand Up @@ -211,6 +203,7 @@ def post(self, url, path_params=None, data=None, json=None, headers=None, **kwar

full_url = self._build_url(url, path_params)
headers = self._get_headers(headers)
headers = self.insert_trace_headers(headers)
logger.debug("Post with url {}, data {}, json {}, headers {}, kwargs {}".format(full_url, data, json,
headers, kwargs))

Expand Down Expand Up @@ -254,6 +247,7 @@ def put(self, url, path_params=None, data=None, headers=None, **kwargs):

full_url = self._build_url(url, path_params)
headers = self._get_headers(headers)
headers = self.insert_trace_headers(headers)
logger.debug("Put with url {}, data {}, headers {}, kwargs {}".format(full_url, data, headers,
kwargs))

Expand Down Expand Up @@ -294,6 +288,7 @@ def delete(self, url, path_params=None, headers=None, **kwargs):

full_url = self._build_url(url, path_params)
headers = self._get_headers(headers)
headers = self.insert_trace_headers(headers)
logger.debug("Delete with url {}, headers {}, kwargs {}".format(full_url, headers, kwargs))

session = requests.Session()
Expand Down
28 changes: 24 additions & 4 deletions pyms/flask/services/tracer.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import logging

import opentracing
from flask import current_app, request
from jaeger_client.metrics.prometheus import PrometheusMetricsFactory
from opentracing_instrumentation import get_current_span

from pyms.config.conf import get_conf
from pyms.constants import LOGGER_NAME
Expand All @@ -15,6 +18,22 @@
DEFAULT_CLIENT = JAEGER_CLIENT


def inject_span_in_headers(headers):
# FLASK https://github.com/opentracing-contrib/python-flask
tracer = current_app.tracer
# Add traces
span = None
if tracer:
span = tracer.get_span(request=request)
if not span: # pragma: no cover
span = get_current_span()
if not span:
span = tracer.tracer.start_span()
context = span.context if span else None
tracer.tracer.inject(context, opentracing.Format.HTTP_HEADERS, headers)
return headers


class Service(DriverService):
service = "tracer"
default_values = {
Expand Down Expand Up @@ -52,10 +71,11 @@ def init_jaeger_tracer(self):
metrics = PrometheusMetricsFactory()
config = Config(
config={
**{'sampler': {
'type': 'const',
'param': 1,
},
**{
'sampler': {
'type': 'const',
'param': 1,
},
'propagation': 'b3',
'logging': True
},
Expand Down
Loading