zrepl/client/pprof.go

package client

import "github.com/zrepl/zrepl/cli"

var PprofCmd = &cli.Subcommand{
	Use: "pprof",
	SetupSubcommands: func() []*cli.Subcommand {
		return []*cli.Subcommand{PprofListenCmd, pprofActivityTraceCmd}
	},
}
pprof subcommand 2018-09-07 09:04:03 +02:00			`package client`

[#307] add package trace, integrate it with logging, and adopt it throughout zrepl 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 2020-04-11 15:49:41 +02:00			`import "github.com/zrepl/zrepl/cli"`
pprof subcommand 2018-09-07 09:04:03 +02:00
cli: refactor to allow definition of subcommands next to their implementation 2018-10-13 15:07:50 +02:00			`var PprofCmd = &cli.Subcommand{`
[#307] add package trace, integrate it with logging, and adopt it throughout zrepl 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 2020-04-11 15:49:41 +02:00			`Use: "pprof",`
			`SetupSubcommands: func() []*cli.Subcommand {`
			`return []*cli.Subcommand{PprofListenCmd, pprofActivityTraceCmd}`
cli: refactor to allow definition of subcommands next to their implementation 2018-10-13 15:07:50 +02:00			`},`
			`}`