From 6ca5130cd8939d25e5f9b77b30484c98bb4944b7 Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Mon, 12 Jun 2023 12:30:28 -0700 Subject: [PATCH] docs: Improve troubleshooting overview intro. --- docs/production/troubleshooting.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/production/troubleshooting.md b/docs/production/troubleshooting.md index 0dc5a1591d..ca7fce3ea9 100644 --- a/docs/production/troubleshooting.md +++ b/docs/production/troubleshooting.md @@ -29,6 +29,15 @@ core engineering team. ## Overview and resources +If you encounter issues while self-hosting Zulip, the first thing to +do is look at Zulip's logs, which are located in `/var/log/zulip/`. + +That directory contains one log file for each service, plus +`errors.log` (has all errors and the first place you should check), +`server.log` (has logs from the Django and Tornado servers), and +`workers.log` (has combined logs from the queue workers). Zulip also +provides a [tool to search through `server.log`][log-search]. + Zulip uses [Supervisor](http://supervisord.org/index.html) to monitor and control its many Python services. Read the next section, [Using supervisorctl](#using-supervisorctl), to learn how to use the @@ -39,18 +48,11 @@ overview](../overview/architecture-overview.md), particularly the [Components](../overview/architecture-overview.md#components) section. This will help you understand the many services Zulip uses. -If you encounter issues while running Zulip, take a look at Zulip's -logs, which are located in `/var/log/zulip/`. That directory contains -one log file for each service, plus `errors.log` (has all errors), -`server.log` (has logs from the Django and Tornado servers), and -`workers.log` (has combined logs from the queue workers). Zulip also -provides a [tool to search through `server.log`][log-search]. - -[log-search]: ../subsystems/logging.md#searching-backend-log-files - The section [troubleshooting services](#troubleshooting-services) on this page includes details about how to fix common issues with Zulip services. +[log-search]: ../subsystems/logging.md#searching-backend-log-files + ## Using supervisorctl To see what Zulip-related services are configured to