From fd8ff7d682205051ac18923788c35c44f943a217 Mon Sep 17 00:00:00 2001 From: apolcyn Date: Wed, 15 Jun 2022 09:58:28 -0700 Subject: [PATCH] Document logging format from interop soak tests (#30012) * Document logging format of interop soak tests --- doc/interop-test-descriptions.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/interop-test-descriptions.md b/doc/interop-test-descriptions.md index b04b0507b80..a19bedf5074 100755 --- a/doc/interop-test-descriptions.md +++ b/doc/interop-test-descriptions.md @@ -1012,6 +1012,16 @@ debugging in case of failure. For example, if RPC deadlines are set to `soak_per_iteration_max_acceptable_latency_ms` and one of the RPCs hits that deadline, it's not clear if the RPC was late by a millisecond or a minute. +In order to make it easy to analyze results, implementations should log the +results of each iteration (i.e. RPC) in a format the matches the following +regexes: + +- Upon success: + - `soak iteration: \d+ elapsed_ms: \d+ peer: \S+ succeeded` + +- Upon failure: + - `soak iteration: \d+ elapsed_ms: \d+ peer: \S+ failed:` + This test must be configurable via a few different command line flags: * `soak_iterations`: Controls the number of RPCs to perform. This should