OpenTelemetry FastAPI Instrumentation
Project description
This library provides automatic and manual instrumentation of FastAPI web frameworks, instrumenting http requests served by applications utilizing the framework.
auto-instrumentation using the opentelemetry-instrumentation package is also supported.
Installation
pip install opentelemetry-instrumentation-fastapi
Configuration
Exclude lists
To exclude certain URLs from being tracked, set the environment variable OTEL_PYTHON_FASTAPI_EXCLUDED_URLS with comma delimited regexes representing which URLs to exclude.
For example,
export OTEL_PYTHON_FASTAPI_EXCLUDED_URLS="client/.*/info,healthcheck"
will exclude requests such as https://site/client/123/info and https://site/xyz/healthcheck.
Usage
import fastapi
from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor
app = fastapi.FastAPI()
@app.get("/foobar")
async def foobar():
return {"message": "hello world"}
FastAPIInstrumentor.instrument_app(app)
References
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for opentelemetry-instrumentation-fastapi-0.19b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c6687e7301d508367f100cd4fae99d32e5ce9a8c4f60745a077d1c5105efb758 |
|
MD5 | c5c38a8031d27ebb777387f467fc0d13 |
|
BLAKE2b-256 | 179914678da059beae58c8c6024c603281dd986e60dcc2667e454a5ccee25c44 |
Close
Hashes for opentelemetry_instrumentation_fastapi-0.19b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed07395457c4682d3b7fadb4e1be9646c5811946dc3c750e4861b626d2073d79 |
|
MD5 | e1973ff5d42d6810d8cce465a7cd329d |
|
BLAKE2b-256 | 0a7b3de7e019df40c2df0ac59226096c5f915242159c6d3060582d4214b0fde7 |