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.22b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7600bcffd33fa1f4a00c4967cb2da4bd005a84fcc7ec0ac352fd374e27a13d7 |
|
MD5 | 36fa97b1bedfbcd3491abe6cc1e616b1 |
|
BLAKE2b-256 | bb84a983a65c65ed76739d6fb0aa5dc6ce8019adbadc69fe547a2af7713f469f |
Close
Hashes for opentelemetry_instrumentation_fastapi-0.22b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 761c85649f6e249c432bbff798d2f4d84448a71c56cd14a24e4b05fb4c410bfc |
|
MD5 | f69e46f8f60d5676144e83f967d5834a |
|
BLAKE2b-256 | 43c74680f5c2ccce134d6d6ac0f1e4fe8db53a910666e82918c7edf61f3ff759 |