Changeset 499:63397d38a1aa for doc

Show
Ignore:
Timestamp:
10/14/08 17:47:38 (3 months ago)
Author:
Brian Warner <warner@allmydata.com>
branch:
default
Message:

logfiles: include PID in 'flogtool tail' savefiles and incident reports. Part of #80.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • doc/specifications/logfiles.xhtml

    r431 r499  
    208208<h3>flogtool tail</h3> 
    209209 
    210 <p>The header dict produced by <code>flogtool tail</code> does not contain 
    211 any additional keys at this time.</p> 
     210<p>The header dict produced by <code>flogtool tail</code> contains the 
     211following additional keys:</p> 
     212 
     213<ul> 
     214  <li><code>pid</code> (int): if present, this value contains the process id 
     215  of the process which was being followed by 'flogtool tail'.</li> 
     216 
     217  <li><code>versions</code> (dict): this contains a dictionary of component 
     218  versions, mapping a string component name like "foolscap" to a version 
     219  string.</li> 
     220</ul> 
    212221 
    213222<h3>log-gatherer</h3> 
    …… 
    237246  the incident. This event will also be present somewhere in the rest of the 
    238247  logfile, at its normal position in the event stream. </li> 
     248 
     249  <li><code>pid</code> (int): this value contains the process id of the 
     250  process which experienced the incident.</li> 
     251 
     252  <li><code>versions</code> (dict): this contains a dictionary of component 
     253  versions, mapping a string component name like "foolscap" to a version 
     254  string.</li> 
    239255</ul> 
    240256