check

command
v0.8.1-rc2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 16, 2026 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Command bench-check audits coverage of per-RPC benchmarks against the taprpc proto surface. It parses every .proto file under taprpc/, lists the RPC methods, and reports which methods do not have a corresponding Benchmark* function under bench/rpc/.

Each Benchmark function declares which RPC it covers via a directive comment in its doc:

// bench:rpc=<package>.<Service>.<Method>

e.g. // bench:rpc=universerpc.Universe.Info. Function names are never matched against RPCs directly because names are not service-qualified — a Benchmark named "BenchmarkInfo" would silently false-cover Info methods on multiple services.

Methods may opt out of the audit by adding a line to the proto file directly above the rpc definition of the form:

// bench:skip(reason)

Whole services may be skipped by adding the fully-qualified service name to skippedServices below. tapchannelrpc is excluded for the first pass because it depends on tap-channel subsystems for which no in-process fixture exists.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL