]> git.proxmox.com Git - mirror_ovs.git/blame - lib/vlog-unixctl.man
netlink-socket: Refill comment to fit within 79 columns.
[mirror_ovs.git] / lib / vlog-unixctl.man
CommitLineData
93161ce9
BP
1.de IQ
2. br
3. ns
4. IP "\\$1"
5..
b16fdafe
BP
6.SS "VLOG COMMANDS"
7These commands manage \fB\*(PN\fR's logging settings.
2a3e30b2
BP
8.IP "\fBvlog/set\fR [\fIspec\fR]"
9Sets logging levels. Without any \fIspec\fR, sets the log level for
10every module and facility to \fBdbg\fR. Otherwise, \fIspec\fR is a
11list of words separated by spaces or commas or colons, up to one from
12each category below:
b16fdafe
BP
13.
14.RS
15.IP \(bu
2a3e30b2
BP
16A 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
18module.
b16fdafe
BP
19.
20.IP \(bu
2a3e30b2
BP
21\fBsyslog\fR, \fBconsole\fR, or \fBfile\fR, to limit the log level
22change to only to the system log, to the console, or to a file,
23respectively.
5a6af13f
GS
24.IP
25On Windows platform, \fBsyslog\fR is accepted as a word and is only
26useful along with the \fB\-\-syslog\-target\fR option (the word has no
27effect otherwise).
2a3e30b2 28.
b16fdafe 29.IP \(bu
2a3e30b2
BP
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
32or higher will be logged, and messages of lower severity will be
33filtered 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
38Case is not significant within \fIspec\fR.
39.IP
40Regardless of the log levels set for \fBfile\fR, logging to a file
41will not take place unless \fB\*(PN\fR was invoked with the
42\fB\-\-log\-file\fR option.
43.IP
44For compatibility with older versions of OVS, \fBany\fR is accepted as
45a word but has no effect.
b16fdafe
BP
46.RE
47.IP "\fBvlog/set PATTERN:\fIfacility\fB:\fIpattern\fR"
48Sets the log pattern for \fIfacility\fR to \fIpattern\fR. Refer to
3fbe1d30 49\fBovs\-appctl\fR(8) for a description of the valid syntax for \fIpattern\fR.
b16fdafe
BP
50.
51.IP "\fBvlog/list\fR"
52Lists the supported logging modules and their current levels.
53.
54.IP "\fBvlog/reopen\fR"
55Causes \fB\*(PN\fR to close and reopen its log file. (This is useful
56after rotating log files, to cause a new log file to be used.)
57.IP
58This has no effect unless \fB\*(PN\fR was invoked with the
4e312e69 59\fB\-\-log\-file\fR option.
93161ce9
BP
60.
61.IP "\fBvlog/disable\-rate\-limit \fR[\fImodule\fR]..."
62.IQ "\fBvlog/enable\-rate\-limit \fR[\fImodule\fR]..."
63By default, \fB\*(PN\fR limits the rate at which certain messages can
64be logged. When a message would appear more frequently than the
65limit, it is suppressed. This saves disk space, makes logs easier to
66read, and speeds up execution, but occasionally troubleshooting
67requires more detail. Therefore, \fBvlog/disable\-rate\-limit\fR
68allows rate limits to be disabled at the level of an individual log
69module. Specify one or more module names, as displayed by the
70\fBvlog/list\fR command. Specifying either no module names at all or
71the keyword \fBany\fR disables rate limits for every log module.
72.
73.IP
74The \fBvlog/enable\-rate\-limit\fR command, whose syntax is the same
75as \fBvlog/disable\-rate\-limit\fR, can be used to re-enable a rate
76limit that was previously disabled.