lib/vlog.man

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