commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jsde...@apache.org
Subject cvs commit: jakarta-commons/httpclient/xdocs logging.xml contributors.xml
Date Fri, 02 Aug 2002 19:45:31 GMT
jsdever     2002/08/02 12:45:31

  Modified:    httpclient/xdocs contributors.xml
  Added:       httpclient/xdocs logging.xml
  Log:
  Some documentation additions.
  
  Revision  Changes    Path
  1.6       +2 -1      jakarta-commons/httpclient/xdocs/contributors.xml
  
  Index: contributors.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/xdocs/contributors.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- contributors.xml	19 Jul 2002 22:32:45 -0000	1.5
  +++ contributors.xml	2 Aug 2002 19:45:31 -0000	1.6
  @@ -23,6 +23,7 @@
               <li>Joerg Gambihler</li>
               <li>Warren Gavin</li>
               <li>dIon Gillard</li>
  +            <li>Ortwin Glück</li>
               <li>Xiaowei Jiang</li>
               <li>Rainer Klute</li>
               <li>Ryan Lubke</li>
  
  
  
  1.1                  jakarta-commons/httpclient/xdocs/logging.xml
  
  Index: logging.xml
  ===================================================================
  <?xml version="1.0"?>
  <document>
     <properties>
        <title>HttpClient Logging Practices</title>
        <author email="jsdever@apache.org">Jeff Dever</author>
        <revision>$Id: logging.xml,v 1.1 2002/08/02 19:45:31 jsdever Exp $</revision>
     </properties>
  
     <body>
        <section name="Logging Practices">
           <p>
              <em>HttpClient</em> utilized the logging interface provided by the
              <a href="http://jakarta.apache.org/commons/logging.html">
              Jakarta Commons Logging</a> package.  Commons Logging provides
              a simple and generalized 
              <a href="http://jakarta.apache.org/commons/logging/api/index.html">
              log interface</a> to various logging packages.  By using the
              Commons Logging configuration, HttpClient can be configured
              for a variety of logging behaviours.
           </p><p>
              There are two specific types of loggers used within
              <em>HttpClient</em>: the standard <code>log</code> used
for each 
              class and the <code>wireLog</code> used for wire messages.  
              Commons Logging allows for various logging systems to do the
              actual output.  The most basic is SimpleLog which uses stdout
              to write log messages.  All the following examples are shown with
              SimpleLog to highlight the utility withing <em>HttpClient</em>
           </p><p>
              <u>log</u><br>
              The logging output can be configured on a class by class basis if
              desired.  This is accomplished by setting a system property for
              each class.  For example, if you wanted to see extremely detailed 
              information on authentication routines, you could turn up the 
              logging level for the Authenticator by setting the following 
              property:<br>
              org.apache.commons.logging.simplelog.log.org.apache.commons.httpclient.Authenticator=trace
           </p><p>
              <u>wireLog</u><br>
              There is one log that cuts across several classes that is used for
              logging wire messages.  <i>Careful when turning this on as 
              potentially a huge volume of data may be written, some of it in 
              binary format.</i><br>
              org.apache.commons.logging.simplelog.log.httpclient.wire=debug
           </p><p>
              TODO: put the logging guidelines here
           </p>
  
  
           <ul>
              <li>
              </li>
              <br/>&#xA0;
              <li>
              </li>
              <br/>&#xA0;
              <li>
              </li>
           </ul>
        </section>
     </body>
  </document>
  
  
  

--
To unsubscribe, e-mail:   <mailto:commons-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:commons-dev-help@jakarta.apache.org>


Mime
View raw message