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.17b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 561205d29358db0df206a8e08933f739529b2cd73e8e80b9f05c845955416a2c |
|
MD5 | f170ddb257a02e49a07db730f5cc3bdc |
|
BLAKE2b-256 | 24d337aab07451e3689176d3cb95be07d651baa618c195b5c3398e7637514b27 |
Close
Hashes for opentelemetry_instrumentation_fastapi-0.17b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c560ffebff48290e790d29f3977c1ab46871ff8a4f1c4e9cad4df71033e52026 |
|
MD5 | 5e8dc5ec8d01a34a49b6c003c8a32c22 |
|
BLAKE2b-256 | 31dcc0d6bcb07858a7a1ac5396d34e22500bdb9203cef9f68235df083a946560 |