Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Improve troubleshooting overview intro.

This commit is contained in:
Tim Abbott 2023-06-12 12:30:28 -07:00
parent 582e88544c
commit 6ca5130cd8
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/production/troubleshooting.md
View File

@ -29,6 +29,15 @@ core engineering team.
## Overview and resources ## 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 Zulip uses [Supervisor](http://supervisord.org/index.html) to monitor
and control its many Python services. Read the next section, [Using and control its many Python services. Read the next section, [Using
supervisorctl](#using-supervisorctl), to learn how to use the 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 [Components](../overview/architecture-overview.md#components) section. This will help you
understand the many services Zulip uses. 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) The section [troubleshooting services](#troubleshooting-services)
on this page includes details about how to fix common issues with Zulip 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 ## Using supervisorctl
To see what Zulip-related services are configured to To see what Zulip-related services are configured to