lib/vlog.man

   1 .IP "\fB\-v\fR[\fIspec\fR]
   2 .IQ "\fB\-\-verbose=\fR[\fIspec\fR]
   3 .
   4 Sets logging levels.  Without any \fIspec\fR, sets the log level for
   5 every module and destination to \fBdbg\fR.  Otherwise, \fIspec\fR is a
   6 list of words separated by spaces or commas or colons, up to one from
   7 each category below:
   8 .
   9 .RS
  10 .IP \(bu
  11 A valid module name, as displayed by the \fBvlog/list\fR command on
  12 \fBovs\-appctl\fR(8), limits the log level change to the specified
  13 module.
  14 .
  15 .IP \(bu
  16 \fBsyslog\fR, \fBconsole\fR, or \fBfile\fR, to limit the log level
  17 change to only to the system log, to the console, or to a file,
  18 respectively.  (If \fB\-\-detach\fR is specified, \fB\*(PN\fR closes
  19 its standard file descriptors, so logging to the console will have no
  20 effect.)
  21 .IP
  22 On Windows platform, \fBsyslog\fR is accepted as a word and is only
  23 useful along with the \fB\-\-syslog\-target\fR option (the word has no
  24 effect otherwise).
  25 .
  26 .IP \(bu
  27 \fBoff\fR, \fBemer\fR, \fBerr\fR, \fBwarn\fR, \fBinfo\fR, or
  28 \fBdbg\fR, to control the log level.  Messages of the given severity
  29 or higher will be logged, and messages of lower severity will be
  30 filtered out.  \fBoff\fR filters out all messages.  See
  31 \fBovs\-appctl\fR(8) for a definition of each log level.
  32 .RE
  33 .
  34 .IP
  35 Case is not significant within \fIspec\fR.
  36 .IP
  37 Regardless of the log levels set for \fBfile\fR, logging to a file
  38 will not take place unless \fB\-\-log\-file\fR is also specified (see
  39 below).
  40 .IP
  41 For compatibility with older versions of OVS, \fBany\fR is accepted as
  42 a word but has no effect.
  43 .
  44 .IP "\fB\-v\fR"
  45 .IQ "\fB\-\-verbose\fR"
  46 Sets the maximum logging verbosity level, equivalent to
  47 \fB\-\-verbose=dbg\fR.
  48 .
  49 .IP "\fB\-vPATTERN:\fIdestination\fB:\fIpattern\fR"
  50 .IQ "\fB\-\-verbose=PATTERN:\fIdestination\fB:\fIpattern\fR"
  51 Sets the log pattern for \fIdestination\fR to \fIpattern\fR.  Refer to
  52 \fBovs\-appctl\fR(8) for a description of the valid syntax for \fIpattern\fR.
  53 .
  54 .IP "\fB\-vFACILITY:\fIfacility\fR"
  55 .IQ "\fB\-\-verbose=FACILITY:\fIfacility\fR"
  56 Sets the RFC5424 facility of the log message. \fIfacility\fR can be one of
  57 \fBkern\fR, \fBuser\fR, \fBmail\fR, \fBdaemon\fR, \fBauth\fR, \fBsyslog\fR,
  58 \fBlpr\fR, \fBnews\fR, \fBuucp\fR, \fBclock\fR, \fBftp\fR, \fBntp\fR,
  59 \fBaudit\fR, \fBalert\fR, \fBclock2\fR, \fBlocal0\fR, \fBlocal1\fR,
  60 \fBlocal2\fR, \fBlocal3\fR, \fBlocal4\fR, \fBlocal5\fR, \fBlocal6\fR or
  61 \fBlocal7\fR. If this option is not specified, \fBdaemon\fR is used as
  62 the default for the local system syslog and \fBlocal0\fR is used while sending
  63 a message to the target provided via the \fB\-\-syslog\-target\fR option.
  64 .
  65 .TP
  66 \fB\-\-log\-file\fR[\fB=\fIfile\fR]
  67 Enables logging to a file.  If \fIfile\fR is specified, then it is
  68 used as the exact name for the log file.  The default log file name
  69 used if \fIfile\fR is omitted is \fB@LOGDIR@/\*(PN.log\fR.
  70 .
  71 .IP "\fB\-\-syslog\-target=\fIhost\fB:\fIport\fR"
  72 Send syslog messages to UDP \fIport\fR on \fIhost\fR, in addition to
  73 the system syslog.  The \fIhost\fR must be a numerical IP address, not
  74 a hostname.
  75 .
  76 .IP "\fB\-\-syslog\-method=\fImethod\fR"
  77 Specify \fImethod\fR how syslog messages should be sent to syslog daemon.
  78 Following forms are supported:
  79 .RS
  80 .IP \(bu
  81 \fBlibc\fR, use libc \fBsyslog()\fR function.
  82 Downside of using this options is that libc adds fixed prefix to every
  83 message before it is actually sent to the syslog daemon over \fB/dev/log\fR
  84 UNIX domain socket.
  85 .IP \(bu
  86 \fBunix:\fIfile\fR\fR, use UNIX domain socket directly.  It is possible to
  87 specify arbitrary message format with this option.  However,
  88 \fBrsyslogd 8.9\fR and older versions use hard coded parser function anyway
  89 that limits UNIX domain socket use.  If you want to use arbitrary message
  90 format with older \fBrsyslogd\fR versions, then use UDP socket to localhost
  91 IP address instead.
  92 .IP \(bu
  93 \fBudp:\fIip\fR:\fIport\fR\fR, use UDP socket.  With this method it is
  94 possible to use arbitrary message format also with older \fBrsyslogd\fR.
  95 When sending syslog messages over UDP socket extra precaution needs to
  96 be taken into account, for example, syslog daemon needs to be configured
  97 to listen on the specified UDP port, accidental iptables rules could be
  98 interfering with local syslog traffic and there are some security
  99 considerations that apply to UDP sockets, but do not apply to UNIX domain
 100 sockets.
 101 .IP \(bu
 102 \fBnull\fR, discards all messages logged to syslog.
 103 .RE
 104 .IP
 105 The default is taken from the \fBOVS_SYSLOG_METHOD\fR environment
 106 variable; if it is unset, the default is \fBlibc\fR.