From dcbfec919ba27da970849cae73c69cacd78432d5 Mon Sep 17 00:00:00 2001
From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Date: Thu, 27 May 2021 10:35:06 +0100
Subject: [PATCH] Improve the error message printed by synctl when synapse
fails to start. (#10059)
---
changelog.d/10059.misc | 1 +
synctl | 12 ++++++++----
2 files changed, 9 insertions(+), 4 deletions(-)
create mode 100644 changelog.d/10059.misc
diff --git a/changelog.d/10059.misc b/changelog.d/10059.misc
new file mode 100644
index 0000000000..ca6e0e8a5a
--- /dev/null
+++ b/changelog.d/10059.misc
@@ -0,0 +1 @@
+Improve the error message printed by synctl when synapse fails to start.
diff --git a/synctl b/synctl
index 6ce19918d2..90559ded62 100755
--- a/synctl
+++ b/synctl
@@ -97,11 +97,15 @@ def start(pidfile: str, app: str, config_files: Iterable[str], daemonize: bool)
write("started %s(%s)" % (app, ",".join(config_files)), colour=GREEN)
return True
except subprocess.CalledProcessError as e:
- write(
- "error starting %s(%s) (exit code: %d); see above for logs"
- % (app, ",".join(config_files), e.returncode),
- colour=RED,
+ err = "%s(%s) failed to start (exit code: %d). Check the Synapse logfile" % (
+ app,
+ ",".join(config_files),
+ e.returncode,
)
+ if daemonize:
+ err += ", or run synctl with --no-daemonize"
+ err += "."
+ write(err, colour=RED, stream=sys.stderr)
return False
--
GitLab