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)
You can also pass the list of urls to exclude explicitly to the instrumentation call:
FastAPIInstrumentor.instrument_app(app, "client/.*/info,healthcheck")
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
Hashes for opentelemetry-instrumentation-fastapi-0.23b2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6629926693ebe922859642e69bdf77e5d40777ef5613155aa6f98548a5f7dfaa |
|
MD5 | fe6248326147779fef2125e371306022 |
|
BLAKE2b-256 | 0d76d7cb620ae7c7b34365608baad94dfb7473061a143dd18768f27e3aa9c17a |
Hashes for opentelemetry_instrumentation_fastapi-0.23b2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 400bc463327266030f341d03e6da0d5f97f456c32175473ba6a4033675430810 |
|
MD5 | 27f22e94525df85cb45b00624b21f509 |
|
BLAKE2b-256 | adc2beed65560760e6d28f3241cd736afcedc4d9bd8372b04dfbfbaf67bb21a6 |