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