summaryrefslogtreecommitdiff
path: root/doc/source/admin_guide.rst
diff options
context:
space:
mode:
authorSamuel Merritt <sam@swiftstack.com>2015-01-11 13:41:35 -0800
committerSamuel Merritt <sam@swiftstack.com>2015-03-30 17:47:28 -0700
commit8d3b3b2ee0a86b37b6ad1f4d201bfaa0103af07d (patch)
treee9658bb56802a0e136601cf097977e187aa469a5 /doc/source/admin_guide.rst
parentcf21db4bc68aff190c55d416b406a44bf204ba36 (diff)
downloadswift-8d3b3b2ee0a86b37b6ad1f4d201bfaa0103af07d.tar.gz
Add some debug output to the ring builder
Sometimes, I get handed a builder file in a support ticket and a question of the form "why is the balance [not] doing $thing?". When that happens, I add a bunch of print statements to my local swift/common/ring/builder.py, figure things out, and then delete the print statements. This time, instead of deleting the print statements, I turned them into debug() calls and added a "--debug" flag to the rebalance command in hopes that someone else will find it useful. Change-Id: I697af90984fa5b314ddf570280b4585ba0ba363c
Diffstat (limited to 'doc/source/admin_guide.rst')
-rw-r--r--doc/source/admin_guide.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/source/admin_guide.rst b/doc/source/admin_guide.rst
index d96353c84..5b7a02850 100644
--- a/doc/source/admin_guide.rst
+++ b/doc/source/admin_guide.rst
@@ -88,6 +88,16 @@ attempting to write to or read the builder/ring files while operations are in
progress. This can be useful in environments where ring management has been
automated but the operator still needs to interact with the rings manually.
+If the ring builder is not producing the balances that you are
+expecting, you can gain visibility into what it's doing with the
+``--debug`` flag.::
+
+ swift-ring-builder <builder-file> rebalance --debug
+
+This produces a great deal of output that is mostly useful if you are
+either (a) attempting to fix the ring builder, or (b) filing a bug
+against the ring builder.
+
-----------------------
Scripting Ring Creation
-----------------------