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, excluded_urls="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.25b2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34b97e4eeadbcf4a05f1a63eeea4153d36addc0e1b8b15b9a510b31b57dddea2 |
|
MD5 | 817c33e2d313bcfbe37e6aac7a3f2d97 |
|
BLAKE2b-256 | cc6895e25048d96a45ffb01079618da96adb1e8487b0999ff4870deb9b9ed3da |
Hashes for opentelemetry_instrumentation_fastapi-0.25b2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 366ac76b178cf51aa4f5a925de99a122d3dfa7113811b098775edb06cfc1876d |
|
MD5 | 7733d57c0b6cbbf7759af0269200f7e5 |
|
BLAKE2b-256 | 98335e7db47083df17e297c8b073badf6ae9af8f8f1f79356d8b0b69985c5289 |