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.23b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10615506d3bd43957d68154ac2144133df3431e1a2cd6fb35bef8577240173ec |
|
MD5 | ab22d98232438544447855e36dfc9a5f |
|
BLAKE2b-256 | c573d4519d939c39eb1d1b2056a888a46c61d2aeb5e5cc23f3c967eb36415e19 |
Hashes for opentelemetry_instrumentation_fastapi-0.23b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5bf0f951ab154434437e5e08b6407ce9abcd06e861bb254fc3335db6d8fb4bfd |
|
MD5 | 3383d61c2b52cc10c775faa18cea9835 |
|
BLAKE2b-256 | 418d47ba6c432630fa6ad925d99ac618358b24fc23a42019785af75dc58a9fdd |