]>
Commit | Line | Data |
---|---|---|
0fdc4312 BP |
1 | <?xml version="1.0" encoding="utf-8"?> |
2 | <dl> | |
3 | <dt><code>-v</code>[<var>spec</var>]</dt> | |
4 | <dt><code>--verbose=</code>[<var>spec</var>]</dt> | |
5 | <dd> | |
6 | <p> | |
7 | Sets logging levels. Without any <var>spec</var>, sets the log level for | |
8 | every module and destination to <code>dbg</code>. Otherwise, | |
9 | <var>spec</var> is a list of words separated by spaces or commas or | |
10 | colons, up to one from each category below: | |
11 | </p> | |
12 | ||
13 | <ul> | |
14 | <li> | |
15 | A valid module name, as displayed by the <code>vlog/list</code> command | |
16 | on <code>ovs-appctl</code>(8), limits the log level change to the | |
17 | specified module. | |
18 | </li> | |
19 | ||
20 | <li> | |
21 | <p> | |
22 | <code>syslog</code>, <code>console</code>, or <code>file</code>, to | |
23 | limit the log level change to only to the system log, to the console, | |
24 | or to a file, respectively. (If <code>--detach</code> is specified, | |
25 | the daemon closes its standard file descriptors, so logging to the | |
26 | console will have no effect.) | |
27 | </p> | |
28 | ||
29 | <p> | |
30 | On Windows platform, <code>syslog</code> is accepted as a word and is | |
31 | only useful along with the <code>--syslog-target</code> option (the | |
32 | word has no effect otherwise). | |
33 | </p> | |
34 | </li> | |
35 | ||
36 | <li> | |
37 | <code>off</code>, <code>emer</code>, <code>err</code>, | |
38 | <code>warn</code>, <code>info</code>, or <code>dbg</code>, to control | |
39 | the log level. Messages of the given severity or higher will be | |
40 | logged, and messages of lower severity will be filtered out. | |
41 | <code>off</code> filters out all messages. See | |
42 | <code>ovs-appctl</code>(8) for a definition of each log level. | |
43 | </li> | |
44 | </ul> | |
45 | ||
46 | <p> | |
47 | Case is not significant within <var>spec</var>. | |
48 | </p> | |
49 | ||
50 | <p> | |
51 | Regardless of the log levels set for <code>file</code>, logging to a file | |
52 | will not take place unless <code>--log-file</code> is also specified (see | |
53 | below). | |
54 | </p> | |
55 | ||
56 | <p> | |
57 | For compatibility with older versions of OVS, <code>any</code> is | |
58 | accepted as a word but has no effect. | |
59 | </p> | |
60 | </dd> | |
61 | ||
62 | <dt><code>-v</code></dt> | |
63 | <dt><code>--verbose</code></dt> | |
64 | <dd> | |
65 | Sets the maximum logging verbosity level, equivalent to | |
66 | <code>--verbose=dbg</code>. | |
67 | </dd> | |
68 | ||
69 | <dt><code>-vPATTERN:</code><var>destination</var><code>:</code><var>pattern</var></dt> | |
70 | <dt><code>--verbose=PATTERN:</code><var>destination</var><code>:</code><var>pattern</var></dt> | |
71 | <dd> | |
72 | Sets the log pattern for <var>destination</var> to <var>pattern</var>. | |
73 | Refer to <code>ovs-appctl</code>(8) for a description of the valid syntax | |
74 | for <var>pattern</var>. | |
75 | </dd> | |
76 | ||
77 | <dt><code>-vFACILITY:</code><var>facility</var></dt> | |
78 | <dt><code>--verbose=FACILITY:</code><var>facility</var></dt> | |
79 | <dd> | |
80 | Sets the RFC5424 facility of the log message. <var>facility</var> can be | |
81 | one of <code>kern</code>, <code>user</code>, <code>mail</code>, | |
82 | <code>daemon</code>, <code>auth</code>, <code>syslog</code>, | |
83 | <code>lpr</code>, <code>news</code>, <code>uucp</code>, <code>clock</code>, | |
84 | <code>ftp</code>, <code>ntp</code>, <code>audit</code>, <code>alert</code>, | |
85 | <code>clock2</code>, <code>local0</code>, <code>local1</code>, | |
86 | <code>local2</code>, <code>local3</code>, <code>local4</code>, | |
87 | <code>local5</code>, <code>local6</code> or <code>local7</code>. If this | |
88 | option is not specified, <code>daemon</code> is used as the default for the | |
89 | local system syslog and <code>local0</code> is used while sending a message | |
90 | to the target provided via the <code>--syslog-target</code> option. | |
91 | </dd> | |
92 | ||
93 | <dt><code>--log-file</code>[<code>=</code><var>file</var>]</dt> | |
94 | <dd> | |
95 | Enables logging to a file. If <var>file</var> is specified, then it is | |
96 | used as the exact name for the log file. The default log file name used if | |
97 | <var>file</var> is omitted is <code>@LOGDIR@/<var>program</var>.log</code>. | |
98 | </dd> | |
99 | ||
100 | <dt><code>--syslog-target=</code><var>host</var><code>:</code><var>port</var></dt> | |
101 | <dd> | |
102 | Send syslog messages to UDP <var>port</var> on <var>host</var>, in addition | |
103 | to the system syslog. The <var>host</var> must be a numerical IP address, | |
104 | not a hostname. | |
105 | </dd> | |
106 | ||
107 | <dt><code>--syslog-method=</code><var>method</var></dt> | |
108 | <dd> | |
109 | <p> | |
110 | Specify <var>method</var> as how syslog messages should be sent to syslog | |
111 | daemon. The following forms are supported: | |
112 | </p> | |
113 | ||
114 | <ul> | |
115 | <li> | |
116 | <code>libc</code>, to use the libc <code>syslog()</code> function. | |
117 | This is the default behavior. Downside of using this options is that | |
118 | libc adds fixed prefix to every message before it is actually sent to | |
119 | the syslog daemon over <code>/dev/log</code> UNIX domain socket. | |
120 | </li> | |
121 | ||
122 | <li> | |
123 | <code>unix:<var>file</var></code>, to use a UNIX domain socket | |
124 | directly. It is possible to specify arbitrary message format with this | |
125 | option. However, <code>rsyslogd 8.9</code> and older versions use hard | |
126 | coded parser function anyway that limits UNIX domain socket use. If | |
127 | you want to use arbitrary message format with older | |
128 | <code>rsyslogd</code> versions, then use UDP socket to localhost IP | |
129 | address instead. | |
130 | </li> | |
131 | ||
132 | <li> | |
133 | <code>udp:<var>ip</var>:<var>port</var></code>, to use a UDP socket. | |
134 | With this method it is possible to use arbitrary message format also | |
135 | with older <code>rsyslogd</code>. When sending syslog messages over | |
136 | UDP socket extra precaution needs to be taken into account, for | |
137 | example, syslog daemon needs to be configured to listen on the | |
138 | specified UDP port, accidental iptables rules could be interfering with | |
139 | local syslog traffic and there are some security considerations that | |
140 | apply to UDP sockets, but do not apply to UNIX domain sockets. | |
141 | </li> | |
142 | </ul> | |
143 | </dd> | |
144 | </dl> |