mirror of
https://github.com/zrepl/zrepl.git
synced 2024-12-23 07:28:57 +01:00
10a14a8c50
package trace:
- introduce the concept of tasks and spans, tracked as linked list within ctx
- see package-level docs for an overview of the concepts
- **main feature 1**: unique stack of task and span IDs
- makes it easy to follow a series of log entries in concurrent code
- **main feature 2**: ability to produce a chrome://tracing-compatible trace file
- either via an env variable or a `zrepl pprof` subcommand
- this is not a CPU profile, we already have go pprof for that
- but it is very useful to visually inspect where the
replication / snapshotter / pruner spends its time
( fixes #307 )
usage in package daemon/logging:
- goal: every log entry should have a trace field with the ID stack from package trace
- make `logging.GetLogger(ctx, Subsys)` the authoritative `logger.Logger` factory function
- the context carries a linked list of injected fields which
`logging.GetLogger` adds to the logger it returns
- `logging.GetLogger` also uses package `trace` to get the
task-and-span-stack and injects it into the returned logger's fields
54 lines
1.2 KiB
Go
54 lines
1.2 KiB
Go
package trace
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
"sync"
|
|
|
|
"github.com/willf/bitset"
|
|
)
|
|
|
|
type uniqueConcurrentTaskNamer struct {
|
|
mtx sync.Mutex
|
|
active map[string]*bitset.BitSet
|
|
}
|
|
|
|
// bitvecLengthGauge may be nil
|
|
func newUniqueTaskNamer() *uniqueConcurrentTaskNamer {
|
|
return &uniqueConcurrentTaskNamer{
|
|
active: make(map[string]*bitset.BitSet),
|
|
}
|
|
}
|
|
|
|
// appends `#%d` to `name` such that until `done` is called,
|
|
// it is guaranteed that `#%d` is not returned a second time for the same `name`
|
|
func (namer *uniqueConcurrentTaskNamer) UniqueConcurrentTaskName(name string) (uniqueName string, done func()) {
|
|
if strings.Contains(name, "#") {
|
|
panic(name)
|
|
}
|
|
namer.mtx.Lock()
|
|
act, ok := namer.active[name]
|
|
if !ok {
|
|
act = bitset.New(64) // FIXME magic const
|
|
namer.active[name] = act
|
|
}
|
|
id, ok := act.NextClear(0)
|
|
if !ok {
|
|
// if !ok, all bits are 1 and act.Len() returns the next bit
|
|
id = act.Len()
|
|
// FIXME unbounded growth without reclamation
|
|
}
|
|
act.Set(id)
|
|
namer.mtx.Unlock()
|
|
|
|
return fmt.Sprintf("%s#%d", name, id), func() {
|
|
namer.mtx.Lock()
|
|
defer namer.mtx.Unlock()
|
|
act, ok := namer.active[name]
|
|
if !ok {
|
|
panic("must be initialized upon entry")
|
|
}
|
|
act.Clear(id)
|
|
}
|
|
}
|