Files
2020-04-08 10:39:44 -07:00

45 lines
1.2 KiB
Python

"""
The flask cache tracer will track any access to a cache backend.
You can use this tracer together with the Flask tracer middleware.
To install the tracer, ``from ddtrace import tracer`` needs to be added::
from ddtrace import tracer
from ddtrace.contrib.flask_cache import get_traced_cache
and the tracer needs to be initialized::
Cache = get_traced_cache(tracer, service='my-flask-cache-app')
Here is the end result, in a sample app::
from flask import Flask
from ddtrace import tracer
from ddtrace.contrib.flask_cache import get_traced_cache
app = Flask(__name__)
# get the traced Cache class
Cache = get_traced_cache(tracer, service='my-flask-cache-app')
# use the Cache as usual with your preferred CACHE_TYPE
cache = Cache(app, config={'CACHE_TYPE': 'simple'})
def counter():
# this access is traced
conn_counter = cache.get("conn_counter")
"""
from ...utils.importlib import require_modules
required_modules = ['flask_cache']
with require_modules(required_modules) as missing_modules:
if not missing_modules:
from .tracers import get_traced_cache
__all__ = ['get_traced_cache']