ligang/vpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

vlib: add nosyslog unix option

Browse Source 
The "nosyslog" option disables syslog just like the "interactive" mode
but can be used together with "nodaemon".

This is useful for when VPP is running under a process supervisor like
runit or daemontools that pipe the stdout/stderr to a dedicated logger
service.

Type: feature

Change-Id: Ic4287338d6836fea9f3eabdcf960dc1f51875dd1
Signed-off-by: Ruslan Babayev <ruslan@babayev.com>
This commit is contained in:
Ruslan Babayev
2020-02-14 17:45:02 -08:00
parent 24b417c481
commit e31820af10
3 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/gettingstarted/users/configuring/startup.rst
View File

@ -123,6 +123,18 @@ applications from a process monitor. Set by default in the default
nodaemon nodaemon
nosyslog
^^^^^^^^
Disable syslog and log errors to stderr instead. Typical when invoking
VPP applications from a process monitor like runit or daemontools that
pipe service's output to a dedicated log service, which will typically
attach a timestamp and rotate the logs as necessary.
.. code-block:: console
nosyslog
interactive interactive
^^^^^^^^^^^ ^^^^^^^^^^^

13
src/vlib/unix/main.c
View File

@ -239,8 +239,8 @@ unix_error_handler (void *arg, u8 * msg, int msg_len)
{ {
unix_main_t *um = arg; unix_main_t *um = arg;
/* Echo to stderr when interactive. */ /* Echo to stderr when interactive or syslog is disabled. */
if (um->flags & UNIX_FLAG_INTERACTIVE) if (um->flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG))
{ {
CLIB_UNUSED (int r) = write (2, msg, msg_len); CLIB_UNUSED (int r) = write (2, msg, msg_len);
} }
@ -400,6 +400,8 @@ unix_config (vlib_main_t * vm, unformat_input_t * input)
um->flags |= UNIX_FLAG_INTERACTIVE; um->flags |= UNIX_FLAG_INTERACTIVE;
else if (unformat (input, "nodaemon")) else if (unformat (input, "nodaemon"))
um->flags |= UNIX_FLAG_NODAEMON; um->flags |= UNIX_FLAG_NODAEMON;
else if (unformat (input, "nosyslog"))
um->flags |= UNIX_FLAG_NOSYSLOG;
else if (unformat (input, "cli-prompt %s", &cli_prompt)) else if (unformat (input, "cli-prompt %s", &cli_prompt))
vlib_unix_cli_set_prompt (cli_prompt); vlib_unix_cli_set_prompt (cli_prompt);
else else
@ -529,7 +531,7 @@ unix_config (vlib_main_t * vm, unformat_input_t * input)
} }
} }
if (!(um->flags & UNIX_FLAG_INTERACTIVE)) if (!(um->flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG)))
{ {
openlog (vm->name, LOG_CONS | LOG_PERROR | LOG_PID, LOG_DAEMON); openlog (vm->name, LOG_CONS | LOG_PERROR | LOG_PID, LOG_DAEMON);
clib_error_register_handler (unix_error_handler, um); clib_error_register_handler (unix_error_handler, um);
@ -569,6 +571,11 @@ unix_config (vlib_main_t * vm, unformat_input_t * input)
* Do not fork or background the VPP process. Typically used when invoking * Do not fork or background the VPP process. Typically used when invoking
* VPP applications from a process monitor. * VPP applications from a process monitor.
* *
* @cfgcmd{nosyslog}
* Do not send e.g. clib_warning(...) output to syslog. Used
* when invoking VPP applications from a process monitor which
* pipe stdout/stderr to a dedicated logger service.
*
* @cfgcmd{exec, &lt;filename&gt;} * @cfgcmd{exec, &lt;filename&gt;}
* @par <code>startup-config &lt;filename&gt;</code> * @par <code>startup-config &lt;filename&gt;</code>
* Read startup operational configuration from @c filename. * Read startup operational configuration from @c filename.

2
src/vlib/unix/unix.h
View File

@ -59,6 +59,8 @@ typedef struct
/* Run interactively or as daemon (background process). */ /* Run interactively or as daemon (background process). */
#define UNIX_FLAG_INTERACTIVE (1 << 0) #define UNIX_FLAG_INTERACTIVE (1 << 0)
#define UNIX_FLAG_NODAEMON (1 << 1) #define UNIX_FLAG_NODAEMON (1 << 1)
#define UNIX_FLAG_NOSYSLOG (1 << 2)
/* CLI listen socket. */ /* CLI listen socket. */
clib_socket_t cli_listen_socket; clib_socket_t cli_listen_socket;