⬆️ ♻️ Adds tracing tooling in servicelib (ITISFoundation#2553)

This PR sets up simcore-service-library to re-enable jaeger tracing tooling in all services.

- For fastapi-based services we add fastapi_contrib[jaegertracing] in simcore-service-library[fastapi] and includes the latter in requirements to all fastapi-based services, namely api-server, catalog
- For aiohttpg-based service simcore-service-library[aiohttp] already includes servicelib.aiohttp.tracing
- Refactors setup.py and some requirements setups.

Author: pcrespov

packages/service-library/MANIFEST.in

@@ -7,3 +7,4 @@
 --constraint ./_base.in
 
 fastapi
+fastapi_contrib[jaegertracing]

packages/service-library/README.rst

@@ -5,14 +5,34 @@
 #    pip-compile --output-file=requirements/_fastapi.txt --strip-extras requirements/_fastapi.in
 #
 fastapi==0.68.1
+    # via
+    #   -r requirements/_fastapi.in
+    #   fastapi-contrib
+fastapi-contrib==0.2.11
     # via -r requirements/_fastapi.in
+jaeger-client==4.8.0
+    # via fastapi-contrib
+opentracing==2.4.0
+    # via
+    #   fastapi-contrib
+    #   jaeger-client
 pydantic==1.8.2
     # via
     #   -c requirements/../../../requirements/constraints.txt
     #   -c requirements/./../../../requirements/constraints.txt
     #   -c requirements/./_base.in
     #   fastapi
+six==1.16.0
+    # via thrift
 starlette==0.14.2
     # via fastapi
+threadloop==1.0.2
+    # via jaeger-client
+thrift==0.13.0
+    # via jaeger-client
+tornado==6.1
+    # via
+    #   jaeger-client
+    #   threadloop
 typing-extensions==3.10.0.2
     # via pydantic

packages/service-library/requirements/_fastapi.in

@@ -3,10 +3,6 @@
 from pathlib import Path
 from typing import Set
 
-from setuptools import find_packages, setup
-
-CURRENT_DIR = Path(sys.argv[0] if __name__ == "__main__" else __file__).resolve().parent
-
 
 def read_reqs(reqs_path: Path) -> Set[str]:
     return {
@@ -20,6 +16,13 @@ def read_reqs(reqs_path: Path) -> Set[str]:
     }
 
 
+CURRENT_DIR = Path(sys.argv[0] if __name__ == "__main__" else __file__).resolve().parent
+
+NAME = "simcore-service-library"
+VERSION = "1.1.0"
+AUTHORS = "Pedro Crespo-Valero (pcrespov)"
+DESCRIPTION = "Core service library for simcore (or servicelib)"
+
 # WEAK requirements (see requirements/python-dependencies.md)
 PROD_REQUIREMENTS = read_reqs(CURRENT_DIR / "requirements" / "_base.in")
 AIOHTTP_REQUIREMENTS = read_reqs(CURRENT_DIR / "requirements" / "_aiohttp.in")
@@ -30,33 +33,24 @@ def read_reqs(reqs_path: Path) -> Set[str]:
 
 
 if __name__ == "__main__":
+    from setuptools import find_packages, setup
 
     setup(
-        name="simcore-service-library",
-        version="1.1.0",
-        author="Pedro Crespo (pcrespov)",
-        description="Core service library for simcore (or servicelib)",
-        classifiers=[
-            "Development Status :: 3 - Alpha",
-            "Intended Audience :: Developers",
-            "License :: OSI Approved :: MIT License",
-            "Natural Language :: English",
-            "Programming Language :: Python :: 3.8",
-        ],
-        long_description=Path(CURRENT_DIR / "README.rst").read_text(),
+        name=NAME,
+        version=VERSION,
+        author=AUTHORS,
+        description=DESCRIPTION,
         license="MIT license",
         python_requires="~=3.8",
-        install_requires=list(PROD_REQUIREMENTS),
+        install_requires=tuple(PROD_REQUIREMENTS),
         packages=find_packages(where="src"),
         package_dir={"": "src"},
-        include_package_data=True,
         test_suite="tests",
-        tests_require=list(TEST_REQUIREMENTS),
+        tests_require=tuple(TEST_REQUIREMENTS),
         extras_require={
-            "test": list(TEST_REQUIREMENTS),
-            "aiohttp": list(AIOHTTP_REQUIREMENTS),
-            "fastapi": list(FASTAPI_REQUIREMENTS),
-            "all": list(AIOHTTP_REQUIREMENTS | FASTAPI_REQUIREMENTS),
+            "test": tuple(TEST_REQUIREMENTS),
+            "aiohttp": tuple(AIOHTTP_REQUIREMENTS),
+            "fastapi": tuple(FASTAPI_REQUIREMENTS),
+            "all": tuple(AIOHTTP_REQUIREMENTS | FASTAPI_REQUIREMENTS),
         },
-        zip_safe=False,
     )

packages/service-library/requirements/_fastapi.txt

@@ -6,10 +6,12 @@
 --constraint ../../../requirements/constraints.txt
 
 # intra-repo required dependencies
---requirement ../../../packages/postgres-database/requirements/_base.in
 --requirement ../../../packages/models-library/requirements/_base.in
+--requirement ../../../packages/postgres-database/requirements/_base.in
 --requirement ../../../packages/simcore-sdk/requirements/_base.in
+# service-library[fastapi]
 --requirement ../../../packages/service-library/requirements/_base.in
+--requirement ../../../packages/service-library/requirements/_fastapi.in
 
 
 # fastapi and extensions

packages/service-library/setup.py

@@ -6,6 +6,7 @@
 #
 aiodebug==1.1.2
     # via
+    #   -c requirements/../../../packages/service-library/requirements/./_base.in
     #   -r requirements/../../../packages/service-library/requirements/_base.in
     #   -r requirements/../../../packages/simcore-sdk/requirements/../../../packages/service-library/requirements/_base.in
 aiofiles==0.5.0
@@ -17,6 +18,7 @@ aiohttp==3.7.4.post0
     #   -c requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt
+    #   -c requirements/../../../packages/service-library/requirements/./../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt
@@ -41,6 +43,7 @@ async-timeout==3.0.1
     #   aiopg
 attrs==20.3.0
     # via
+    #   -c requirements/../../../packages/service-library/requirements/././constraints.txt
     #   -c requirements/../../../packages/service-library/requirements/./constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/service-library/requirements/./constraints.txt
     #   -r requirements/../../../packages/simcore-sdk/requirements/_base.in
@@ -65,6 +68,7 @@ cryptography==3.4.7
     #   -c requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt
+    #   -c requirements/../../../packages/service-library/requirements/./../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt
@@ -82,7 +86,12 @@ email-validator==1.1.2
     #   fastapi
     #   pydantic
 fastapi==0.68.1
-    # via -r requirements/_base.in
+    # via
+    #   -r requirements/../../../packages/service-library/requirements/_fastapi.in
+    #   -r requirements/_base.in
+    #   fastapi-contrib
+fastapi-contrib==0.2.11
+    # via -r requirements/../../../packages/service-library/requirements/_fastapi.in
 graphene==2.1.8
     # via fastapi
 graphql-core==2.3.2
@@ -103,6 +112,7 @@ httpx==0.18.1
     # via -r requirements/_base.in
 idna==2.10
     # via
+    #   -c requirements/../../../packages/service-library/requirements/././constraints.txt
     #   -c requirements/../../../packages/service-library/requirements/./constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/postgres-database/requirements/_base.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/service-library/requirements/./constraints.txt
@@ -119,6 +129,7 @@ importlib-resources==5.1.3 ; python_version < "3.9"
     #   -c requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt
+    #   -c requirements/../../../packages/service-library/requirements/./../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt
@@ -128,11 +139,14 @@ importlib-resources==5.1.3 ; python_version < "3.9"
     #   alembic
 itsdangerous==1.1.0
     # via fastapi
+jaeger-client==4.8.0
+    # via fastapi-contrib
 jinja2==2.11.3
     # via
     #   -c requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt
+    #   -c requirements/../../../packages/service-library/requirements/./../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt
@@ -152,6 +166,10 @@ multidict==5.1.0
     #   yarl
 networkx==2.5.1
     # via -r requirements/../../../packages/simcore-sdk/requirements/_base.in
+opentracing==2.4.0
+    # via
+    #   fastapi-contrib
+    #   jaeger-client
 orjson==3.5.2
     # via fastapi
 packaging==20.9
@@ -175,6 +193,8 @@ pydantic==1.8.2
     #   -c requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt
+    #   -c requirements/../../../packages/service-library/requirements/./../../../requirements/constraints.txt
+    #   -c requirements/../../../packages/service-library/requirements/./_base.in
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt
@@ -189,6 +209,7 @@ pydantic==1.8.2
     #   fastapi
 pyinstrument==3.4.2
     # via
+    #   -c requirements/../../../packages/service-library/requirements/./_base.in
     #   -r requirements/../../../packages/service-library/requirements/_base.in
     #   -r requirements/../../../packages/simcore-sdk/requirements/../../../packages/service-library/requirements/_base.in
 pyinstrument-cext==0.2.4
@@ -206,6 +227,8 @@ pyyaml==5.4.1
     #   -c requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt
+    #   -c requirements/../../../packages/service-library/requirements/./../../../requirements/constraints.txt
+    #   -c requirements/../../../packages/service-library/requirements/./_base.in
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt
@@ -231,6 +254,7 @@ six==1.16.0
     #   graphql-relay
     #   python-multipart
     #   tenacity
+    #   thrift
     #   websocket-client
 sniffio==1.2.0
     # via
@@ -241,6 +265,7 @@ sqlalchemy==1.3.24
     #   -c requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt
+    #   -c requirements/../../../packages/service-library/requirements/./../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/postgres-database/requirements/_base.txt
@@ -255,11 +280,20 @@ starlette==0.14.2
     # via fastapi
 tenacity==7.0.0
     # via
+    #   -c requirements/../../../packages/service-library/requirements/./_base.in
     #   -r requirements/../../../packages/service-library/requirements/_base.in
     #   -r requirements/../../../packages/simcore-sdk/requirements/../../../packages/postgres-database/requirements/_migration.in
     #   -r requirements/../../../packages/simcore-sdk/requirements/../../../packages/service-library/requirements/_base.in
     #   -r requirements/../../../packages/simcore-sdk/requirements/_base.in
     #   -r requirements/_base.in
+threadloop==1.0.2
+    # via jaeger-client
+thrift==0.13.0
+    # via jaeger-client
+tornado==6.1
+    # via
+    #   jaeger-client
+    #   threadloop
 tqdm==4.60.0
     # via -r requirements/../../../packages/simcore-sdk/requirements/_base.in
 trafaret==2.1.0
@@ -272,6 +306,7 @@ typing-extensions==3.10.0.2
     #   pydantic
 ujson==4.0.2
     # via
+    #   -c requirements/../../../packages/service-library/requirements/./_base.in
     #   -r requirements/../../../packages/service-library/requirements/_base.in
     #   -r requirements/../../../packages/simcore-sdk/requirements/../../../packages/service-library/requirements/_base.in
     #   fastapi
@@ -280,6 +315,7 @@ urllib3==1.26.5
     #   -c requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt
+    #   -c requirements/../../../packages/service-library/requirements/./../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt
@@ -292,6 +328,7 @@ uvicorn==0.13.4
     #   -c requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt
+    #   -c requirements/../../../packages/service-library/requirements/./../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/models-library/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/postgres-database/requirements/../../../requirements/constraints.txt
     #   -c requirements/../../../packages/simcore-sdk/requirements/../../../packages/service-library/requirements/../../../requirements/constraints.txt

services/api-server/requirements/_base.in

@@ -15,7 +15,7 @@
 ../../packages/postgres-database/
 ../../packages/pytest-simcore/
 ../../packages/simcore-sdk
-../../packages/service-library
+../../packages/service-library[fastapi]
 ../../services/storage/client-sdk/python/
 
 # installs current package

services/api-server/requirements/_base.txt

@@ -16,7 +16,7 @@
 --editable ../../packages/postgres-database
 --editable ../../packages/pytest-simcore/
 --editable ../../packages/simcore-sdk
---editable ../../packages/service-library
+--editable ../../packages/service-library[fastapi]
 --editable ../../services/storage/client-sdk/python/
 
 # installs current package

services/api-server/requirements/ci.txt

@@ -13,7 +13,7 @@
 ../../packages/models-library
 ../../packages/postgres-database/
 ../../packages/simcore-sdk
-../../packages/service-library
+../../packages/service-library[fastapi]
 ../../services/storage/client-sdk/python/
 
 # installs current package