lib/vlog-unixctl.man

   1 .de IQ
   2 .  br
   3 .  ns
   4 .  IP "\\$1"
   5 ..
   6 .SS "VLOG COMMANDS"
   7 These commands manage \fB\*(PN\fR's logging settings.
   8 .IP "\fBvlog/set\fR [\fIspec\fR]"
   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.
  24 .IP
  25 On Windows platform, \fBsyslog\fR is accepted as a word and is only
  26 useful along with the \fB\-\-syslog\-target\fR option (the word has no
  27 effect otherwise).
  28 .
  29 .IP \(bu
  30 \fBoff\fR, \fBemer\fR, \fBerr\fR, \fBwarn\fR, \fBinfo\fR, or
  31 \fBdbg\fR, to control the log level.  Messages of the given severity
  32 or higher will be logged, and messages of lower severity will be
  33 filtered out.  \fBoff\fR filters out all messages.  See
  34 \fBovs\-appctl\fR(8) for a definition of each log level.
  35 .RE
  36 .
  37 .IP
  38 Case is not significant within \fIspec\fR.
  39 .IP
  40 Regardless of the log levels set for \fBfile\fR, logging to a file
  41 will not take place unless \fB\*(PN\fR was invoked with the
  42 \fB\-\-log\-file\fR option.
  43 .IP
  44 For compatibility with older versions of OVS, \fBany\fR is accepted as
  45 a word but has no effect.
  46 .RE
  47 .IP "\fBvlog/set PATTERN:\fIdestination\fB:\fIpattern\fR"
  48 Sets the log pattern for \fIdestination\fR to \fIpattern\fR.  Refer to
  49 \fBovs\-appctl\fR(8) for a description of the valid syntax for \fIpattern\fR.
  50 .
  51 .IP "\fBvlog/list\fR"
  52 Lists the supported logging modules and their current levels.
  53 .
  54 .IP "\fBvlog/list-pattern\fR"
  55 Lists logging patterns used for each destination.
  56 .
  57 .IP "\fBvlog/close\fR"
  58 Causes \fB\*(PN\fR to close its log file, if it is open.  (Use
  59 \fBvlog/reopen\fR to reopen it later.)
  60 .
  61 .IP "\fBvlog/reopen\fR"
  62 Causes \fB\*(PN\fR to close its log file, if it is open, and then
  63 reopen it.  (This is useful after rotating log files, to cause a new
  64 log file to be used.)
  65 .IP
  66 This has no effect unless \fB\*(PN\fR was invoked with the
  67 \fB\-\-log\-file\fR option.
  68 .
  69 .IP "\fBvlog/disable\-rate\-limit \fR[\fImodule\fR]..."
  70 .IQ "\fBvlog/enable\-rate\-limit \fR[\fImodule\fR]..."
  71 By default, \fB\*(PN\fR limits the rate at which certain messages can
  72 be logged.  When a message would appear more frequently than the
  73 limit, it is suppressed.  This saves disk space, makes logs easier to
  74 read, and speeds up execution, but occasionally troubleshooting
  75 requires more detail.  Therefore, \fBvlog/disable\-rate\-limit\fR
  76 allows rate limits to be disabled at the level of an individual log
  77 module.  Specify one or more module names, as displayed by the
  78 \fBvlog/list\fR command.  Specifying either no module names at all or
  79 the keyword \fBany\fR disables rate limits for every log module.
  80 .
  81 .IP
  82 The \fBvlog/enable\-rate\-limit\fR command, whose syntax is the same
  83 as \fBvlog/disable\-rate\-limit\fR, can be used to re-enable a rate
  84 limit that was previously disabled.