Starlette-OpenTracing

OpenTracing support for Starlette and FastApi applications


Keywords
fastapi, starlette, starlette-middleware
License
Apache-2.0
Install
pip install Starlette-OpenTracing==0.1.0

Documentation

Starlette-OpenTracing

Maintenance yes PyPI pyversions Build info

OpenTracing support for Starlette and FastApi. Inspired by: Flask-OpenTracing OpenTracing implementations exist for major distributed tracing systems and can be bound or swapped with a one-line configuration change. This package uses the OpenTracing API for Python to implement it's functionality.

WORK IN PROGRESS. Not ready for production!

The package will implement: Starlette middleware that can be used to add Opentracing support to all incoming requests.

It will, when ready, also contain 2 decorators that can be used to decorate routes: one to setup tracing without the middleware and one to add extra tags/spans for an endpoint.

Installation

Run the following command:

$ pip install Starlette-Opentracing

Usage

See the examples for FastAPI and Starlette in examples/

Deploy

Increase version in VERSION

git commit -a -m "bumped version to 0.0.3"
git tag -a v0.0.3 -m "version 0.0.3"
git push --follow-tags

License info

Copyright 2020 R. Dohmen <acidjunk@gmail.com>

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.