document tags

Author: W-A-James

test/benchmarks/driver_bench/readme.md

@@ -51,13 +51,30 @@ type BenchmarkModule = {
   run: () => Promise<void>;
   afterEach?: () => Promise<void>;
   after?: () => Promise<void>;
+
+  tags?: string[];
 };
 ```
 
 Just like mocha we have once before and once after as well as before each and after each hooks.
 
 The `driver.mts` module is intended to hold various helpers for setup and teardown and help abstract some of the driver API.
 
+## Benchmark tags
+The `tags` property of `BenchmarkModule` is where a benchmark's tags should be added to facilitate
+performance alerting and filter of results via our internal tools.
+
+Tags are defined in `driver.mts` and should end with a _TAG suffix.
+Whenever a new tag is defined it should be documented in the table below .
+
+| tag variable name |    tag string value    |                                                               purpose                                                                |
+|-------------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
+|     `SPEC_TAG`    | `'spec-benchmark'`     | Special tag that marks a benchmark as a spec-required benchmark                                                                      |
+|     `ALERT_TAG`   | `'alerting-benchmark'` | Special tag that enables our perf monitoring tooling to create alerts when regressions in this benchmark's performance are detected  |
+|     `CURSOR_TAG`  | `'cursor-benchmark'`   | Tag marking a benchmark as being related to cursor performance                                                                       |
+|     `READ_TAG`    | `'read-benchmark'`     | Tag marking a benchmark as being related to read performance                                                                         |
+|     `WRITE_TAG`   | `'write-benchmark'`    | Tag marking a benchmark as being related to write performance                                                                        |
+
 ## Wishlist
 
 - Make it so runner can handle: `./lib/suites/multi_bench/grid_fs_upload.mjs` as an argument so shell path autocomplete makes it easier to pick a benchmark

test/benchmarks/driver_bench/src/driver.mts

@@ -7,10 +7,16 @@ import process from 'node:process';
 const __dirname = import.meta.dirname;
 const require = module.createRequire(__dirname);
 
+// Special tag that marks a benchmark as a spec-required benchmark
 export const SPEC_TAG = 'spec-benchmark';
+// Special tag that enables our perf monitoring tooling to create alerts when regressions in this
+// benchmark's performance are detected
 export const ALERT_TAG = 'alerting-benchmark';
+// Tag marking a benchmark as being related to cursor performance
 export const CURSOR_TAG = 'cursor-benchmark';
+// Tag marking a benchmark as being related to read performance
 export const READ_TAG = 'read-benchmark';
+// Tag marking a benchmark as being related to write performance
 export const WRITE_TAG = 'write-benchmark';
 
 export const NORMALIZED_PING_SCALING_CONST = 1000;