openstack/swift
Code Issues Proposed changes

docs: Call out that xprofile is not intended for production

Browse Source 
Change-Id: I1e9d4d5df403040d69db93a08647cd0abe1b8037
(cherry picked from commit a55a48ffc8bdd04a4876a01b92b204302bd62881)
This commit is contained in:
Tim Burke 2024-12-06 14:24:34 -08:00
parent 0236ddaef3
commit 1cc23d54b9
5 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
etc/account-server.conf-sample
View File

@ -295,7 +295,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

3
etc/container-server.conf-sample
View File

@ -337,7 +337,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

3
etc/object-server.conf-sample
View File

@ -687,7 +687,8 @@ use = egg:swift#backend_ratelimit
# ionice_priority =
#
# Note: Put it at the beginning of the pipleline 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

1
etc/proxy-server.conf-sample
View File

@ -1158,6 +1158,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

5
swift/common/middleware/xprofile.py
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