mirror of
https://github.com/EnterpriseDB/repmgr.git
synced 2026-03-25 16:16:29 +00:00
Add logging and repmgr command sanity checks
This commit is contained in:
Ian Barwick
370
log.c
Normal file
370
log.c
Normal file
@@ -0,0 +1,370 @@
|
||||
/*
|
||||
* log.c - Logging methods
|
||||
* Copyright (c) 2ndQuadrant, 2010-2017
|
||||
*/
|
||||
|
||||
#include "repmgr.h"
|
||||
|
||||
#include <stdlib.h>
|
||||
|
||||
#ifdef HAVE_SYSLOG
|
||||
#include <syslog.h>
|
||||
#endif
|
||||
|
||||
#include <stdarg.h>
|
||||
#include <time.h>
|
||||
|
||||
#include "log.h"
|
||||
|
||||
#define DEFAULT_IDENT "repmgr"
|
||||
#ifdef HAVE_SYSLOG
|
||||
#define DEFAULT_SYSLOG_FACILITY LOG_LOCAL0
|
||||
#endif
|
||||
|
||||
/* #define REPMGR_DEBUG */
|
||||
|
||||
static int detect_log_facility(const char *facility);
|
||||
static void _stderr_log_with_level(const char *level_name, int level, const char *fmt, va_list ap)
|
||||
__attribute__((format(PG_PRINTF_ATTRIBUTE, 3, 0)));
|
||||
|
||||
int log_type = REPMGR_STDERR;
|
||||
int log_level = LOG_NOTICE;
|
||||
int last_log_level = LOG_NOTICE;
|
||||
int verbose_logging = false;
|
||||
int terse_logging = false;
|
||||
/*
|
||||
* Global variable to be set by the main application to ensure any log output
|
||||
* emitted before logger_init is called, is output in the correct format
|
||||
*/
|
||||
int logger_output_mode = OM_DAEMON;
|
||||
|
||||
extern void
|
||||
stderr_log_with_level(const char *level_name, int level, const char *fmt, ...)
|
||||
{
|
||||
va_list arglist;
|
||||
|
||||
va_start(arglist, fmt);
|
||||
_stderr_log_with_level(level_name, level, fmt, arglist);
|
||||
va_end(arglist);
|
||||
}
|
||||
|
||||
static void
|
||||
_stderr_log_with_level(const char *level_name, int level, const char *fmt, va_list ap)
|
||||
{
|
||||
char buf[100];
|
||||
|
||||
/*
|
||||
* Store the requested level so that if there's a subsequent
|
||||
* log_hint(), we can suppress that if appropriate.
|
||||
*/
|
||||
last_log_level = level;
|
||||
|
||||
if (log_level >= level)
|
||||
{
|
||||
|
||||
/* Format log line prefix with timestamp if in daemon mode */
|
||||
if (logger_output_mode == OM_DAEMON)
|
||||
{
|
||||
time_t t;
|
||||
struct tm *tm;
|
||||
time(&t);
|
||||
tm = localtime(&t);
|
||||
strftime(buf, 100, "[%Y-%m-%d %H:%M:%S]", tm);
|
||||
fprintf(stderr, "%s [%s] ", buf, level_name);
|
||||
}
|
||||
else
|
||||
{
|
||||
fprintf(stderr, "%s: ", level_name);
|
||||
}
|
||||
|
||||
vfprintf(stderr, fmt, ap);
|
||||
fprintf(stderr, "\n");
|
||||
fflush(stderr);
|
||||
}
|
||||
}
|
||||
|
||||
void
|
||||
log_hint(const char *fmt, ...)
|
||||
{
|
||||
va_list ap;
|
||||
|
||||
if (terse_logging == false)
|
||||
{
|
||||
va_start(ap, fmt);
|
||||
_stderr_log_with_level("HINT", last_log_level, fmt, ap);
|
||||
va_end(ap);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void
|
||||
log_verbose(int level, const char *fmt, ...)
|
||||
{
|
||||
va_list ap;
|
||||
|
||||
va_start(ap, fmt);
|
||||
|
||||
if (verbose_logging == true)
|
||||
{
|
||||
switch(level)
|
||||
{
|
||||
case LOG_EMERG:
|
||||
_stderr_log_with_level("EMERG", level, fmt, ap);
|
||||
break;
|
||||
case LOG_ALERT:
|
||||
_stderr_log_with_level("ALERT", level, fmt, ap);
|
||||
break;
|
||||
case LOG_CRIT:
|
||||
_stderr_log_with_level("CRIT", level, fmt, ap);
|
||||
break;
|
||||
case LOG_ERROR:
|
||||
_stderr_log_with_level("ERROR", level, fmt, ap);
|
||||
break;
|
||||
case LOG_WARNING:
|
||||
_stderr_log_with_level("WARNING", level, fmt, ap);
|
||||
break;
|
||||
case LOG_NOTICE:
|
||||
_stderr_log_with_level("NOTICE", level, fmt, ap);
|
||||
break;
|
||||
case LOG_INFO:
|
||||
_stderr_log_with_level("INFO", level, fmt, ap);
|
||||
break;
|
||||
case LOG_DEBUG:
|
||||
_stderr_log_with_level("DEBUG", level, fmt, ap);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
va_end(ap);
|
||||
}
|
||||
|
||||
|
||||
bool
|
||||
logger_init(t_configuration_options *opts, const char *ident)
|
||||
{
|
||||
char *level = opts->loglevel;
|
||||
char *facility = opts->logfacility;
|
||||
|
||||
int l;
|
||||
int f;
|
||||
|
||||
#ifdef HAVE_SYSLOG
|
||||
int syslog_facility = DEFAULT_SYSLOG_FACILITY;
|
||||
#endif
|
||||
|
||||
#ifdef REPMGR_DEBUG
|
||||
printf("Logger initialisation (Level: %s, Facility: %s)\n", level, facility);
|
||||
#endif
|
||||
|
||||
if (!ident)
|
||||
{
|
||||
ident = DEFAULT_IDENT;
|
||||
}
|
||||
|
||||
if (level && *level)
|
||||
{
|
||||
l = detect_log_level(level);
|
||||
#ifdef REPMGR_DEBUG
|
||||
printf("Assigned level for logger: %d\n", l);
|
||||
#endif
|
||||
|
||||
if (l >= 0)
|
||||
log_level = l;
|
||||
else
|
||||
stderr_log_warning(_("Invalid log level \"%s\" (available values: DEBUG, INFO, NOTICE, WARNING, ERR, ALERT, CRIT or EMERG)\n"), level);
|
||||
}
|
||||
|
||||
/*
|
||||
* STDERR only logging requested - finish here without setting up any further
|
||||
* logging facility.
|
||||
*/
|
||||
if (logger_output_mode == OM_COMMAND_LINE)
|
||||
return true;
|
||||
|
||||
if (facility && *facility)
|
||||
{
|
||||
|
||||
f = detect_log_facility(facility);
|
||||
#ifdef REPMGR_DEBUG
|
||||
printf("Assigned facility for logger: %d\n", f);
|
||||
#endif
|
||||
|
||||
if (f == 0)
|
||||
{
|
||||
/* No syslog requested, just stderr */
|
||||
#ifdef REPMGR_DEBUG
|
||||
printf(_("Use stderr for logging\n"));
|
||||
#endif
|
||||
}
|
||||
else if (f == -1)
|
||||
{
|
||||
stderr_log_warning(_("Cannot detect log facility %s (use any of LOCAL0, LOCAL1, ..., LOCAL7, USER or STDERR)\n"), facility);
|
||||
}
|
||||
#ifdef HAVE_SYSLOG
|
||||
else
|
||||
{
|
||||
syslog_facility = f;
|
||||
log_type = REPMGR_SYSLOG;
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
#ifdef HAVE_SYSLOG
|
||||
|
||||
if (log_type == REPMGR_SYSLOG)
|
||||
{
|
||||
setlogmask(LOG_UPTO(log_level));
|
||||
openlog(ident, LOG_CONS | LOG_PID | LOG_NDELAY, syslog_facility);
|
||||
|
||||
stderr_log_notice(_("Setup syslog (level: %s, facility: %s)\n"), level, facility);
|
||||
}
|
||||
#endif
|
||||
|
||||
if (*opts->logfile)
|
||||
{
|
||||
FILE *fd;
|
||||
|
||||
/* Check if we can write to the specified file before redirecting
|
||||
* stderr - if freopen() fails, stderr output will vanish into
|
||||
* the ether and the user won't know what's going on.
|
||||
*/
|
||||
|
||||
fd = fopen(opts->logfile, "a");
|
||||
if (fd == NULL)
|
||||
{
|
||||
stderr_log_error(_("Unable to open specified logfile '%s' for writing: %s\n"), opts->logfile, strerror(errno));
|
||||
stderr_log_error(_("Terminating\n"));
|
||||
exit(ERR_BAD_CONFIG);
|
||||
}
|
||||
fclose(fd);
|
||||
|
||||
stderr_log_notice(_("Redirecting logging output to '%s'\n"), opts->logfile);
|
||||
fd = freopen(opts->logfile, "a", stderr);
|
||||
|
||||
/*
|
||||
* It's possible freopen() may still fail due to e.g. a race condition;
|
||||
* as it's not feasible to restore stderr after a failed freopen(),
|
||||
* we'll write to stdout as a last resort.
|
||||
*/
|
||||
if (fd == NULL)
|
||||
{
|
||||
printf(_("Unable to open specified logfile %s for writing: %s\n"), opts->logfile, strerror(errno));
|
||||
printf(_("Terminating\n"));
|
||||
exit(ERR_BAD_CONFIG);
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
bool
|
||||
logger_shutdown(void)
|
||||
{
|
||||
#ifdef HAVE_SYSLOG
|
||||
if (log_type == REPMGR_SYSLOG)
|
||||
closelog();
|
||||
#endif
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/*
|
||||
* Indicate whether extra-verbose logging is required. This will
|
||||
* generate a lot of output, particularly debug logging, and should
|
||||
* not be permanently enabled in production.
|
||||
*
|
||||
* NOTE: in previous repmgr versions, this option forced the log
|
||||
* level to INFO.
|
||||
*/
|
||||
void
|
||||
logger_set_verbose(void)
|
||||
{
|
||||
verbose_logging = true;
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* Indicate whether some non-critical log messages can be omitted.
|
||||
* Currently this includes warnings about irrelevant command line
|
||||
* options and hints.
|
||||
*/
|
||||
|
||||
void logger_set_terse(void)
|
||||
{
|
||||
terse_logging = true;
|
||||
}
|
||||
|
||||
|
||||
int
|
||||
detect_log_level(const char *level)
|
||||
{
|
||||
if (!strcmp(level, "DEBUG"))
|
||||
return LOG_DEBUG;
|
||||
if (!strcmp(level, "INFO"))
|
||||
return LOG_INFO;
|
||||
if (!strcmp(level, "NOTICE"))
|
||||
return LOG_NOTICE;
|
||||
if (!strcmp(level, "WARNING"))
|
||||
return LOG_WARNING;
|
||||
if (!strcmp(level, "ERROR"))
|
||||
return LOG_ERROR;
|
||||
if (!strcmp(level, "ALERT"))
|
||||
return LOG_ALERT;
|
||||
if (!strcmp(level, "CRIT"))
|
||||
return LOG_CRIT;
|
||||
if (!strcmp(level, "EMERG"))
|
||||
return LOG_EMERG;
|
||||
|
||||
return -1;
|
||||
}
|
||||
|
||||
static int
|
||||
detect_log_facility(const char *facility)
|
||||
{
|
||||
int local = 0;
|
||||
|
||||
if (!strncmp(facility, "LOCAL", 5) && strlen(facility) == 6)
|
||||
{
|
||||
local = atoi(&facility[5]);
|
||||
|
||||
switch (local)
|
||||
{
|
||||
case 0:
|
||||
return LOG_LOCAL0;
|
||||
break;
|
||||
case 1:
|
||||
return LOG_LOCAL1;
|
||||
break;
|
||||
case 2:
|
||||
return LOG_LOCAL2;
|
||||
break;
|
||||
case 3:
|
||||
return LOG_LOCAL3;
|
||||
break;
|
||||
case 4:
|
||||
return LOG_LOCAL4;
|
||||
break;
|
||||
case 5:
|
||||
return LOG_LOCAL5;
|
||||
break;
|
||||
case 6:
|
||||
return LOG_LOCAL6;
|
||||
break;
|
||||
case 7:
|
||||
return LOG_LOCAL7;
|
||||
break;
|
||||
}
|
||||
|
||||
}
|
||||
else if (!strcmp(facility, "USER"))
|
||||
{
|
||||
return LOG_USER;
|
||||
}
|
||||
else if (!strcmp(facility, "STDERR"))
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
return -1;
|
||||
}
|
||||
Reference in New Issue
Block a user