[Issue #224] New flag '--color' for coloring the show plain backup info and console ERROR and WARNING messages

Author: gsmolk

doc/pgprobackup.xml

@@ -3566,7 +3566,7 @@ pg_probackup show-config -B <replaceable>backup_dir</replaceable> --instance <re
       <title>show</title>
       <programlisting>
 pg_probackup show -B <replaceable>backup_dir</replaceable>
-[--help] [--instance <replaceable>instance_name</replaceable> [-i <replaceable>backup_id</replaceable> | --archive]] [--format=plain|json]
+[--help] [--instance <replaceable>instance_name</replaceable> [-i <replaceable>backup_id</replaceable> | --archive]] [--format=plain|json] [--color]
 </programlisting>
       <para>
         Shows the contents of the backup catalog. If
@@ -3581,6 +3581,8 @@ pg_probackup show -B <replaceable>backup_dir</replaceable>
         plain text. You can specify the
         <literal>--format=json</literal> option to get the result
         in the <acronym>JSON</acronym> format.
+        If <literal>--color</literal> flag is used with plain text format,
+        then output is colored.
       </para>
       <para>
         For details on usage, see the sections
@@ -4603,6 +4605,16 @@ pg_probackup archive-get -B <replaceable>backup_dir</replaceable> --instance <re
       </para>
       <para>
       <variablelist>
+
+      <varlistentry>
+<term><option>--color</option></term>
+      <listitem>
+      <para>
+        Color the console log messages of <literal>warning</literal> and <literal>error</literal> levels.
+      </para>
+      </listitem>
+      </varlistentry>
+
       <varlistentry>
 <term><option>--log-level-console=<replaceable>log_level</replaceable></option></term>
       <listitem>

src/backup.c

@@ -843,7 +843,7 @@ do_backup(time_t start_time, pgSetBackupParams *set_backup_params,
 
 	elog(INFO, "Backup start, pg_probackup version: %s, instance: %s, backup ID: %s, backup mode: %s, "
 			"wal mode: %s, remote: %s, compress-algorithm: %s, compress-level: %i",
-			PROGRAM_VERSION, instance_name, base36enc(start_time), pgBackupGetBackupMode(&current),
+			PROGRAM_VERSION, instance_name, base36enc(start_time), pgBackupGetBackupMode(&current, false),
 			current.stream ? "STREAM" : "ARCHIVE", IsSshProtocol()  ? "true" : "false",
 			deparse_compress_alg(current.compress_alg), current.compress_level);
 

src/catalog.c

@@ -331,9 +331,22 @@ lock_backup(pgBackup *backup, bool strict)
  * Get backup_mode in string representation.
  */
 const char *
-pgBackupGetBackupMode(pgBackup *backup)
+pgBackupGetBackupMode(pgBackup *backup, bool show_color)
 {
-	return backupModes[backup->backup_mode];
+	if (show_color)
+	{
+		/* color the Backup mode */
+		char *mode = pgut_malloc(24); /* leaking memory here */
+
+		if (backup->backup_mode == BACKUP_MODE_FULL)
+			snprintf(mode, 24, "%s%s%s", TC_GREEN_BOLD, backupModes[backup->backup_mode], TC_RESET);
+		else
+			snprintf(mode, 24, "%s%s%s", TC_BLUE_BOLD, backupModes[backup->backup_mode], TC_RESET);
+
+		return mode;
+	}
+	else
+		return backupModes[backup->backup_mode];
 }
 
 static bool
@@ -1684,7 +1697,7 @@ pgBackupWriteControl(FILE *out, pgBackup *backup)
 	char		timestamp[100];
 
 	fio_fprintf(out, "#Configuration\n");
-	fio_fprintf(out, "backup-mode = %s\n", pgBackupGetBackupMode(backup));
+	fio_fprintf(out, "backup-mode = %s\n", pgBackupGetBackupMode(backup, false));
 	fio_fprintf(out, "stream = %s\n", backup->stream ? "true" : "false");
 	fio_fprintf(out, "compress-alg = %s\n",
 			deparse_compress_alg(backup->compress_alg));

src/delete.c

@@ -402,7 +402,7 @@ do_retention_internal(parray *backup_list, parray *to_keep_list, parray *to_purg
 		/* TODO: add ancestor(chain full backup) ID */
 		elog(INFO, "Backup %s, mode: %s, status: %s. Redundancy: %i/%i, Time Window: %ud/%ud. %s",
 				base36enc(backup->start_time),
-				pgBackupGetBackupMode(backup),
+				pgBackupGetBackupMode(backup, false),
 				status2str(backup->status),
 				cur_full_backup_num,
 				instance_config.retention_redundancy,

src/help.c

@@ -310,6 +310,7 @@ help_backup(void)
 	printf(_("                                   (example: --note='backup before app update to v13.1')\n"));
 
 	printf(_("\n  Logging options:\n"));
+	printf(_("      --color                      color the error and warning console messages\n"));
 	printf(_("      --log-level-console=log-level-console\n"));
 	printf(_("                                   level for console logging (default: info)\n"));
 	printf(_("                                   available options: 'off', 'error', 'warning', 'info', 'log', 'verbose'\n"));
@@ -470,6 +471,7 @@ help_restore(void)
 	printf(_("  -S, --primary-slot-name=slotname replication slot to be used for WAL streaming from the primary server\n"));
 
 	printf(_("\n  Logging options:\n"));
+	printf(_("      --color                      color the error and warning console messages\n"));
 	printf(_("      --log-level-console=log-level-console\n"));
 	printf(_("                                   level for console logging (default: info)\n"));
 	printf(_("                                   available options: 'off', 'error', 'warning', 'info', 'log', 'verbose'\n"));
@@ -536,6 +538,7 @@ help_validate(void)
 	printf(_("      --skip-block-validation      set to validate only file-level checksum\n"));
 
 	printf(_("\n  Logging options:\n"));
+	printf(_("      --color                      color the error and warning console messages\n"));
 	printf(_("      --log-level-console=log-level-console\n"));
 	printf(_("                                   level for console logging (default: info)\n"));
 	printf(_("                                   available options: 'off', 'error', 'warning', 'info', 'log', 'verbose'\n"));
@@ -580,6 +583,7 @@ help_checkdb(void)
 	printf(_("                                   can be used only with '--amcheck' option\n"));
 
 	printf(_("\n  Logging options:\n"));
+	printf(_("      --color                      color the error and warning console messages\n"));
 	printf(_("      --log-level-console=log-level-console\n"));
 	printf(_("                                   level for console logging (default: info)\n"));
 	printf(_("                                   available options: 'off', 'error', 'warning', 'info', 'log', 'verbose'\n"));
@@ -620,7 +624,8 @@ help_show(void)
 	printf(_("      --instance=instance_name     show info about specific instance\n"));
 	printf(_("  -i, --backup-id=backup-id        show info about specific backups\n"));
 	printf(_("      --archive                    show WAL archive information\n"));
-	printf(_("      --format=format              show format=PLAIN|JSON\n\n"));
+	printf(_("      --format=format              show format=PLAIN|JSON\n"));
+	printf(_("      --color                      color the info for plain format\n\n"));
 }
 
 static void
@@ -655,6 +660,7 @@ help_delete(void)
 	printf(_("      --status=backup_status       delete all backups with specified status\n"));
 
 	printf(_("\n  Logging options:\n"));
+	printf(_("      --color                      color the error and warning console messages\n"));
 	printf(_("      --log-level-console=log-level-console\n"));
 	printf(_("                                   level for console logging (default: info)\n"));
 	printf(_("                                   available options: 'off', 'error', 'warning', 'info', 'log', 'verbose'\n"));
@@ -697,6 +703,7 @@ help_merge(void)
 	printf(_("      --progress                   show progress\n"));
 
 	printf(_("\n  Logging options:\n"));
+	printf(_("      --color                      color the error and warning console messages\n"));
 	printf(_("      --log-level-console=log-level-console\n"));
 	printf(_("                                   level for console logging (default: info)\n"));
 	printf(_("                                   available options: 'off', 'error', 'warning', 'info', 'log', 'verbose'\n"));

src/pg_probackup.c

@@ -67,6 +67,7 @@ char	   *externaldir = NULL;
 static char *backup_id_string = NULL;
 int			num_threads = 1;
 bool		stream_wal = false;
+bool 		show_color = false;
 bool        is_archive_cmd = false;
 pid_t       my_pid = 0;
 __thread int  my_thread_num = 1;
@@ -178,6 +179,7 @@ static ConfigOption cmd_options[] =
 	{ 'b', 132, "progress",			&progress,			SOURCE_CMD_STRICT },
 	{ 's', 'i', "backup-id",		&backup_id_string,	SOURCE_CMD_STRICT },
 	{ 'b', 133, "no-sync",			&no_sync,			SOURCE_CMD_STRICT },
+	{ 'b', 134, "color",			&show_color,		SOURCE_CMD_STRICT },
 	/* backup options */
 	{ 'b', 180, "backup-pg-log",	&backup_logs,		SOURCE_CMD_STRICT },
 	{ 'f', 'b', "backup-mode",		opt_backup_mode,	SOURCE_CMD_STRICT },
@@ -440,6 +442,10 @@ main(int argc, char *argv[])
 
 	pgut_init();
 
+	/* Check terminal presense and initialize ANSI escape codes for Windows */
+	if (show_color)
+		init_console();
+
 	if (help_opt)
 		help_command(command_name);
 

src/pg_probackup.h

@@ -111,6 +111,22 @@ extern const char  *PROGRAM_EMAIL;
 #define XRecOffIsNull(xlrp) \
 		((xlrp) % XLOG_BLCKSZ == 0)
 
+/* Text Coloring macro */
+#define TC_LEN 11
+#define TC_RED "\033[0;31m"
+#define TC_RED_BOLD "\033[1;31m"
+#define TC_BLUE "\033[0;34m"
+#define TC_BLUE_BOLD "\033[1;34m"
+#define TC_GREEN "\033[0;32m"
+#define TC_GREEN_BOLD "\033[1;32m"
+#define TC_YELLOW "\033[0;33m"
+#define TC_YELLOW_BOLD "\033[1;33m"
+#define TC_MAGENTA "\033[0;35m"
+#define TC_MAGENTA_BOLD "\033[1;35m"
+#define TC_CYAN "\033[0;36m"
+#define TC_CYAN_BOLD "\033[1;36m"
+#define TC_RESET "\033[0m"
+
 typedef struct RedoParams
 {
 	TimeLineID  tli;
@@ -715,6 +731,7 @@ extern pid_t    my_pid;
 extern __thread int my_thread_num;
 extern int		num_threads;
 extern bool		stream_wal;
+extern bool		show_color;
 extern bool		progress;
 extern bool     is_archive_cmd; /* true for archive-{get,push} */
 #if PG_VERSION_NUM >= 100000
@@ -866,7 +883,8 @@ extern void write_backup_status(pgBackup *backup, BackupStatus status,
 extern void write_backup_data_bytes(pgBackup *backup);
 extern bool lock_backup(pgBackup *backup, bool strict);
 
-extern const char *pgBackupGetBackupMode(pgBackup *backup);
+extern const char *pgBackupGetBackupMode(pgBackup *backup, bool show_color);
+extern void pgBackupGetBackupModeColor(pgBackup *backup, char *mode);
 
 extern parray *catalog_get_instance_list(void);
 extern parray *catalog_get_backup_list(const char *instance_name, time_t requested_backup_id);
@@ -1076,6 +1094,7 @@ extern void copy_pgcontrol_file(const char *from_fullpath, fio_location from_loc
 
 extern void time2iso(char *buf, size_t len, time_t time);
 extern const char *status2str(BackupStatus status);
+const char *status2str_color(BackupStatus status);
 extern BackupStatus str2status(const char *status);
 extern const char *base36enc(long unsigned int value);
 extern char *base36enc_dup(long unsigned int value);

src/show.c

@@ -321,7 +321,7 @@ print_backup_json_object(PQExpBuffer buf, pgBackup *backup)
 		json_add_value(buf, "parent-backup-id",
 						base36enc(backup->parent_backup), json_level, true);
 
-	json_add_value(buf, "backup-mode", pgBackupGetBackupMode(backup),
+	json_add_value(buf, "backup-mode", pgBackupGetBackupMode(backup, false),
 					json_level, true);
 
 	json_add_value(buf, "wal", backup->stream ? "STREAM": "ARCHIVE",
@@ -554,8 +554,8 @@ show_instance_plain(const char *instance_name, parray *backup_list, bool show_na
 		cur++;
 
 		/* Mode */
-		row->mode = pgBackupGetBackupMode(backup);
-		widths[cur] = Max(widths[cur], strlen(row->mode));
+		row->mode = pgBackupGetBackupMode(backup, show_color);
+		widths[cur] = Max(widths[cur], strlen(row->mode) - (show_color ? TC_LEN : 0));
 		cur++;
 
 		/* WAL mode*/
@@ -628,8 +628,9 @@ show_instance_plain(const char *instance_name, parray *backup_list, bool show_na
 		cur++;
 
 		/* Status */
-		row->status = status2str(backup->status);
-		widths[cur] = Max(widths[cur], strlen(row->status));
+		row->status = show_color ? status2str_color(backup->status) : status2str(backup->status);
+		widths[cur] = Max(widths[cur], strlen(row->status) - (show_color ? TC_LEN : 0));
+
 	}
 
 	for (i = 0; i < SHOW_FIELDS_COUNT; i++)
@@ -679,7 +680,7 @@ show_instance_plain(const char *instance_name, parray *backup_list, bool show_na
 						  row->recovery_time);
 		cur++;
 
-		appendPQExpBuffer(&show_buf, field_formats[cur], widths[cur],
+		appendPQExpBuffer(&show_buf, field_formats[cur], widths[cur] + (show_color ? TC_LEN : 0),
 						  row->mode);
 		cur++;
 
@@ -715,7 +716,7 @@ show_instance_plain(const char *instance_name, parray *backup_list, bool show_na
 						  row->stop_lsn);
 		cur++;
 
-		appendPQExpBuffer(&show_buf, field_formats[cur], widths[cur],
+		appendPQExpBuffer(&show_buf, field_formats[cur], widths[cur] + (show_color ? TC_LEN : 0),
 						  row->status);
 		cur++;
 

src/util.c

@@ -516,6 +516,29 @@ status2str(BackupStatus status)
 	return statusName[status];
 }
 
+const char *
+status2str_color(BackupStatus status)
+{
+	char *status_str = pgut_malloc(20);
+
+	/* UNKNOWN */
+	if (status == BACKUP_STATUS_INVALID)
+		snprintf(status_str, 20, "%s%s%s", TC_YELLOW_BOLD, "UNKNOWN", TC_RESET);
+	/* CORRUPT, ERROR and ORPHAN */
+	else if (status == BACKUP_STATUS_CORRUPT || status == BACKUP_STATUS_ERROR ||
+			 status == BACKUP_STATUS_ORPHAN)
+		snprintf(status_str, 20, "%s%s%s", TC_RED_BOLD, statusName[status], TC_RESET);
+	/* MERGING, MERGED, DELETING and DELETED */
+	else if (status == BACKUP_STATUS_MERGING || status == BACKUP_STATUS_MERGED ||
+			 status == BACKUP_STATUS_DELETING || status == BACKUP_STATUS_DELETED)
+		snprintf(status_str, 20, "%s%s%s", TC_YELLOW_BOLD, statusName[status], TC_RESET);
+	/* OK and DONE */
+	else
+		snprintf(status_str, 20, "%s%s%s", TC_GREEN_BOLD, statusName[status], TC_RESET);
+
+	return status_str;
+}
+
 BackupStatus
 str2status(const char *status)
 {