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.18b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ec6464e388d0203991f8e7c2b0663016a7535fad501baa1f36ab07b8a9b996d |
|
MD5 | 61af001120ea49f7adaa356adfc3c326 |
|
BLAKE2b-256 | 34fe2b3ddbbf384e34a0112e3b30fa3606b22773c3d40ba3aa3aafab50f11687 |
Close
Hashes for opentelemetry_instrumentation_fastapi-0.18b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 060b4c54b7a09dbc1d02803b34c13f39a57c2b85d07288076763f25e2a123b82 |
|
MD5 | 941d6748ad59e85292489dead5d05cda |
|
BLAKE2b-256 | edd6432fe27b0f1499b417c247d7e9b9ad09e7581991e4b5101700d007cdfa2f |