openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity
libvirt/docs/logging.html.in

184 lines
8.6 KiB
HTML
Raw Normal View History

* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
<?xml version="1.0"?>
<html>
<body>
<h1 >Logging in the library and the daemon</h1>
<p>Libvirt includes logging facilities starting from version 0.6.0,
this complements the <a href="errors.html">error handling</a>
docs: grammar cleanups on logging examples * docs/logging.html.in: Fix spelling and grammar.
2010-09-23 05:34:17 +08:00
mechanism and APIs to allow tracing through the execution of the
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
library as well as in the libvirtd daemon.</p>
Improve logging documentation including the debug buffer * docs/logging.html.in: document the fact that starting from 0.9.0 the server logs goes to libvirtd.log instead of syslog by default, describe the debug buffer, restructure the page and add a couple more examples
2011-03-17 15:30:49 +08:00
<ul>
<li>
<a href="#log_library">Logging in the library</a>
</li>
<li>
<a href="#log_config">Configuring logging in the library</a>
</li>
<li>
<a href="#log_daemon">Logging in the daemon</a>
</li>
<li>
<a href="#log_syntax">Syntax for filters and output values</a>
</li>
<li>
<a href="#log_examples">Examples</a>
</li>
</ul>
<h3>
<a name="log_library">Logging in the library</a>
</h3>
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
<p>The logging functionalities in libvirt are based on 3 key concepts,
similar to the one present in other generic logging facilities like
log4j:</p>
<ul>
Improve logging documentation including the debug buffer * docs/logging.html.in: document the fact that starting from 0.9.0 the server logs goes to libvirtd.log instead of syslog by default, describe the debug buffer, restructure the page and add a couple more examples
2011-03-17 15:30:49 +08:00
<li><b>log messages</b>: they are information generated at runtime by
docs: grammar cleanups on logging examples * docs/logging.html.in: Fix spelling and grammar.
2010-09-23 05:34:17 +08:00
the libvirt code. Each message includes a priority level (DEBUG = 1,
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
INFO = 2, WARNING = 3, ERROR = 4), a category, function name and
line number, indicating where it originated from, and finally
docs: grammar cleanups on logging examples * docs/logging.html.in: Fix spelling and grammar.
2010-09-23 05:34:17 +08:00
a formatted message. In addition the library adds a timestamp
Improve logging documentation including the debug buffer * docs/logging.html.in: document the fact that starting from 0.9.0 the server logs goes to libvirtd.log instead of syslog by default, describe the debug buffer, restructure the page and add a couple more examples
2011-03-17 15:30:49 +08:00
at the beginning of the message</li>
<li><b>log filters</b>: a set of patterns and priorities to accept
docs: grammar cleanups on logging examples * docs/logging.html.in: Fix spelling and grammar.
2010-09-23 05:34:17 +08:00
or reject a log message. If the message category matches a filter,
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
the message priority is compared to the filter priority, if lower
the message is discarded, if higher the message is output. If
no filter matches, then a general priority level is applied to
docs: grammar cleanups on logging examples * docs/logging.html.in: Fix spelling and grammar.
2010-09-23 05:34:17 +08:00
all remaining messages. This allows, for example, capturing all
debug messages for the QEmu driver, but otherwise only allowing
errors to show up from other parts.</li>
Improve logging documentation including the debug buffer * docs/logging.html.in: document the fact that starting from 0.9.0 the server logs goes to libvirtd.log instead of syslog by default, describe the debug buffer, restructure the page and add a couple more examples
2011-03-17 15:30:49 +08:00
<li><b>log outputs</b>: once a message has gone through filtering a set of
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
output defines where to send the message, they can also filter
based on the priority, for example it may be useful to output
all messages to a debugging file but only allow errors to be
docs: grammar cleanups on logging examples * docs/logging.html.in: Fix spelling and grammar.
2010-09-23 05:34:17 +08:00
logged through syslog.</li>
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
</ul>
Improve logging documentation including the debug buffer * docs/logging.html.in: document the fact that starting from 0.9.0 the server logs goes to libvirtd.log instead of syslog by default, describe the debug buffer, restructure the page and add a couple more examples
2011-03-17 15:30:49 +08:00
<p>Note that the logging module saves all logs to a <b>debug buffer</b>
filled in a round-robin fashion as to keep a full log of the
recent logs including all debug. The debug buffer can be resized
or deactivated in the daemon using the log_buffer_size variable,
default is 64 kB. This can be used when debugging the library
(see the virLogBuffer variable content).</p>
<h3>
<a name="log_config">Configuring logging in the library</a>
</h3>
docs: grammar cleanups on logging examples * docs/logging.html.in: Fix spelling and grammar.
2010-09-23 05:34:17 +08:00
<p>The library configuration of logging is through 3 environment variables
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
allowing to control the logging behaviour:</p>
<ul>
<li>LIBVIRT_DEBUG: it can take the four following values:
<ul>
<li>1 or "debug": asking the library to log every message emitted,
though the filters can be used to avoid filling up the output</li>
<li>2 or "info": log all non-debugging informations</li>
<li>3 or "warn": log warnings and errors, that's the default value</li>
<li>4 or "error": log only error messages</li>
</ul></li>
docs: grammar cleanups on logging examples * docs/logging.html.in: Fix spelling and grammar.
2010-09-23 05:34:17 +08:00
<li>LIBVIRT_LOG_FILTERS: defines logging filters</li>
<li>LIBVIRT_LOG_OUTPUTS: defines logging outputs</li>
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
</ul>
Update logging documentation * docs/logging.html[.in] try to include a little more description about the corner cases, things someone might get hung up on on.
2009-08-06 21:58:38 +08:00
<p>Note that, for example, setting LIBVIRT_DEBUG= is the same as unset. If
you specify an invalid value, it will be ignored with a warning. If you
have an error in a filter or output string, some of the settings may be
applied up to the point at which libvirt encountered the error.</p>
Improve logging documentation including the debug buffer * docs/logging.html.in: document the fact that starting from 0.9.0 the server logs goes to libvirtd.log instead of syslog by default, describe the debug buffer, restructure the page and add a couple more examples
2011-03-17 15:30:49 +08:00
<h3>
<a name="log_daemon">Logging in the daemon</a>
</h3>
docs: grammar cleanups on logging examples * docs/logging.html.in: Fix spelling and grammar.
2010-09-23 05:34:17 +08:00
<p>Similarly the daemon logging behaviour can be tuned using 3 config
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
variables, stored in the configuration file:
<ul>
<li>log_level: accepts the following values:
<ul>
<li>4: only errors</li>
<li>3: warnings and errors</li>
<li>2: informations, warnings and errors</li>
<li>1: debug and everything</li>
</ul></li>
docs: grammar cleanups on logging examples * docs/logging.html.in: Fix spelling and grammar.
2010-09-23 05:34:17 +08:00
<li>log_filters: defines logging filters</li>
<li>log_outputs: defines logging outputs</li>
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
</ul>
Update logging documentation * docs/logging.html[.in] try to include a little more description about the corner cases, things someone might get hung up on on.
2009-08-06 21:58:38 +08:00
<p>When starting the libvirt daemon, any logging environment variable
settings will override settings in the config file. Command line options
take precedence over all. If no outputs are defined for libvirtd, it
Improve logging documentation including the debug buffer * docs/logging.html.in: document the fact that starting from 0.9.0 the server logs goes to libvirtd.log instead of syslog by default, describe the debug buffer, restructure the page and add a couple more examples
2011-03-17 15:30:49 +08:00
defaults to logging to /var/log/libvirt/libvirtd.log (before 0.9.0
it was using syslog) when it is running as a daemon, or to
Update logging documentation * docs/logging.html[.in] try to include a little more description about the corner cases, things someone might get hung up on on.
2009-08-06 21:58:38 +08:00
stderr when it is running in the foreground.</p>
<p>Libvirtd does not reload its logging configuration when issued a SIGHUP.
If you want to reload the configuration, you must do a <code>service
libvirtd restart</code> or manually stop and restart the daemon
yourself.</p>
Improve logging documentation including the debug buffer * docs/logging.html.in: document the fact that starting from 0.9.0 the server logs goes to libvirtd.log instead of syslog by default, describe the debug buffer, restructure the page and add a couple more examples
2011-03-17 15:30:49 +08:00
<p>Starting from 0.9.0, the daemon can save all the content of the debug
buffer to the defined error channels (or /var/log/libvirt/libvirtd.log
by default) in case of crash, this can also be activated explicitly
for debugging purposes by sending the daemon a USR2 signal:</p>
<pre>killall -USR2 libvirtd</pre>
<h3>
<a name="log_syntax">Syntax for filters and output values</a>
</h3>
Update logging documentation * docs/logging.html[.in] try to include a little more description about the corner cases, things someone might get hung up on on.
2009-08-06 21:58:38 +08:00
<p>The syntax for filters and outputs is the same for both types of
variables.</p>
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
<p>The format for a filter is:</p>
<pre>x:name</pre>
<p>where <code>name</code> is a match string e.g. <code>remote</code> or
<code>qemu</code> and the x is the minimal level where matching messages
should be logged:</p>
<ul>
<li>1: DEBUG</li>
<li>2: INFO</li>
<li>3: WARNING</li>
<li>4: ERROR</li>
</ul>
Update logging documentation * docs/logging.html[.in] try to include a little more description about the corner cases, things someone might get hung up on on.
2009-08-06 21:58:38 +08:00
<p>Multiple filters can be defined in a single string, they just need to be
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
separated by spaces, e.g: <code>"3:remote 4:event"</code> to only get
warning or errors from the remote layer and only errors from the event
layer.<p>
Update logging documentation * docs/logging.html[.in] try to include a little more description about the corner cases, things someone might get hung up on on.
2009-08-06 21:58:38 +08:00
<p>If you specify a log priority in a filter that is below the default log
priority level, messages that match that filter will still be logged,
while others will not. In order to see those messages, you must also have
an output defined that includes the priority level of your filter.</p>
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
<p>The format for an output can be one of those 3 forms:</p>
<ul>
<li><code>x:stderr</code> output goes to stderr</li>
<li><code>x:syslog:name</code> use syslog for the output and use the
given <code>name</code> as the ident</li>
docs: add 3 missing spaces
2010-02-21 21:56:23 +08:00
<li><code>x:file:file_path</code> output to a file, with the given
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
filepath</li>
</ul>
<p>In all cases the x prefix is the minimal level, acting as a filter:</p>
<ul>
<li>1: DEBUG</li>
<li>2: INFO</li>
<li>3: WARNING</li>
<li>4: ERROR</li>
</ul>
docs: grammar cleanups on logging examples * docs/logging.html.in: Fix spelling and grammar.
2010-09-23 05:34:17 +08:00
<p>Multiple output can be defined, they just need to be separated by
Various logging cleanups in code and doc * docs/logging.html[.in] qemud/libvirtd.conf qemud/qemud.c src/logging.[ch]: cleanup the logging code and docs to remove all references to log level 0, cleanup hardcoded values and add a default VIR_LOG_DEFAULT value, patch by Amy Griffis daniel
2009-07-01 19:21:15 +08:00
spaces, e.g.: <code>"3:syslog:libvirtd 1:file:/tmp/libvirt.log"</code>
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
will log all warnings and errors to syslog under the libvirtd ident
Improve logging documentation including the debug buffer * docs/logging.html.in: document the fact that starting from 0.9.0 the server logs goes to libvirtd.log instead of syslog by default, describe the debug buffer, restructure the page and add a couple more examples
2011-03-17 15:30:49 +08:00
but also log all debug and information included in the
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
file <code>/tmp/libvirt.log</code></p>
Improve logging documentation including the debug buffer * docs/logging.html.in: document the fact that starting from 0.9.0 the server logs goes to libvirtd.log instead of syslog by default, describe the debug buffer, restructure the page and add a couple more examples
2011-03-17 15:30:49 +08:00
<h3>
<a name="log_examples">Examples</a>
</h3>
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
<p>For example setting up the following:</p>
<pre>export LIBVIRT_DEBUG=1
Various logging cleanups in code and doc * docs/logging.html[.in] qemud/libvirtd.conf qemud/qemud.c src/logging.[ch]: cleanup the logging code and docs to remove all references to log level 0, cleanup hardcoded values and add a default VIR_LOG_DEFAULT value, patch by Amy Griffis daniel
2009-07-01 19:21:15 +08:00
export LIBVIRT_LOG_OUTPUTS="1:file:virsh.log"</pre>
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
<p>and then running virsh will accumulate the logs in the
<code>virsh.log</code> file in a way similar to:</p>
<pre>14:29:04.771: debug : virInitialize:278 : register drivers
14:29:04.771: debug : virRegisterDriver:618 : registering Test as driver 0</pre>
<p>the messages are timestamped, there is also the level recorded,
if debug the name of the function is also printed and then the formatted
message. This should be sufficient to at least get a precise idea of
what is happening and where things are going wrong, allowing to then
put the correct breakpoints when running under a debugger.</p>
Improve logging documentation including the debug buffer * docs/logging.html.in: document the fact that starting from 0.9.0 the server logs goes to libvirtd.log instead of syslog by default, describe the debug buffer, restructure the page and add a couple more examples
2011-03-17 15:30:49 +08:00
<p>To activate full debug of the libvirt entry points, utility
functions and the QEmu/KVM driver, set:</p>
<pre>log_filters=1:libvirt 1:util 1:qemu
log_output=1:file:/var/log/libvirt/libvirtd.log</pre>
<p>in libvirtd.conf and restart the daemon will allow to
gather a copious amount of debugging traces for the operations done
in those areas.</p>
<p>On the other hand to deactivate the logbuffer in the daemon
for stable high load servers, set</p>
<pre>log_buffer_size=0</pre>
<p>in the libvirtd.conf.</p>
* docs/logging.html docs/logging.html.in: new page documenting the logging system * docs/auth.html docs/deployment.html docs/remote.html docs/sitemap.html docs/sitemap.html.in docs/uri.html docs/windows.html: integration in the existing set Daniel
2008-12-23 21:47:10 +08:00
</body>
</html>