tsweb: update doc on BucketedStatsOptions.Finish to match behavior

raggi · raggi · commit 9eaa56df9326 · 2024-04-02T17:22:59.000-07:00
I originally came to update this to match the documented behavior, but
the code is deliberately avoiding this behavior currently, making it
hard to decide how to update this. For now just align the documentation
to the behavior.

Updates #cleanup

Signed-off-by: James Tucker &lt;james@tailscale.com&gt;
diff --git a/tsweb/tsweb.go b/tsweb/tsweb.go
@@ -189,7 +189,8 @@ type BucketedStatsOptions struct {
 	Started *metrics.LabelMap
 
 	// If non-nil, Finished maintains a counter of all requests which
-	// have finished processing (that is, the HTTP handler has returned).
+	// have finished processing with success (that is, the HTTP handler has
+	// returned).
 	Finished *metrics.LabelMap
 }
 

Original file line number	Diff line number	Diff line change
`@@ -189,7 +189,8 @@ type BucketedStatsOptions struct {`
`189`	`189`	`Started *metrics.LabelMap`
`190`	`190`
`191`	`191`	`// If non-nil, Finished maintains a counter of all requests which`
`192`		`- // have finished processing (that is, the HTTP handler has returned).`
	`192`	`+ // have finished processing with success (that is, the HTTP handler has`
	`193`	`+ // returned).`
`193`	`194`	`Finished *metrics.LabelMap`
`194`	`195`	`}`
`195`	`196`