Bug 978108 - Update documentation for strucured logging. r=wlach

This commit is contained in:
James Graham 2014-02-27 19:04:45 +00:00
parent a45bd3b24a
commit 3f252cfa2a
2 changed files with 11 additions and 0 deletions

View File

@ -5,6 +5,11 @@ Mozlog is a python package intended to simplify and standardize logs
in the Mozilla universe. It wraps around python's logging module and
adds some additional functionality.
.. note::
For the purposes of logging results and other output from test runs,
:doc:`mozlog.structured<mozlog_structured>` should now be used
instead of this module.
.. automodule:: mozlog
:members: getLogger

View File

@ -57,6 +57,12 @@ emitted:
``tests``
A list of test_ids (list).
``run_info``
An optional dictionary describing the properties of the
build and test environment. This contains the information provided
by :doc:`mozinfo <mozinfo>`, plus a boolean ``debug`` field indicating
whether the build under test is a debug build.
``suite_end``
Emitted when the testsuite is finished and no more results will be produced.