-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
workload: extend the command-line interface
Release note (cli change): The `cockroach workload` command now supports additional command-line parameters to customize the output, in order to facilitate the integration with 3rd party testing tools: - for tools that wish to observe the metrics more frequently than every second, a new flag `--display-every` is now supported, which can be used to specify the period between metric reports. This applies to both the JSON and textual output. - for tools that require a different output format than the default, a new `--display-format` argument is supported. For now only the formats "simple" (original output format) and "incremental-json" (RFC3339 timestamps, no summary row) are supported.
- Loading branch information
Showing
3 changed files
with
288 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| // Copyright 2019 The Cockroach Authors. | ||
| // | ||
| // Use of this software is governed by the Business Source License | ||
| // included in the file licenses/BSL.txt. | ||
| // | ||
| // As of the Change Date specified in that file, in accordance with | ||
| // the Business Source License, use of this software will be governed | ||
| // by the Apache License, Version 2.0, included in the file | ||
| // licenses/APL.txt. | ||
|
|
||
| package cli | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "io" | ||
| "time" | ||
|
|
||
| "github.com/cockroachdb/cockroach/pkg/workload/histogram" | ||
| ) | ||
|
|
||
| // outputFormat is the interface used to output results incrementally | ||
| // during a workload run. | ||
| type outputFormat interface { | ||
| // rampDone is called once when the ramp-up period completes, if | ||
| // configured. | ||
| rampDone() | ||
| // outputError is called when an error is encountered. | ||
| outputError(err error) | ||
| // outputTick is called when the main loop considers it useful | ||
| // to emit one row of results. | ||
| outputTick(startElapsed time.Duration, t histogram.Tick) | ||
| // outputTotal is called at the end, using the main histogram | ||
| // collector. | ||
| outputTotal(startElapsed time.Duration, t histogram.Tick) | ||
| // outputResult is called at the end, using the result histogram | ||
| // collector. | ||
| outputResult(startElapsed time.Duration, t histogram.Tick) | ||
| } | ||
|
|
||
| // textFormatter produces output meant for quick parsing by humans. The | ||
| // data is printed as fixed-width columns. Summary rows | ||
| // are printed at the end. | ||
| type textFormatter struct { | ||
| i int | ||
| numErr int | ||
| } | ||
|
|
||
| func (f *textFormatter) rampDone() { | ||
| f.i = 0 | ||
| } | ||
|
|
||
| func (f *textFormatter) outputError(_ error) { | ||
| f.numErr++ | ||
| } | ||
|
|
||
| func (f *textFormatter) outputTick(startElapsed time.Duration, t histogram.Tick) { | ||
| if f.i%20 == 0 { | ||
| fmt.Println("_elapsed___errors__ops/sec(inst)___ops/sec(cum)__p50(ms)__p95(ms)__p99(ms)_pMax(ms)") | ||
| } | ||
| f.i++ | ||
| fmt.Printf("%7.1fs %8d %14.1f %14.1f %8.1f %8.1f %8.1f %8.1f %s\n", | ||
| startElapsed.Seconds(), | ||
| f.numErr, | ||
| float64(t.Hist.TotalCount())/t.Elapsed.Seconds(), | ||
| float64(t.Cumulative.TotalCount())/startElapsed.Seconds(), | ||
| time.Duration(t.Hist.ValueAtQuantile(50)).Seconds()*1000, | ||
| time.Duration(t.Hist.ValueAtQuantile(95)).Seconds()*1000, | ||
| time.Duration(t.Hist.ValueAtQuantile(99)).Seconds()*1000, | ||
| time.Duration(t.Hist.ValueAtQuantile(100)).Seconds()*1000, | ||
| t.Name, | ||
| ) | ||
| } | ||
|
|
||
| const totalHeader = "\n_elapsed___errors_____ops(total)___ops/sec(cum)__avg(ms)__p50(ms)__p95(ms)__p99(ms)_pMax(ms)" | ||
|
|
||
| func (f *textFormatter) outputTotal(startElapsed time.Duration, t histogram.Tick) { | ||
| f.outputFinal(startElapsed, t, "__total") | ||
| } | ||
|
|
||
| func (f *textFormatter) outputResult(startElapsed time.Duration, t histogram.Tick) { | ||
| f.outputFinal(startElapsed, t, "__result") | ||
| } | ||
|
|
||
| func (f *textFormatter) outputFinal( | ||
| startElapsed time.Duration, t histogram.Tick, titleSuffix string, | ||
| ) { | ||
| fmt.Println(totalHeader + titleSuffix) | ||
| if t.Cumulative == nil { | ||
| return | ||
| } | ||
| if t.Cumulative.TotalCount() == 0 { | ||
| return | ||
| } | ||
| fmt.Printf("%7.1fs %8d %14d %14.1f %8.1f %8.1f %8.1f %8.1f %8.1f %s\n", | ||
| startElapsed.Seconds(), | ||
| f.numErr, | ||
| t.Cumulative.TotalCount(), | ||
| float64(t.Cumulative.TotalCount())/startElapsed.Seconds(), | ||
| time.Duration(t.Cumulative.Mean()).Seconds()*1000, | ||
| time.Duration(t.Cumulative.ValueAtQuantile(50)).Seconds()*1000, | ||
| time.Duration(t.Cumulative.ValueAtQuantile(95)).Seconds()*1000, | ||
| time.Duration(t.Cumulative.ValueAtQuantile(99)).Seconds()*1000, | ||
| time.Duration(t.Cumulative.ValueAtQuantile(100)).Seconds()*1000, | ||
| t.Name, | ||
| ) | ||
| } | ||
|
|
||
| // jsonFormatter produces output that is machine-readable. The time is | ||
| // printed using absolute timestamps. No summary row is printed at the | ||
| // end. | ||
| type jsonFormatter struct { | ||
| w io.Writer | ||
| numErr int | ||
| } | ||
|
|
||
| func (f *jsonFormatter) rampDone() {} | ||
|
|
||
| func (f *jsonFormatter) outputError(_ error) { | ||
| f.numErr++ | ||
| } | ||
|
|
||
| func (f *jsonFormatter) outputTick(startElapsed time.Duration, t histogram.Tick) { | ||
| // Note: we use fmt.Printf here instead of json.Marshal to ensure | ||
| // that float values do not get printed with a uselessly large | ||
| // number of decimals. | ||
| fmt.Fprintf(f.w, `{"time":"%s",`+ | ||
| `"errs":%d,`+ | ||
| `"avgt":%.1f,`+ | ||
| `"avgl":%.1f,`+ | ||
| `"p50l":%.1f,`+ | ||
| `"p95l":%.1f,`+ | ||
| `"p99l":%.1f,`+ | ||
| `"maxl":%.1f,`+ | ||
| `"type":"%s"`+ | ||
| "}\n", | ||
| t.Now.UTC().Format(time.RFC3339Nano), | ||
| f.numErr, | ||
| float64(t.Hist.TotalCount())/t.Elapsed.Seconds(), | ||
| float64(t.Cumulative.TotalCount())/startElapsed.Seconds(), | ||
| time.Duration(t.Hist.ValueAtQuantile(50)).Seconds()*1000, | ||
| time.Duration(t.Hist.ValueAtQuantile(95)).Seconds()*1000, | ||
| time.Duration(t.Hist.ValueAtQuantile(99)).Seconds()*1000, | ||
| time.Duration(t.Hist.ValueAtQuantile(100)).Seconds()*1000, | ||
| t.Name, | ||
| ) | ||
| } | ||
|
|
||
| func (f *jsonFormatter) outputTotal(startElapsed time.Duration, t histogram.Tick) {} | ||
|
|
||
| func (f *jsonFormatter) outputResult(startElapsed time.Duration, t histogram.Tick) {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| // Copyright 2019 The Cockroach Authors. | ||
| // | ||
| // Use of this software is governed by the Business Source License | ||
| // included in the file licenses/BSL.txt. | ||
| // | ||
| // As of the Change Date specified in that file, in accordance with | ||
| // the Business Source License, use of this software will be governed | ||
| // by the Apache License, Version 2.0, included in the file | ||
| // licenses/APL.txt. | ||
|
|
||
| package cli | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "os" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/cockroachdb/cockroach/pkg/util/leaktest" | ||
| "github.com/cockroachdb/cockroach/pkg/workload/histogram" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func Example_text_formatter() { | ||
| testFormatter(&textFormatter{}) | ||
|
|
||
| // output: | ||
| // _elapsed___errors__ops/sec(inst)___ops/sec(cum)__p50(ms)__p95(ms)__p99(ms)_pMax(ms) | ||
| // 0.5s 0 2.0 2.0 503.3 503.3 503.3 503.3 read | ||
| // 1.5s 0 0.7 1.3 335.5 335.5 335.5 335.5 read | ||
| // | ||
| // _elapsed___errors_____ops(total)___ops/sec(cum)__avg(ms)__p50(ms)__p95(ms)__p99(ms)_pMax(ms)__total | ||
| // 2.0s 0 2 1.0 411.0 335.5 503.3 503.3 503.3 read | ||
| // | ||
| // _elapsed___errors_____ops(total)___ops/sec(cum)__avg(ms)__p50(ms)__p95(ms)__p99(ms)_pMax(ms)__result | ||
| // 4.0s 0 2 0.5 411.0 335.5 503.3 503.3 503.3 woo | ||
| } | ||
|
|
||
| func Example_json_formatter() { | ||
| testFormatter(&jsonFormatter{w: os.Stdout}) | ||
|
|
||
| // output: | ||
| // {"time":"0001-01-01T00:00:00.5Z","errs":0,"avgt":2.0,"avgl":2.0,"p50l":503.3,"p95l":503.3,"p99l":503.3,"maxl":503.3,"type":"read"} | ||
| // {"time":"0001-01-01T00:00:01.5Z","errs":0,"avgt":0.7,"avgl":1.3,"p50l":335.5,"p95l":335.5,"p99l":335.5,"maxl":335.5,"type":"read"} | ||
| } | ||
|
|
||
| func testFormatter(formatter outputFormat) { | ||
| reg := histogram.NewRegistry(time.Second) | ||
|
|
||
| start := time.Time{} | ||
|
|
||
| reg.GetHandle().Get("read").Record(time.Second / 2) | ||
| reg.Tick(func(t histogram.Tick) { | ||
| // Make output deterministic. | ||
| t.Elapsed = time.Second / 2 | ||
| t.Now = start.Add(t.Elapsed) | ||
|
|
||
| formatter.outputTick(t.Elapsed, t) | ||
| }) | ||
|
|
||
| reg.GetHandle().Get("read").Record(time.Second / 3) | ||
| reg.Tick(func(t histogram.Tick) { | ||
| // ditto. | ||
| t.Elapsed = 3 * time.Second / 2 | ||
| t.Now = start.Add(t.Elapsed) | ||
|
|
||
| formatter.outputTick(t.Elapsed, t) | ||
| }) | ||
|
|
||
| resultTick := histogram.Tick{Name: "woo"} | ||
| reg.Tick(func(t histogram.Tick) { | ||
| // ditto. | ||
| t.Elapsed = 2 * time.Second | ||
| t.Now = start.Add(t.Elapsed) | ||
|
|
||
| formatter.outputTotal(t.Elapsed, t) | ||
| resultTick.Now = t.Now | ||
| resultTick.Cumulative = t.Cumulative | ||
| }) | ||
| formatter.outputResult(4*time.Second, resultTick) | ||
| } | ||
|
|
||
| // TestJSONStructure ensures that the JSON output is parsable. | ||
| func TestJSONStructure(t *testing.T) { | ||
| defer leaktest.AfterTest(t)() | ||
|
|
||
| var buf bytes.Buffer | ||
| f := jsonFormatter{w: &buf} | ||
| reg := histogram.NewRegistry(time.Second) | ||
|
|
||
| start := time.Time{} | ||
|
|
||
| reg.GetHandle().Get("read").Record(time.Second / 2) | ||
| reg.Tick(func(t histogram.Tick) { | ||
| // Make output deterministic. | ||
| t.Elapsed = time.Second | ||
| t.Now = start.Add(t.Elapsed) | ||
|
|
||
| f.outputTick(time.Second, t) | ||
| }) | ||
|
|
||
| const expected = ` | ||
| { | ||
| "time":"0001-01-01T00:00:01Z", | ||
| "avgl":1, | ||
| "avgt":1, | ||
| "errs":0, | ||
| "maxl":503.3, | ||
| "p50l":503.3, | ||
| "p95l":503.3, | ||
| "p99l":503.3, | ||
| "type":"read" | ||
| }` | ||
| require.JSONEq(t, expected, buf.String()) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters