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