From 605e2553b827ee89e8726ac14ae7c482934881bd Mon Sep 17 00:00:00 2001 From: cellarspoon Date: Fri, 31 Dec 2021 12:10:11 +0100 Subject: [PATCH] docs: expand errors docs --- cli/app/errors.go | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/cli/app/errors.go b/cli/app/errors.go index 506fafd5..4a67d82e 100644 --- a/cli/app/errors.go +++ b/cli/app/errors.go @@ -22,11 +22,27 @@ var appErrorsCommand = &cli.Command{ Name: "errors", Usage: "List errors for a deployed app", Description: ` -This command will list errors for a deployed app. This is a best-effort -implementation and an attempt to gather a number of tips & tricks for finding -errors together into one convenient command. When an app is failing to deploy -or having issues, it could be a lot of things. This command is best accompanied -by "abra app logs ". +This command lists errors for a deployed app. + +This is a best-effort implementation and an attempt to gather a number of tips +& tricks for finding errors together into one convenient command. When an app +is failing to deploy or having issues, it could be a lot of things. + +This command currently takes into account: + + Is the service deployed? + Is the service killed by an OOM error? + Is the service reporting an error (like in "ps --no-trunc" output) + Is the service healthcheck failing? what are the healthcheck logs? + +Got any more ideas? Please let us know: + + https://git.coopcloud.tech/coop-cloud/organising/issues/new/choose + +This command is best accompanied by "abra app logs " which may reveal +further information which can help you debug the cause of an app failure via +the logs. + `, Aliases: []string{"e"}, Flags: []cli.Flag{internal.WatchFlag},