zfscmd

Documentation

Overview

Package zfscmd provides a wrapper around packate os/exec. Functionality provided by the wrapper: - logging start and end of command execution - status report of active commands - prometheus metrics of runtimes

Index

• func GetJobID(ctx context.Context) string
• func RegisterMetrics(r prometheus.Registerer)
• func WithJobID(ctx context.Context, jobID string) context.Context
• type ActiveCommand
• type Cmd
  • func CommandContext(ctx context.Context, name string, args ...string) *Cmd
  • func New(ctx context.Context) *Cmd
  • func (c *Cmd) CombinedOutput() ([]byte, error)
  • func (c *Cmd) Log() *slog.Logger
  • func (c *Cmd) LogError(err error, debug bool)
  • func (c *Cmd) Output() ([]byte, error)
  • func (c *Cmd) PipeFrom(cmds [][]string, stdin io.ReadCloser, stdout, stderr io.Writer) error
  • func (c *Cmd) PipeTo(cmds [][]string, stdout io.ReadCloser, stderr io.Writer) (io.ReadCloser, error)
  • func (c *Cmd) Process() *os.Process
  • func (c *Cmd) Runtime() time.Duration
  • func (c *Cmd) SetStdio(stdio Stdio)
  • func (c *Cmd) Start() error
  • func (c *Cmd) StartPipe() error
  • func (c *Cmd) StdoutPipeWithErrorBuf(w io.Writer) (io.ReadCloser, error)
  • func (c *Cmd) String() string
  • func (c *Cmd) TestOnly_ExecCmd() *exec.Cmd
  • func (c *Cmd) Wait() (err error)
  • func (c *Cmd) WaitPipe() error
  • func (c *Cmd) WithCommand(name string, args []string) *Cmd
  • func (c *Cmd) WithLogError(v bool) *Cmd
  • func (c *Cmd) WithPipeLen(n int) *Cmd
  • func (c *Cmd) WithStderrOutput(b []byte) *Cmd
• type Report
  • func GetReport() *Report
• type Stdio

Functions

func GetJobID

func GetJobID(ctx context.Context) string

func RegisterMetrics

func RegisterMetrics(r prometheus.Registerer)

func WithJobID

func WithJobID(ctx context.Context, jobID string) context.Context

Types

type ActiveCommand

type ActiveCommand struct {
	Path      string
	Args      []string
	StartedAt time.Time
}

type Cmd

type Cmd struct {
	// contains filtered or unexported fields
}

func CommandContext

func CommandContext(ctx context.Context, name string, args ...string) *Cmd

func New

func New(ctx context.Context) *Cmd

func (*Cmd) CombinedOutput

func (c *Cmd) CombinedOutput() ([]byte, error)

err.(*exec.ExitError).Stderr will NOT be set

func (*Cmd) Log

func (c *Cmd) Log() *slog.Logger

func (*Cmd) LogError

func (c *Cmd) LogError(err error, debug bool)

func (*Cmd) Output

func (c *Cmd) Output() ([]byte, error)

err.(*exec.ExitError).Stderr will be set

func (*Cmd) PipeFrom

func (c *Cmd) PipeFrom(cmds [][]string, stdin io.ReadCloser, stdout,
	stderr io.Writer,
) error

func (*Cmd) PipeTo

func (c *Cmd) PipeTo(cmds [][]string, stdout io.ReadCloser, stderr io.Writer,
) (io.ReadCloser, error)

func (*Cmd) Process

func (c *Cmd) Process() *os.Process

Get the underlying os.Process.

Only call this method after a successful call to .Start().

func (*Cmd) Runtime

func (c *Cmd) Runtime() time.Duration

returns 0 if the command did not yet finish

func (*Cmd) SetStdio

func (c *Cmd) SetStdio(stdio Stdio)

func (*Cmd) Start

func (c *Cmd) Start() error

Start the command.

If this method returns an error, the Cmd instance is invalid. Start must not be called repeatedly.

func (*Cmd) StartPipe

func (c *Cmd) StartPipe() error

func (*Cmd) StdoutPipeWithErrorBuf

func (c *Cmd) StdoutPipeWithErrorBuf(w io.Writer) (io.ReadCloser, error)

func (*Cmd) String

func (c *Cmd) String() string

func (*Cmd) TestOnly_ExecCmd

func (c *Cmd) TestOnly_ExecCmd() *exec.Cmd

func (*Cmd) Wait

func (c *Cmd) Wait() (err error)

Blocking wait for the process to exit. May be called concurrently and repeatly (exec.Cmd.Wait() semantics apply).

Only call this method after a successful call to .Start().

func (*Cmd) WaitPipe

func (c *Cmd) WaitPipe() error

func (*Cmd) WithCommand

func (c *Cmd) WithCommand(name string, args []string) *Cmd

func (*Cmd) WithLogError

func (c *Cmd) WithLogError(v bool) *Cmd

func (*Cmd) WithPipeLen

func (c *Cmd) WithPipeLen(n int) *Cmd

func (*Cmd) WithStderrOutput

func (c *Cmd) WithStderrOutput(b []byte) *Cmd

type Report

type Report struct {
	Active []ActiveCommand
}

func GetReport

func GetReport() *Report

type Stdio

type Stdio struct {
	Stdin  io.ReadCloser
	Stdout io.Writer
	Stderr io.Writer
}