RepoMirrors
/
nvchecker
mirror of https://github.com/lilydjwg/nvchecker
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update README on JSON logging

This commit is contained in:
lilydjwg 2018-05-09 14:34:32 +08:00
parent 79c3c934ce
commit b3897a1235
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.rst
View File

@ -12,6 +12,9 @@ Contents
* `Dependency <#dependency>`_ * `Dependency <#dependency>`_
* `Running <#running>`_ * `Running <#running>`_
* `JSON logging <#json-logging>`_
* `Version Record Files <#version-record-files>`_ * `Version Record Files <#version-record-files>`_
* `The nvtake Command <#the-nvtake-command>`_ * `The nvtake Command <#the-nvtake-command>`_
@ -69,6 +72,30 @@ Run with one or more software version source files::
You normally will like to specify some "version record files"; see below. You normally will like to specify some "version record files"; see below.
JSON logging
------------
With ``--logger=json`` or ``--logger=both``, you can get a structured logging
for programmatically consuming. You can use ``--json-log-fd=N`` to specify the
file descriptor to send logs to (take care to do line buffering). The logging
level option (``-l`` or ``--logging``) doesn't take effect with this.
The JSON log is one JSON string per line. The following documented events and
fields are stable, undocumented ones may change without notice.
event=updated
An update is detected. Fields ``name``, ``old_version`` and ``version`` are
available. ``old_version`` maybe ``null``.
event=up-to-date
There is no update. Fields ``name`` and ``version`` are available.
event=no-result
No version is detected. There may be an error. Fields ``name`` is available.
level=error
There is an error. Fields ``name`` and ``exc_info`` may be available to give
further information.
Version Record Files Version Record Files
==================== ====================
Version record files record which version of the software you know or is available. They are simple key-value pairs of ``(name, version)`` separated by a space:: Version record files record which version of the software you know or is available. They are simple key-value pairs of ``(name, version)`` separated by a space::