From f861cda57c40e35b87b875cc10655adc4f4d75e1 Mon Sep 17 00:00:00 2001 From: Sorin Sbarnea Date: Tue, 18 Feb 2020 09:28:02 +0000 Subject: [PATCH] Improve 3rd-party logging guidelines Based on #openstack-infra talks from Feb 17th, I am proposing some clarifications regarding how logging should be done by 3rd party CI. These should help 3rd party integrators create a better experience for developers, making logs more accessible. Change-Id: I2ebc788505ba1319afc038d0aa1406da3823a911 --- doc/source/third_party.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/doc/source/third_party.rst b/doc/source/third_party.rst index 39d5a1c370..8d6e2a21f0 100644 --- a/doc/source/third_party.rst +++ b/doc/source/third_party.rst @@ -71,8 +71,17 @@ Requirements * OpenStack logs * Tempest logs (including ``testr_results.html.gz``) - * logs must be browsable; logs requiring download, installation or login - to access are not acceptable +* Logs must be ``browsable`` and ``accessible``. + + * Logs requiring download, installation or login to access are not acceptable + * Big log files, like over ``10MB`` can be pre-compressed as they are + unlikely to be loadable by browsers. + * Single log archives can be used in exceptional cases where both, the + number of files and their size makes web browsing impractical. Even if this + approach is taken, attention must be made to assure that important files + that are often needed are not hidden inside the archive, forcing users to + download the entire archive in order to check just one file. + * ``.html`` files should not be compressed. .. note:: All test artifacts must be retained for one month.