Skip to main content

A FastAPI Middleware with cProfile to stats your service performance.

Project description

fastapi-cprofile

A FastAPI Middleware with cProfile to help stats your service performance. cProfile is a built-in python module that can perform profiling. It is the most commonly used profiler currently.

Features

  • support custom cprofile param

#Installation

$ pip install fastapi-cprofile

Code Sample

from fastapi_cprofile.profiler import CProfileMiddleware

app = FastAPI()
app.add_middleware(CProfileMiddleware)

add cprofile options

from fastapi_cprofile.profiler import CProfileMiddleware
app = FastAPI()
app.add_middleware(CProfileMiddleware, enable=True, print_each_request = True, strip_dirs = False, sort_by='cumulative')

or dump out file while shutdown your app then you can use gprof2dot gprof2dot to view it.

from fastapi_cprofile.profiler import CProfileMiddleware
app = FastAPI()
app.add_middleware(CProfileMiddleware, enable=True, server_app = app, filename='/tmp/output.pstats', strip_dirs = False, sort_by='cumulative')

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastapi_cprofile-0.0.2.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

fastapi_cprofile-0.0.2-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_cprofile-0.0.2.tar.gz.

File metadata

  • Download URL: fastapi_cprofile-0.0.2.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0.post20201207 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.8.5

File hashes

Hashes for fastapi_cprofile-0.0.2.tar.gz
Algorithm Hash digest
SHA256 af929b6c48add45b36c68a22efc1b699f86317e7d3d52623d52589228a764d5e
MD5 ee59bb9f9f8175de9ab69f4cf6b40a15
BLAKE2b-256 0d7734a599a7093a877b944871acbdaf6d20a76a62e2e58bddefad8041d4a86a

See more details on using hashes here.

File details

Details for the file fastapi_cprofile-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: fastapi_cprofile-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0.post20201207 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.8.5

File hashes

Hashes for fastapi_cprofile-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 dc2709c54a9503915d7f1fa9a81c38c9405762440421a22d131d78c3461cdb08
MD5 8197bff8394836631835fff64ff25657
BLAKE2b-256 e4bdeae21674702e5e4bd942798c5020139e59c299265a27061b318c1ee14d9a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page