Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

reduce log noise #140

Merged
merged 5 commits into from
Feb 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 4 additions & 20 deletions src/libcommon/error.c
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
#include "error.h"

static char *err_prog = NULL; /* basename of calling program */
static bool err_ttyvalid = true; /* use stderr until told otherwise */

#define ERROR_BUFLEN 1024

Expand All @@ -38,14 +37,6 @@ void err_init(char *prog)
err_prog = p ? p + 1 : prog;
}

/*
* Accessor function for syslog_enable.
*/
void err_notty(void)
{
err_ttyvalid = false;
}

/* helper for err, err_exit */
static void _verr(bool errno_valid, const char *fmt, va_list ap)
{
Expand All @@ -55,17 +46,10 @@ static void _verr(bool errno_valid, const char *fmt, va_list ap)
assert(err_prog != NULL);

vsnprintf(buf, ERROR_BUFLEN, fmt, ap); /* overflow ignored on purpose */
if (errno_valid) {
if (err_ttyvalid)
fprintf(stderr, "%s: %s: %s\n", err_prog, buf, strerror(er));
else
syslog(LOG_ERR, "%s: %s", buf, strerror(er));
} else {
if (err_ttyvalid)
fprintf(stderr, "%s: %s\n", err_prog, buf);
else
syslog(LOG_ERR, "%s", buf);
}
if (errno_valid)
fprintf(stderr, "%s: %s: %s\n", err_prog, buf, strerror(er));
else
fprintf(stderr, "%s: %s\n", err_prog, buf);
}

/*
Expand Down
1 change: 0 additions & 1 deletion src/libcommon/error.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
#include <stdarg.h>

void err_init(char *prog);
void err_notty(void);
void err_exit(bool errno_valid, const char *fmt, ...)
__attribute__ ((format (printf, 2, 3)));
void err(bool errno_valid, const char *fmt, ...)
Expand Down
47 changes: 27 additions & 20 deletions src/powerman/client.c
Original file line number Diff line number Diff line change
Expand Up @@ -640,28 +640,37 @@ static void _telemetry_printf(int client_id, const char *fmt, ...)
}
}

/* See chaos/powerman#138.
* We don't want these messages syslogged when we run the test suite,
* so send them to stderr and when powerman is run as a system service,
* systemd redirects stderr to the journal which also usually goes to syslog.
*/
static void log_state_change(Client *c)
{
char *action = NULL;
char *hosts;
char *with_errors = " with errors";
int level = conf_get_plug_log_level();
const char *action;
char *hosts;

if (c->cmd->com == PM_POWER_ON)
action = "powered on";
if (c->cmd->com == PM_POWER_OFF)
action = "powered off";
if (c->cmd->com == PM_POWER_CYCLE)
action = "power cycled";
if (c->cmd->com == PM_RESET)
action = "reset";

if (!action)
return;

switch (c->cmd->com) {
case PM_POWER_ON:
action = "powered on";
break;
case PM_POWER_OFF:
action = "powered off";
break;
case PM_POWER_CYCLE:
action = "power cycled";
break;
case PM_RESET:
action = "reset";
break;
default:
return;
}
hosts = _xhostlist_ranged_string(c->cmd->hl);
syslog(level, "%s %s%s", action, hosts,
(c->cmd->error == true ? with_errors : ""));
// N.B. systemd journal groks <level> prefix
fprintf(stderr, "<%d>%s %s%s\n", level, action, hosts,
(c->cmd->error == true ? " with errors" : ""));
xfree(hosts);
}

Expand Down Expand Up @@ -998,7 +1007,7 @@ static void _handle_read(Client * c)
}
if (n == 0) {
c->client_quit = true;
err(false, "client read returned EOF");
dbg(DBG_CLIENT, "client read returned EOF");
return;
}
if (dropped != 0)
Expand Down Expand Up @@ -1093,8 +1102,6 @@ void cli_post_poll(xpollfd_t pfd)

if (flags & XPOLLERR)
err(false, "client poll: error");
if (flags & XPOLLHUP)
err(false, "client poll: hangup");
if (flags & XPOLLNVAL)
err(false, "client poll: fd not open");
if (flags & (XPOLLERR | XPOLLNVAL))
Expand Down
14 changes: 2 additions & 12 deletions src/powerman/debug.c
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,6 @@
#define DBG_BUFLEN 1024

static unsigned long dbg_channel_mask = 0;
static bool dbg_ttyvalid = true;

void dbg_notty(void)
{
dbg_ttyvalid = false;
}

void dbg_setmask(unsigned long mask)
{
Expand Down Expand Up @@ -81,12 +75,8 @@ void dbg_wrapped(unsigned long channel, const char *fmt, ...)
vsnprintf(buf, DBG_BUFLEN, fmt, ap); /* overflow ignored on purpose */
va_end(ap);

if (dbg_ttyvalid)
fprintf(stderr, "%s %s: %s\n",
_time(), _channel_name(channel), buf);
else
syslog(LOG_DEBUG, "%s: %s",
_channel_name(channel), buf);
fprintf(stderr, "%s %s: %s\n",
_time(), _channel_name(channel), buf);
}
}

Expand Down
1 change: 0 additions & 1 deletion src/powerman/debug.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
{ 0, NULL } \
}

void dbg_notty(void);
void dbg_setmask(unsigned long mask);
void dbg_wrapped(unsigned long channel, const char *fmt, ...)
__attribute__ ((format (printf, 2, 3)));
Expand Down
21 changes: 16 additions & 5 deletions src/powerman/device_pipe.c
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,12 @@ bool pipe_connect(Device * dev)
(void)dup2(fd[1], STDIN_FILENO);
(void)dup2(fd[1], STDOUT_FILENO);
(void)close(fd[1]);
(void)close(fd[0]);
execv(pd->argv[0], pd->argv);
err_exit(true, "exec %s", pd->argv[0]);
} else { /* parent */
(void)close(fd[1]);

nonblock_set(fd[0]);

dev->fd = fd[0];
Expand All @@ -104,7 +107,7 @@ bool pipe_connect(Device * dev)

pd->cpid = pid;

err(false, "_pipe_connect(%s): opened", dev->name);
dbg(DBG_DEVICE, "_pipe_connect(%s): opened", dev->name);
}

return (dev->connect_state == DEV_CONNECTED);
Expand Down Expand Up @@ -135,11 +138,19 @@ void pipe_disconnect(Device * dev)
if (waitpid(pd->cpid, &wstat, 0) < 0)
err(true, "_pipe_disconnect(%s): wait", dev->name);
if (WIFEXITED(wstat)) {
err(false, "_pipe_disconnect(%s): %s exited with status %d",
dev->name, pd->argv[0], WEXITSTATUS(wstat));
if (WEXITSTATUS(wstat) == 0)
dbg(DBG_DEVICE, "_pipe_disconnect(%s): %s exited with status 0",
dev->name, pd->argv[0]);
else
err(false, "_pipe_disconnect(%s): %s exited with status %d",
dev->name, pd->argv[0], WEXITSTATUS(wstat));
} else if (WIFSIGNALED(wstat)) {
err(false, "_pipe_disconnect(%s): %s terminated with signal %d",
dev->name, pd->argv[0], WTERMSIG(wstat));
if (WTERMSIG(wstat) == SIGTERM)
dbg(DBG_DEVICE, "_pipe_disconnect(%s): %s terminated",
dev->name, pd->argv[0]);
else
err(false, "_pipe_disconnect(%s): %s terminated with signal %d",
dev->name, pd->argv[0], WTERMSIG(wstat));
} else {
err(false, "_pipe_disconnect(%s): %s terminated",
dev->name, pd->argv[0]);
Expand Down
4 changes: 2 additions & 2 deletions src/powerman/device_serial.c
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ bool serial_connect(Device * dev)
dev->connect_state = DEV_CONNECTED;
dev->stat_successful_connects++;

err(false, "_serial_connect(%s): opened", dev->name);
dbg(DBG_DEVICE, "_serial_connect(%s): opened", dev->name);
return true;

out:
Expand Down Expand Up @@ -255,7 +255,7 @@ void serial_disconnect(Device * dev)
dev->fd = NO_FD;
}

err(false, "_serial_disconnect(%s): closed", dev->name);
dbg(DBG_DEVICE, "_serial_disconnect(%s): closed", dev->name);
}

/*
Expand Down
18 changes: 5 additions & 13 deletions src/powerman/device_tcp.c
Original file line number Diff line number Diff line change
Expand Up @@ -206,12 +206,10 @@ bool tcp_finish_connect(Device * dev)
err(false, "tcp_finish_connect(%s): connection refused", dev->name);
break;
case DEV_CONNECTED:
if (!tcp->quiet)
err(false, "tcp_finish_connect(%s): connected", dev->name);
dbg(DBG_DEVICE, "tcp_finish_connect(%s): connected", dev->name);
break;
case DEV_CONNECTING:
if (!tcp->quiet)
err(false, "tcp_finish_connect(%s): connecting", dev->name);
dbg(DBG_DEVICE, "tcp_finish_connect(%s): connecting", dev->name);
break;
}
return (dev->connect_state != DEV_NOT_CONNECTED);
Expand Down Expand Up @@ -242,12 +240,10 @@ bool tcp_connect(Device * dev)
err(false, "tcp_connect(%s): connection refused", dev->name);
break;
case DEV_CONNECTED:
if (!tcp->quiet)
err(false, "tcp_connect(%s): connected", dev->name);
dbg(DBG_DEVICE, "tcp_connect(%s): connected", dev->name);
break;
case DEV_CONNECTING:
if (!tcp->quiet)
err(false, "tcp_connect(%s): connecting", dev->name);
dbg(DBG_DEVICE, "tcp_connect(%s): connecting", dev->name);
break;
}

Expand All @@ -259,11 +255,8 @@ bool tcp_connect(Device * dev)
*/
void tcp_disconnect(Device * dev)
{
TcpDev *tcp;

assert(dev->connect_state == DEV_CONNECTING
|| dev->connect_state == DEV_CONNECTED);
tcp = (TcpDev *)dev->data;
Comment on lines -262 to -266
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this code removal doesn't seem related to the "reduce log noise" commit. Seems like it's just dead code, meant for another commit and forgot it was in this one?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I changed some logging code and as a result, tcp became a set but not used error. The full diff is

@ -259,11 +255,8 @@ bool tcp_connect(Device * dev)
  */
 void tcp_disconnect(Device * dev)
 {
-    TcpDev *tcp;
-
     assert(dev->connect_state == DEV_CONNECTING
            || dev->connect_state == DEV_CONNECTED);
-    tcp = (TcpDev *)dev->data;
 
     dbg(DBG_DEVICE, "tcp_disconnect: %s on fd %d", dev->name, dev->fd);
 
@@ -274,8 +267,7 @@ void tcp_disconnect(Device * dev)
         dev->fd = NO_FD;
     }
 
-    if (!tcp->quiet)
-        err(false, "tcp_disconnect(%s): disconnected", dev->name);
+    dbg(DBG_DEVICE, "tcp_disconnect(%s): disconnected", dev->name);
 }
 
 void tcp_preprocess(Device *dev)


dbg(DBG_DEVICE, "tcp_disconnect: %s on fd %d", dev->name, dev->fd);

Expand All @@ -274,8 +267,7 @@ void tcp_disconnect(Device * dev)
dev->fd = NO_FD;
}

if (!tcp->quiet)
err(false, "tcp_disconnect(%s): disconnected", dev->name);
dbg(DBG_DEVICE, "tcp_disconnect(%s): disconnected", dev->name);
}

void tcp_preprocess(Device *dev)
Expand Down
Loading