From d47001542ea602e7f3aed85936b6225419aa6fb7 Mon Sep 17 00:00:00 2001 From: Jeremy Stanley Date: Wed, 9 Feb 2022 17:23:00 +0000 Subject: [PATCH] Better document service command-line switches Improve the command-line option info at the start of the Operation page to be a bit more verbose about -f in order to make it easier to keyword search for, and include information on -d as well. Also link to this from the Troubleshooting page, since increasing log detail is likely to be one of the first steps before using the lower-level tools mentioned there. Change-Id: I369215df64a2dae22baa65cd010baaa3ec0b2c30 --- doc/source/operation.rst | 8 ++++++-- doc/source/troubleshooting.rst | 3 ++- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/doc/source/operation.rst b/doc/source/operation.rst index 7debecaad5..5e13a51c54 100644 --- a/doc/source/operation.rst +++ b/doc/source/operation.rst @@ -1,11 +1,15 @@ :title: Operation +.. _operation: + Operation ========= You can run any zuul process with the **-f** option to make it not -daemonize. It's a good idea at first to confirm there's no issues with -your configuration. +daemonize and stay in the foreground, logging to your terminal. It's a +good idea at first to check for issues with your configuration. +There's also a **-d** option to engage verbose debug logging, but be +careful in busy deployments as this can generate very large logs. To start, simply run:: diff --git a/doc/source/troubleshooting.rst b/doc/source/troubleshooting.rst index ed72c0d768..5d06fa1979 100644 --- a/doc/source/troubleshooting.rst +++ b/doc/source/troubleshooting.rst @@ -1,7 +1,8 @@ Troubleshooting --------------- -Some advanced troubleshooting options are provided below. These are +In addition to inspecting :ref:`service debug logs `, some +advanced troubleshooting options are provided below. These are generally very low-level and are not normally required. Thread Dumps and Profiling