vlib: add nosyslog unix option 25/26825/7
authorRuslan Babayev <ruslan@babayev.com>
Sat, 15 Feb 2020 01:45:02 +0000 (17:45 -0800)
committerRuslan Babayev <ruslan@babayev.com>
Sat, 2 May 2020 23:06:16 +0000 (16:06 -0700)
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>
docs/gettingstarted/users/configuring/startup.rst
src/vlib/unix/main.c
src/vlib/unix/unix.h

index f80d55c..69d6ee5 100644 (file)
@@ -123,6 +123,18 @@ applications from a process monitor. Set by default in the default
 
    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
 ^^^^^^^^^^^
 
index 90601d7..0f9068c 100755 (executable)
@@ -239,8 +239,8 @@ unix_error_handler (void *arg, u8 * msg, int msg_len)
 {
   unix_main_t *um = arg;
 
-  /* Echo to stderr when interactive. */
-  if (um->flags & UNIX_FLAG_INTERACTIVE)
+  /* Echo to stderr when interactive or syslog is disabled. */
+  if (um->flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG))
     {
       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;
       else if (unformat (input, "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))
        vlib_unix_cli_set_prompt (cli_prompt);
       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);
       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
  * 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;}
  * @par <code>startup-config &lt;filename&gt;</code>
  * Read startup operational configuration from @c filename.
index e71b0ba..9fa95a0 100644 (file)
@@ -59,6 +59,8 @@ typedef struct
   /* Run interactively or as daemon (background process). */
 #define UNIX_FLAG_INTERACTIVE (1 << 0)
 #define UNIX_FLAG_NODAEMON (1 << 1)
+#define UNIX_FLAG_NOSYSLOG (1 << 2)
+
 
   /* CLI listen socket. */
   clib_socket_t cli_listen_socket;