From 3bcae5e84bd4d0df7e9f8168797040fc5e0defe0 Mon Sep 17 00:00:00 2001 From: neonphog Date: Tue, 22 Oct 2024 13:15:40 -0600 Subject: [PATCH] address code review comment --- scenarios/remote_signals/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/scenarios/remote_signals/README.md b/scenarios/remote_signals/README.md index f023704..1f9d947 100644 --- a/scenarios/remote_signals/README.md +++ b/scenarios/remote_signals/README.md @@ -4,6 +4,16 @@ This scenario tests the throughput of `remote_signals` operations. +Two environment variables can further control this scenario: + +- `SIGNAL_INTERVAL_MS` - the interval (in ms) per node at which to publish origin signals (defaults to 1000, or 1 signal every second) +- `RESPONSE_TIMEOUT_MS` - the interval (in ms) at which we will stop waiting for a response signal and record a `remote_signal_timeout` metric (see below). + +Two custom metrics are recorded: + +- `wt.custom.remote_signal_round_trip`: The time in floating-point seconds from origin signal dispatch to origin receive of the remote side's response signal. +- `wt.custom.remote_signal_timeout`: A counter (value 1) recorded every time there is a timeout waiting for the response signal. (Defaults to 20 seconds--see above) + > [!WARNING] > This is a TryCP-based scenario and needs to be run differently to other scenarios.