docs: Call out that xprofile is not intended for production

Change-Id: I1e9d4d5df403040d69db93a08647cd0abe1b8037
(cherry picked from commit a55a48ffc8bdd04a4876a01b92b204302bd62881)
This commit is contained in:
Tim Burke 2024-12-06 14:24:34 -08:00
parent cc891359c5
commit 1534385bcc
5 changed files with 13 additions and 4 deletions

View File

@ -297,7 +297,8 @@ use = egg:swift#backend_ratelimit
# ionice_priority =
# Note: Put it at the beginning of the pipeline to profile all middleware. But
# it is safer to put this after healthcheck.
# it is safer to put this after healthcheck. Not intended for production
# environments!
[filter:xprofile]
use = egg:swift#xprofile
# This option enable you to switch profilers which should inherit from python

View File

@ -339,7 +339,8 @@ use = egg:swift#backend_ratelimit
# ionice_priority =
# Note: Put it at the beginning of the pipeline to profile all middleware. But
# it is safer to put this after healthcheck.
# it is safer to put this after healthcheck. Not intended for production
# environments!
[filter:xprofile]
use = egg:swift#xprofile
# This option enable you to switch profilers which should inherit from python

View File

@ -716,10 +716,11 @@ use = egg:swift#backend_ratelimit
# N.B. By default no delay_reaping value is configured for any accounts or
# containers.
# Note: Put it at the beginning of the pipleline to profile all middleware. But
# it is safer to put this after healthcheck. Not intended for production
# environments!
[filter:xprofile]
use = egg:swift#xprofile
# Note: Put it at the beginning of the pipleline to profile all middleware. But
# it is safer to put this after healthcheck.
# This option enable you to switch profilers which should inherit from python
# standard profiler. Currently the supported value can be 'cProfile',
# 'eventlet.green.profile' etc.

View File

@ -1169,6 +1169,7 @@ use = egg:swift#container_sync
# Note: Put it at the beginning of the pipeline to profile all middleware. But
# it is safer to put this after catch_errors, gatekeeper and healthcheck.
# Not intended for production environments!
[filter:xprofile]
use = egg:swift#xprofile
# This option enable you to switch profilers which should inherit from python

View File

@ -16,6 +16,11 @@
"""
Profiling middleware for Swift Servers.
.. note::
This middleware is intended for development and testing environments only,
not production. No authentication is expected or required for the web UI,
and profiling may incur noticeable performance penalties.
The current implementation is based on eventlet aware profiler.(For the
future, more profilers could be added in to collect more data for analysis.)
Profiling all incoming requests and accumulating cpu timing statistics