From 6feb14302f4aa9da8808426c9ddb10eced5cf32a Mon Sep 17 00:00:00 2001 From: Bojan Date: Fri, 1 Nov 2019 12:50:35 -0300 Subject: [PATCH] Add note about measurement to docs --- www/docs/options.md | 2 +- www/docs/output.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/www/docs/options.md b/www/docs/options.md index 71b29aff..5dcbef2e 100644 --- a/www/docs/options.md +++ b/www/docs/options.md @@ -24,7 +24,7 @@ If no `-proto` or `-protoset` options are used, we attempt to perform server ref ### `--call` -A fully-qualified method name in 'package.Service/Method' or 'package.Service.Method' format. For example: `helloworld.Greeter.SayHello`. +A fully-qualified method name in 'package.Service/Method' or 'package.Service.Method' format. For example: `helloworld.Greeter.SayHello`. With regard to measurement, we use [WithStatsHandler](https://godoc.org/google.golang.org/grpc#WithStatsHandler) option to capture call metrics. Specifically we only capture the [End](https://godoc.org/google.golang.org/grpc/stats#End) event which contains stats when an RPC ends. This should include the download of the payload and deserializing of the data. ### `--cacert` diff --git a/www/docs/output.md b/www/docs/output.md index 1fba8ef7..5013ec96 100644 --- a/www/docs/output.md +++ b/www/docs/output.md @@ -58,6 +58,8 @@ Explanation of the summary: - `average` - The mathematical average computed by taking the _sum_ of the _individual_ response times of _all_ requests and dividing it by the total number of requests. - `requests/sec` - Theoretical computed RPS computed by taking the total number of requests (successful and failed) and dividing it by the total duration of the test. That is: `count` / `total`. +With regard to measurement, we use [WithStatsHandler](https://godoc.org/google.golang.org/grpc#WithStatsHandler) option to capture call metrics. Specifically we only capture the [End](https://godoc.org/google.golang.org/grpc/stats#End) event which contains stats when an RPC ends. This should include the download of the payload and deserializing of the data. + ### CSV Alternatively with `-O csv` flag we can get detailed listing in csv format: