validations-common/doc/source/modules/modules-callbacks-http_json.rst
Gael Chamoulaud (Strider) a92c1d2170 Add validation-common documentation structure
The doc structure from validations-libs was transposed
and slightly altered.

Future expansion of documentation is expected.

Change-Id: Ib1043cf1bef5d9b858da8f9a83fbba52bb570b99
Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
Signed-off-by: Jiri Podivin <jpodivin@redhat.com>
2021-02-15 14:58:05 +01:00

30 lines
912 B
ReStructuredText
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

==================
http_json callback
==================
The callback http_json sends Validations logs and information to an HTTP
server as a JSON format in order to get caught and analysed with external
tools for log parsing (as Fluentd or others).
This callback inherits from validation_json the format of the logging
remains the same as the other logger that the Validation Framework is using
by default.
To enable this callback, you need to add it to the callback whitelist.
Then you need to export your http server url and port.
.. code-block:: console
export HTTP_JSON_SERVER=http://localhost
export HTTP_JSON_PORT=8989
The callback will post JSON log to the URL provided.
This repository has a simple HTTP server for testing purpose under:
.. code-block:: console
tools/http_server.py
The default host and port are localhost and 8989, feel free to adjust those
values to your needs.