mirror of
https://github.com/zrepl/zrepl.git
synced 2024-11-25 01:44:43 +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
72 lines
1.7 KiB
Go
72 lines
1.7 KiB
Go
// Package transport defines a common interface for
|
|
// network connections that have an associated client identity.
|
|
package transport
|
|
|
|
import (
|
|
"context"
|
|
"net"
|
|
"syscall"
|
|
|
|
"github.com/pkg/errors"
|
|
"github.com/zrepl/zrepl/daemon/logging"
|
|
"github.com/zrepl/zrepl/logger"
|
|
"github.com/zrepl/zrepl/rpc/dataconn/timeoutconn"
|
|
"github.com/zrepl/zrepl/zfs"
|
|
)
|
|
|
|
type AuthConn struct {
|
|
Wire
|
|
clientIdentity string
|
|
}
|
|
|
|
var _ timeoutconn.SyscallConner = AuthConn{}
|
|
|
|
func (a AuthConn) SyscallConn() (rawConn syscall.RawConn, err error) {
|
|
scc, ok := a.Wire.(timeoutconn.SyscallConner)
|
|
if !ok {
|
|
return nil, timeoutconn.SyscallConnNotSupported
|
|
}
|
|
return scc.SyscallConn()
|
|
}
|
|
|
|
func NewAuthConn(conn Wire, clientIdentity string) *AuthConn {
|
|
return &AuthConn{conn, clientIdentity}
|
|
}
|
|
|
|
func (c *AuthConn) ClientIdentity() string {
|
|
if err := ValidateClientIdentity(c.clientIdentity); err != nil {
|
|
panic(err)
|
|
}
|
|
return c.clientIdentity
|
|
}
|
|
|
|
// like net.Listener, but with an AuthenticatedConn instead of net.Conn
|
|
type AuthenticatedListener interface {
|
|
Addr() net.Addr
|
|
Accept(ctx context.Context) (*AuthConn, error)
|
|
Close() error
|
|
}
|
|
|
|
type AuthenticatedListenerFactory func() (AuthenticatedListener, error)
|
|
|
|
type Wire = timeoutconn.Wire
|
|
|
|
type Connecter interface {
|
|
Connect(ctx context.Context) (Wire, error)
|
|
}
|
|
|
|
// A client identity must be a single component in a ZFS filesystem path
|
|
func ValidateClientIdentity(in string) error {
|
|
err := zfs.ComponentNamecheck(in)
|
|
if err != nil {
|
|
return errors.Wrap(err, "client identity must be usable as a single dataset path component")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
type Logger = logger.Logger
|
|
|
|
func GetLogger(ctx context.Context) Logger {
|
|
return logging.GetLogger(ctx, logging.SubsysTransport)
|
|
}
|