Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qiajigou/flask-zipkin
a flask zipkin extension based on py_zipkin.
https://github.com/qiajigou/flask-zipkin
Last synced: 3 months ago
JSON representation
a flask zipkin extension based on py_zipkin.
- Host: GitHub
- URL: https://github.com/qiajigou/flask-zipkin
- Owner: qiajigou
- Created: 2016-10-25T09:24:16.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T18:32:03.000Z (8 months ago)
- Last Synced: 2024-09-21T08:42:00.772Z (4 months ago)
- Language: Python
- Homepage: http://qiajigou.click/flask-zipkin/
- Size: 36.1 KB
- Stars: 41
- Watchers: 3
- Forks: 25
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-flask - flask-zipkin - Distributed tracing with [Zipkin](https://zipkin.io/). (Tracing)
- awesome-flask - flask-zipkin - Distributed tracing with [Zipkin](https://zipkin.io/). (Tracing)
- awesome-flask - flask-zipkin - Distributed tracing with [Zipkin](https://zipkin.io/). (Tracing)
- jimsghstars - qiajigou/flask-zipkin - a flask zipkin extension based on py_zipkin. (Python)
README
# flask-zipkin
a flask zipkin extension based on py_zipkin.
## Installation
```bash
pip install flask_zipkin
```
## usage
you can simply use it as other flask extensions.
```python
from flask_zipkin import Zipkin
zipkin = Zipkin(app, sample_rate=10)
app.config['ZIPKIN_DSN'] = "http://127.0.0.1:9411/api/v1/spans"
```
## Advance Usage
you could gen a header to pass it to other services, the downstream service will recieve this header.
```python
@bp.route('/')
def hello():
headers = {}
headers.update(zipkin.create_http_headers_for_new_span())
r = requests.get('http://localhost:5001', headers=headers)
return r.text
```
`flask_zipkin` will use http transport by default. You could define a transport, like:
```python
@zipkin.transport_handler
def default_handler(encoded_span):
return requests.post(
'your transport dsn',
data=encoded_span,
headers={'Content-Type': 'application/x-thrift'},
)
```
`flask_zipkin` eats all transport exception by default. You could define an exception handler, like:
```python
@zipkin.transport_exception_handler
def default_ex_handler(ex):
raise ex
```
and also, you could exempt some views, like:
```python
@zipkin.exempt
@bp.route('/')
def hello():
return 'hello world'
```
add key, value for your tracing record, like:
```python
zipkin.update_tags(id=1, user_id=2)
```
## app configs
`ZIPKIN_DISABLE` disable zipkin tracking if value is `True`
`ZIPKIN_DSN` http transport dsn: such as `http://localhost:9411/api/v1/spans`