qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-16 21:04:45 -07:00
Code Releases Activity

runtime/pprof: Mention goroutine label heritability

Browse Source 
Document goroutine label inheritance. Goroutine labels are copied upon
goroutine creation and there is a test enforcing this, but it was not
mentioned in the docstrings for `Do` or `SetGoroutineLabels`.

Add notes to both of those functions' docstrings so it's clear that one
does not need to set labels as soon as a new goroutine is spawned if
they want to propagate tags.

Updates #32223
Updates #23458

Change-Id: Idfa33031af0104b884b03ca855ac82b98500c8b4
Reviewed-on: https://go-review.googlesource.com/c/go/+/189317
Reviewed-by: Ian Lance Taylor <iant@golang.org>
This commit is contained in:
David Finkel 2019-07-31 09:10:28 -04:00 committed by Ian Lance Taylor
parent e37a1b1ca6
commit 0ca4f6be35
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/runtime/pprof/runtime.go
View File

@ -16,6 +16,7 @@ func runtime_setProfLabel(labels unsafe.Pointer)
func runtime_getProfLabel() unsafe.Pointer
// SetGoroutineLabels sets the current goroutine's labels to match ctx.
// A new goroutine inherits the labels of the goroutine that created it.
// This is a lower-level API than Do, which should be used instead when possible.
func SetGoroutineLabels(ctx context.Context) {
ctxLabels, _ := ctx.Value(labelContextKey{}).(*labelMap)
@ -24,6 +25,7 @@ func SetGoroutineLabels(ctx context.Context) {
// Do calls f with a copy of the parent context with the
// given labels added to the parent's label map.
// Goroutines spawned while executing f will inherit the augmented label-set.
// Each key/value pair in labels is inserted into the label map in the
// order provided, overriding any previous value for the same key.
// The augmented label map will be set for the duration of the call to f