feat: add a subcommand for retrieving failed app deploy logs

This can be useful in cases where a developer wishes to see what error messages are available for a failed deploy, but does not wish to spelunk around `docker ps -a` output.

Note that the logs are not made available once a further deploy is triggered, or after the containers have been garbage collected.

plugins/logs/commands

@@ -1,27 +1,11 @@
 #!/usr/bin/env bash
 [[ " help logs:help " == *" $1 "* ]] || exit "$DOKKU_NOT_IMPLEMENTED_EXIT"
+source "$PLUGIN_AVAILABLE_PATH/logs/internal-functions"
 set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 
-usage() {
-  declare desc="logs specific usage"
-  echo "Usage: dokku logs <app>"
-  echo " display recent log output"
-  echo ""
-  echo " -n, --num NUM        # the number of lines to display"
-  echo " -p, --ps PS          # only display logs from the given process"
-  echo " -t, --tail           # continually stream logs"
-  echo " -q, --quiet          # display raw logs without colors, time and names"
-}
-
 case "$1" in
-  logs:help)
-    usage
-    ;;
-
-  help)
-    cat<<EOF
-    logs <app> [-h] [-t] [-n num] [-q] [-p process], Show the last logs for an application
-EOF
+  help | logs:help)
+    cmd-logs-help "$@"
     ;;
 
   *)

plugins/logs/internal-functions

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+fn-logs-usage() {
+  declare desc="logs specific usage"
+  echo "Usage: dokku logs <app>"
+  echo " display recent log output"
+  echo ""
+  echo " -n, --num NUM        # the number of lines to display"
+  echo " -p, --ps PS          # only display logs from the given process"
+  echo " -t, --tail           # continually stream logs"
+  echo " -q, --quiet          # display raw logs without colors, time and names"
+}
+
+fn-logs-help-content() {
+  declare desc="return logs plugin help content"
+  cat<<help_content
+    logs <app> [-h] [-t] [-n num] [-q] [-p process], Display recent log output
+    logs:failed <app>, Show the last logs for an application
+help_content
+}
+
+cmd-logs-help() {
+  if [[ $1 = "logs:help" ]] ; then
+    echo -e 'Usage: dokku logs[:COMMAND]'
+    echo ''
+    echo 'Output app logs'
+    echo ''
+    echo 'Additional commands:'
+    fn-logs-help-content | sort | column -c2 -t -s,
+  elif [[ $(ps -o command= $PPID) == *"--all"* ]]; then
+    fn-logs-help-content
+  else
+    cat<<help_desc
+    logs, Output app logs
+help_desc
+  fi
+}

plugins/logs/subcommands/default

@@ -1,24 +1,22 @@
 #!/usr/bin/env bash
 set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+source "$PLUGIN_AVAILABLE_PATH/logs/internal-functions"
 
 logs_default_cmd() {
-  declare desc="shows the last logs for an app via command line"
+  declare desc="display recent log output"
   local cmd="logs"
   [[ -z $2 ]] && dokku_log_fail "Please specify an app to run the command on"
   local APP="$2"; verify_app_name "$2"
   local APP_ROOT="$DOKKU_ROOT/$APP"
   local COLORS=(36 33 32 35 31)
 
-  if ! (is_deployed "$APP"); then
-    echo "Application's container not found"
-    exit 1
-  fi
+  ! (is_deployed "$APP") && dokku_log_fail "App $APP has not been deployed"
 
   shift 2;
   local TEMP=$(getopt -o htqn:p: --long help,tail,quiet,num:,ps: -n 'dokku logs' -- "$@")
   local EXIT_CODE="$?"
-  if [[ "$EXIT_CODE" != 0 ]]; then usage >&2 ; exit 1 ; fi
+  if [[ "$EXIT_CODE" != 0 ]]; then fn-logs-usage >&2 ; exit 1 ; fi
   eval set -- "$TEMP"
 
   local DOKKU_LOGS_LINE_NUMBERS="100"
@@ -29,7 +27,7 @@ logs_default_cmd() {
           -p|--ps) local DOKKU_LOGS_ONLY_PROCESS="$2"; shift 2 ;;
           -q|--quiet) local DOKKU_LOGS_NO_PRETTY_PRINT="true"; shift ;;
           --) shift; break ;;
-          *) echo "Internal error"; exit 1;;
+          *) dokku_log_fail "Internal error";;
       esac
   done
 

plugins/logs/subcommands/failed

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+source "$PLUGIN_AVAILABLE_PATH/config/functions"
+
+cmd-logs-failed() {
+  declare desc="shows the last failed deploy logs for an app"
+  declare cmd="logs:failed" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  declare APP="$1"
+  local DOKKU_SCHEDULER
+  [[ -z "$APP" ]] && dokku_log_fail "Please specify an app to run the command on"
+
+  DOKKU_SCHEDULER=$(config_get "$APP" DOKKU_SCHEDULER || echo "docker-local")
+  plugn trigger scheduler-failed "$DOKKU_SCHEDULER" "$APP"
+}
+
+cmd-logs-failed "$@"