Skip to content

Commit 09236c6

Browse files
author
Oleg Gurev
committed
[PBCKP-874] Addeded "Logging options" section to help.c for
- add-instance - archive-push - archive-get - catchup commands
1 parent 58752c5 commit 09236c6

File tree

1 file changed

+96
-0
lines changed

1 file changed

+96
-0
lines changed

Diff for: ‎src/help.c

+96
Original file line numberDiff line numberDiff line change
@@ -983,6 +983,30 @@ help_add_instance(void)
983983
printf(_(" --remote-user=username user name for ssh connection (default: current user)\n"));
984984
printf(_(" --ssh-options=ssh_options additional ssh options (default: none)\n"));
985985
printf(_(" (example: --ssh-options='-c cipher_spec -F configfile')\n\n"));
986+
987+
printf(_("\n Logging options:\n"));
988+
printf(_(" --log-level-console=log-level-console\n"));
989+
printf(_(" level for console logging (default: info)\n"));
990+
printf(_(" available options: 'off', 'error', 'warning', 'info', 'log', 'verbose'\n"));
991+
printf(_(" --log-level-file=log-level-file\n"));
992+
printf(_(" level for file logging (default: off)\n"));
993+
printf(_(" available options: 'off', 'error', 'warning', 'info', 'log', 'verbose'\n"));
994+
printf(_(" --log-format-file=log-format-file\n"));
995+
printf(_(" defines the format of log files (default: plain)\n"));
996+
printf(_(" available options: 'plain', 'json'\n"));
997+
printf(_(" --log-filename=log-filename\n"));
998+
printf(_(" filename for file logging (default: 'pg_probackup.log')\n"));
999+
printf(_(" support strftime format (example: pg_probackup-%%Y-%%m-%%d_%%H%%M%%S.log)\n"));
1000+
printf(_(" --error-log-filename=error-log-filename\n"));
1001+
printf(_(" filename for error logging (default: none)\n"));
1002+
printf(_(" --log-directory=log-directory\n"));
1003+
printf(_(" directory for file logging (default: BACKUP_PATH/log)\n"));
1004+
printf(_(" --log-rotation-size=log-rotation-size\n"));
1005+
printf(_(" rotate logfile if its size exceeds this value; 0 disables; (default: 0)\n"));
1006+
printf(_(" available units: 'kB', 'MB', 'GB', 'TB' (default: kB)\n"));
1007+
printf(_(" --log-rotation-age=log-rotation-age\n"));
1008+
printf(_(" rotate logfile if its age exceeds this value; 0 disables; (default: 0)\n"));
1009+
printf(_(" available units: 'ms', 's', 'min', 'h', 'd' (default: min)\n"));
9861010
}
9871011

9881012
static void
@@ -1030,6 +1054,30 @@ help_archive_push(void)
10301054
printf(_(" --compress-level=compress-level\n"));
10311055
printf(_(" level of compression [0-9] (default: 1)\n"));
10321056

1057+
printf(_("\n Logging options:\n"));
1058+
printf(_(" --log-level-console=log-level-console\n"));
1059+
printf(_(" level for console logging (default: info)\n"));
1060+
printf(_(" available options: 'off', 'error', 'warning', 'info', 'log', 'verbose'\n"));
1061+
printf(_(" --log-level-file=log-level-file\n"));
1062+
printf(_(" level for file logging (default: off)\n"));
1063+
printf(_(" available options: 'off', 'error', 'warning', 'info', 'log', 'verbose'\n"));
1064+
printf(_(" --log-format-file=log-format-file\n"));
1065+
printf(_(" defines the format of log files (default: plain)\n"));
1066+
printf(_(" available options: 'plain', 'json'\n"));
1067+
printf(_(" --log-filename=log-filename\n"));
1068+
printf(_(" filename for file logging (default: 'pg_probackup.log')\n"));
1069+
printf(_(" support strftime format (example: pg_probackup-%%Y-%%m-%%d_%%H%%M%%S.log)\n"));
1070+
printf(_(" --error-log-filename=error-log-filename\n"));
1071+
printf(_(" filename for error logging (default: none)\n"));
1072+
printf(_(" --log-directory=log-directory\n"));
1073+
printf(_(" directory for file logging (default: BACKUP_PATH/log)\n"));
1074+
printf(_(" --log-rotation-size=log-rotation-size\n"));
1075+
printf(_(" rotate logfile if its size exceeds this value; 0 disables; (default: 0)\n"));
1076+
printf(_(" available units: 'kB', 'MB', 'GB', 'TB' (default: kB)\n"));
1077+
printf(_(" --log-rotation-age=log-rotation-age\n"));
1078+
printf(_(" rotate logfile if its age exceeds this value; 0 disables; (default: 0)\n"));
1079+
printf(_(" available units: 'ms', 's', 'min', 'h', 'd' (default: min)\n"));
1080+
10331081
printf(_("\n Remote options:\n"));
10341082
printf(_(" --remote-proto=protocol remote protocol to use\n"));
10351083
printf(_(" available options: 'ssh', 'none' (default: ssh)\n"));
@@ -1065,6 +1113,30 @@ help_archive_get(void)
10651113
printf(_(" --prefetch-dir=path location of the store area for prefetched WAL files\n"));
10661114
printf(_(" --no-validate-wal skip validation of prefetched WAL file before using it\n"));
10671115

1116+
printf(_("\n Logging options:\n"));
1117+
printf(_(" --log-level-console=log-level-console\n"));
1118+
printf(_(" level for console logging (default: info)\n"));
1119+
printf(_(" available options: 'off', 'error', 'warning', 'info', 'log', 'verbose'\n"));
1120+
printf(_(" --log-level-file=log-level-file\n"));
1121+
printf(_(" level for file logging (default: off)\n"));
1122+
printf(_(" available options: 'off', 'error', 'warning', 'info', 'log', 'verbose'\n"));
1123+
printf(_(" --log-format-file=log-format-file\n"));
1124+
printf(_(" defines the format of log files (default: plain)\n"));
1125+
printf(_(" available options: 'plain', 'json'\n"));
1126+
printf(_(" --log-filename=log-filename\n"));
1127+
printf(_(" filename for file logging (default: 'pg_probackup.log')\n"));
1128+
printf(_(" support strftime format (example: pg_probackup-%%Y-%%m-%%d_%%H%%M%%S.log)\n"));
1129+
printf(_(" --error-log-filename=error-log-filename\n"));
1130+
printf(_(" filename for error logging (default: none)\n"));
1131+
printf(_(" --log-directory=log-directory\n"));
1132+
printf(_(" directory for file logging (default: BACKUP_PATH/log)\n"));
1133+
printf(_(" --log-rotation-size=log-rotation-size\n"));
1134+
printf(_(" rotate logfile if its size exceeds this value; 0 disables; (default: 0)\n"));
1135+
printf(_(" available units: 'kB', 'MB', 'GB', 'TB' (default: kB)\n"));
1136+
printf(_(" --log-rotation-age=log-rotation-age\n"));
1137+
printf(_(" rotate logfile if its age exceeds this value; 0 disables; (default: 0)\n"));
1138+
printf(_(" available units: 'ms', 's', 'min', 'h', 'd' (default: min)\n"));
1139+
10681140
printf(_("\n Remote options:\n"));
10691141
printf(_(" --remote-proto=protocol remote protocol to use\n"));
10701142
printf(_(" available options: 'ssh', 'none' (default: ssh)\n"));
@@ -1131,6 +1203,30 @@ help_catchup(void)
11311203
printf(_(" -w, --no-password never prompt for password\n"));
11321204
printf(_(" -W, --password force password prompt\n\n"));
11331205

1206+
printf(_("\n Logging options:\n"));
1207+
printf(_(" --log-level-console=log-level-console\n"));
1208+
printf(_(" level for console logging (default: info)\n"));
1209+
printf(_(" available options: 'off', 'error', 'warning', 'info', 'log', 'verbose'\n"));
1210+
printf(_(" --log-level-file=log-level-file\n"));
1211+
printf(_(" level for file logging (default: off)\n"));
1212+
printf(_(" available options: 'off', 'error', 'warning', 'info', 'log', 'verbose'\n"));
1213+
printf(_(" --log-format-file=log-format-file\n"));
1214+
printf(_(" defines the format of log files (default: plain)\n"));
1215+
printf(_(" available options: 'plain', 'json'\n"));
1216+
printf(_(" --log-filename=log-filename\n"));
1217+
printf(_(" filename for file logging (default: 'pg_probackup.log')\n"));
1218+
printf(_(" support strftime format (example: pg_probackup-%%Y-%%m-%%d_%%H%%M%%S.log)\n"));
1219+
printf(_(" --error-log-filename=error-log-filename\n"));
1220+
printf(_(" filename for error logging (default: none)\n"));
1221+
printf(_(" --log-directory=log-directory\n"));
1222+
printf(_(" directory for file logging (default: BACKUP_PATH/log)\n"));
1223+
printf(_(" --log-rotation-size=log-rotation-size\n"));
1224+
printf(_(" rotate logfile if its size exceeds this value; 0 disables; (default: 0)\n"));
1225+
printf(_(" available units: 'kB', 'MB', 'GB', 'TB' (default: kB)\n"));
1226+
printf(_(" --log-rotation-age=log-rotation-age\n"));
1227+
printf(_(" rotate logfile if its age exceeds this value; 0 disables; (default: 0)\n"));
1228+
printf(_(" available units: 'ms', 's', 'min', 'h', 'd' (default: min)\n"));
1229+
11341230
printf(_("\n Remote options:\n"));
11351231
printf(_(" --remote-proto=protocol remote protocol to use\n"));
11361232
printf(_(" available options: 'ssh', 'none' (default: ssh)\n"));

0 commit comments

Comments
 (0)