zuul
/
zuul
Code Issues Proposed changes

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
This commit is contained in:
Jeremy Stanley 2022-02-09 17:23:00 +00:00
parent 46e6a17692
commit d47001542e
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/operation.rst
View File

@ -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::

3
doc/source/troubleshooting.rst
View File

@ -1,7 +1,8 @@
Troubleshooting
---------------
Some advanced troubleshooting options are provided below. These are
In addition to inspecting :ref:`service debug logs <operation>`, some
advanced troubleshooting options are provided below. These are
generally very low-level and are not normally required.
Thread Dumps and Profiling