mirror of
https://github.com/zrepl/zrepl.git
synced 2024-12-18 21:20:44 +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
28 lines
696 B
Go
28 lines
696 B
Go
package trace
|
|
|
|
import "context"
|
|
|
|
type contextKey int
|
|
|
|
const (
|
|
contextKeyTraceNode contextKey = 1 + iota
|
|
)
|
|
|
|
var contextKeys = []contextKey{
|
|
contextKeyTraceNode,
|
|
}
|
|
|
|
// WithInherit inherits the task hierarchy from inheritFrom into ctx.
|
|
// The returned context is a child of ctx, but its task and span are those of inheritFrom.
|
|
//
|
|
// Note that in most use cases, callers most likely want to call WithTask since it will most likely
|
|
// be in some sort of connection handler context.
|
|
func WithInherit(ctx, inheritFrom context.Context) context.Context {
|
|
for _, k := range contextKeys {
|
|
if v := inheritFrom.Value(k); v != nil {
|
|
ctx = context.WithValue(ctx, k, v) // no shadow
|
|
}
|
|
}
|
|
return ctx
|
|
}
|