Mentions légales du service

Skip to content
Snippets Groups Projects
Commit 5ca37e89 authored by Jérôme Euzenat's avatar Jérôme Euzenat
Browse files

- documented the long awaited logging

parent 36366aa7
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
html/cli.html
+ 1
− 1
View file @ 5ca37e89
...@@ -214,7 +214,7 @@ results (<tt>GenPlot</tt>, <tt>GroupOutput</tt>) are described in the <a href="e ...@@ -214,7 +214,7 @@ results (<tt>GenPlot</tt>, <tt>GroupOutput</tt>) are described in the <a href="e
<address> <address>
<small> <small>
<hr /> <hr />
<center>http://alignapi.gforge.inria.fr/builtin.html</center> <center>http://alignapi.gforge.inria.fr/cli.html</center>
<hr /> <hr />
$Id$ $Id$
</small> </small>
......
html/logging.html 0 → 100644
+ 122
− 0
View file @ 5ca37e89
<html>
<head>
<title>Alignment API: Logging</title>
<!--style type="text/css">@import url(style.css);</style-->
<link rel="stylesheet" type="text/css" href="base.css" />
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body bgcolor="#ffffff">
<center><h1>Alignment API: Logging</h1></center>
<p>
The <a href="http://slf4j.org/docs.html">documentation of SLF4J</a> is
comprehensive and explain very well what logging is and how it can be
configured.
</p>
<p>
The implementation of the Alignment API uses logging though SLF4J.
</p>
<p>
What this means for the user is:
<ul>
<li>The API does not print on the standard or error output unless
requested by the user;</li>
<li>The user can control what kind of feedback he wants from the API
(and the libraries that it imports);</li>
<li>The user decides what logging facade it wants to use from SLF4J.</li>
<li>This can be obtained without recompiling anything</li>
</ul>
</p>
<h2>First run</h2>
<p>
The first command-line run should look like that:
<div class="terminal">
$ java -cp lib/procalign.jar fr.inrialpes.exmo.align.cli.ParserPrinter file:examples/rdf/newsample.rdf -o /tmp/toto.rdf
SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
</div>
</p>
<p>
This is actually fine. This means that no looger has been provided to
the system and that all logging instructions will be ineffective.
</p>
<h2>Getting log messages</h2>
<p>
To get log messages, it is necessary to:
<ul>
<li>have in the class path an implementation of a LoggerBinder</li>
<li>have in the current directory or path a configuration file.</li>
</ul>
None is provided by the alignment API, because it is not the
philosophy of logging.
</p>
<p>
As an example, one may
use <a href="http://logback.qos.ch/">logback</a>. For that purpose,
the files logback-core-VERS.jar and logback-classic-VERS.jar have to
be added to the classpath.
</p>
<p>
The result of the first command-line will be:
<div class="terminal">
$ java -cp lib/slf4j/logback-core-1.0.9.jar:lib/slf4j/logback-classic-1.0.9.jar:lib/procalign.jar fr.inrialpes.exmo.align.cli.ParserPrinter file:examples/rdf/newsample.rdf -o /tmp/toto.rdf
17:10:37.578 [main] DEBUG f.i.exmo.align.parser.XMLParser - startElement XMLParser : RDF
17:10:37.581 [main] DEBUG f.i.exmo.align.parser.XMLParser - content XMLParser :
17:10:37.581 [main] DEBUG f.i.exmo.align.parser.XMLParser - startElement XMLParser : Alignment
17:10:37.588 [main] DEBUG f.i.exmo.align.parser.XMLParser - content XMLParser :
17:10:37.588 [main] DEBUG f.i.exmo.align.parser.XMLParser - startElement XMLParser : xml
17:10:37.588 [main] DEBUG f.i.exmo.align.parser.XMLParser - content XMLParser : yes
17:10:37.588 [main] DEBUG f.i.exmo.align.parser.XMLParser - endElement XMLParser : xml
17:10:37.588 [main] DEBUG f.i.exmo.align.parser.XMLParser - content XMLParser :
...
</div>
The warning is not displayed anymore, but the logging messages sent by
the Alignment parser are now visible (and there are many).
</p>
<h2>Controling output</h2>
<p>
This output can be controlled easily through configuration file. For
instance, if one puts this minimal configuration file logback.xml:
<pre>
&lt;configuration>
&lt;root level="OFF"/>
&lt;/configuration>
</pre>
in the current directory, then the result of the command line is:
<div class="terminal">
$ java -cp lib/slf4j/logback-core-1.0.9.jar:lib/slf4j/logback-classic-1.0.9.jar:lib/procalign.jar:lib/procalign.jar:. fr.inrialpes.exmo.align.cli.ParserPrinter file:examples/rdf/newsample.rdf -o /tmp/toto.rdf
</div>
Note the "." added at the end of the class path for telling where to
find the logback.xml file.
</p>
<p>
From here the fun starts. <a href="http://logback.qos.ch/manual/configuration.html">Logging can be fully configured</a> at the level
of messages, classes, and packages.
By simply modifying the configuration file, one can selects which messages to receive.
This is worth mastering!
</p>
<address>
<small>
<hr />
<center>http://alignapi.gforge.inria.fr/logging.html</center>
<hr />
$Id$
</small>
</body>
</html>
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment