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.21b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40a09fbba37d90e37c4eebefeb055e92c035bd58cf99a46306581ccced0123d1 |
|
MD5 | c965b809c9334e265f968481ea1b634a |
|
BLAKE2b-256 | 3287ebe642e5fbfa1f6d6e8824d56b9ec543ef061f2b5d36f43f3bbbb27679bb |
Close
Hashes for opentelemetry_instrumentation_fastapi-0.21b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4dcf51c38849e65a3d20e65a1566ae589cd63bac326b6814b5d68b0aa38ed558 |
|
MD5 | 31a35f223e9c631e9be0fc5dc12f8bca |
|
BLAKE2b-256 | c2240cfd00fe616275540e39c2b8dfb0cff726d560067c5ff2d0c0443b7cec0f |