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.20b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6810973986b7397524244cbab3d1af994e59a9f0634ddb01fdd2b9d3bc397ec0 |
|
MD5 | c66f3a1c67b5b38f8cf5bb4c09528d53 |
|
BLAKE2b-256 | 8489480b6c9c7244bae250370cbe68c2c99bbc003493afe566633fcb01ffec9a |
Close
Hashes for opentelemetry_instrumentation_fastapi-0.20b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 24c7aeaa2f92ddf37803135005ec49a4937dece7bfaa8e83bc145246a8d7d496 |
|
MD5 | d8be73280b8a9411f65e0cea52ef8a0d |
|
BLAKE2b-256 | e82c27e1b6ae93f0d3815bb00a1b361647bcf29a7f198bb6e8a451e0486aae47 |