svc

package
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 29, 2026 License: MIT Imports: 32 Imported by: 0

Documentation

Overview

Package svc owns the supervisor daemon implementation: the Supervisor type that loads configuration, manages processes and exposes the RPC service; the HTTP/RPC server that publishes it; the REST program API; and the daemon-mode wrapper that double-forks the process.

All of these used to live in the supd root package; they are extracted here so the ctl/ package can import svc.Supervisor directly and so the root package can shrink to a thin entry point.

Index

Constants

View Source 
const (
	SUPERVISOR_VERSION = "3.0"
)

Variables

View Source 
var (
	HttpMux = &HttpServeMux{}
)

Functions

func Daemonize 

func Daemonize(proc func())

Daemonize is a thin wrapper that double-forks the current process and runs proc in the child. Equivalent to the historical Deamonize() in the root package's daemonize.go. The unusual spelling is preserved so the public symbol stays backwards compatible with the original shell wrappers.

func FindSupervisordConf 

func FindSupervisordConf() (string, error)

FindSupervisordConf searches well-known locations for the supervisor configuration file. Mirrors the legacy findSupervisordConf() in main.go 1. $CWD/supervisord.conf 2. $CWD/etc/supervisord.conf 3. /etc/supervisord.conf 4. /etc/supervisor/supervisord.conf (since Supervisor 3.3.0) 5. ../etc/supervisord.conf (relative to the executable) 6. ../supervisord.conf (relative to the executable)

The hard-coded paths above are adjusted to the supd defaults: 

$CWD/supd.ini, $CWD/etc/supd.ini, /etc/supd/supd.ini, ../etc/supd.ini,
../supd.ini.

func LoadEnvFile 

func LoadEnvFile(path string)

LoadEnvFile reads key=value pairs from path (one per line) and applies them to the current process environment. Lines starting with `#` are comments. Lines may optionally start with `export ` (matches the historical shell-source semantics). Equivalent to the function that used to live in main.go.

func NewHttpBasicAuth 

func NewHttpBasicAuth(user string, password string, handler http.Handler) *httpBasicAuth

Types

type HttpServeMux 

type HttpServeMux struct {
	http.ServeMux
}

func (*HttpServeMux) ServeHTTP 

func (s *HttpServeMux) ServeHTTP(w http.ResponseWriter, r *http.Request)

type LogReadInfo 

type LogReadInfo struct {
	Offset int
	Length int
}

type Options 

type Options struct {
	Configuration string `short:"c" long:"configuration" description:"the configuration file"`
	Daemon        bool   `short:"d" long:"daemon" description:"run as daemon"`
	EnvFile       string `long:"env-file" description:"the environment file"`
}

Options mirrors the root-package flag struct used by the daemon entry. Kept here so the daemon startup logic can be moved wholesale out of the root package.

type ProcessLogReadInfo 

type ProcessLogReadInfo struct {
	Name   string
	Offset int
	Length int
}

type ProcessStdin 

type ProcessStdin struct {
	Name  string
	Chars string
}

type ProcessTailLog 

type ProcessTailLog struct {
	LogData  string
	Offset   int64
	Overflow bool
}

type RPCServer 

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

func NewRPCServer 

func NewRPCServer(s *Supervisor) *RPCServer

func (*RPCServer) ServeHTTP 

func (p *RPCServer) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*RPCServer) StartInetHttpServer 

func (p *RPCServer) StartInetHttpServer(user string, password string, listenAddr string)

func (*RPCServer) StartUnixHttpServer 

func (p *RPCServer) StartUnixHttpServer(user string, password string, listenAddr string)

func (*RPCServer) Stop 

func (p *RPCServer) Stop()

stop network listening

type RemoteCommEvent 

type RemoteCommEvent struct {
	Type string
	Data string
}

type Server 

type Server struct {
	// EnvFile is the path to an optional env-file (equivalent to the
	// historical options.EnvFile root-package field). May be empty.
	EnvFile string

	// ConfigPath, when non-empty, is used as the configuration file
	// regardless of FindSupervisordConf() auto-detection. Equivalent to
	// options.Configuration in the legacy code.
	ConfigPath string
}

Server is the public entry point used by the root supd package to start the daemon. It wraps the legacy free-function RunServer() from main.go behind a value so callers can configure supervisor / signal handling without exposing the internal Supervisor type at the root package level.

func NewServer 

func NewServer() *Server

NewServer returns a Server ready to have its Run method called.

func (*Server) Run 

func (s *Server) Run() error

Run executes the legacy RunServer flow: an infinite loop that reloads the supervisor configuration on each iteration, restarting processes when the binary is replaced. It blocks until the process is killed.

Callers that need custom signal / zombie handling should construct a Server, set EnvFile / ConfigPath, then call Run.

type StartProcessArgs 

type StartProcessArgs struct {
	Name string
	Wait bool `default:"true"`
}

type StateInfo 

type StateInfo struct {
	Statecode int    `xml:"statecode"`
	Statename string `xml:"statename"`
}

type Supervisor 

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

func NewSupervisor 

func NewSupervisor(configFile string) *Supervisor

func (*Supervisor) AddProcessGroup 

func (s *Supervisor) AddProcessGroup(args *struct{ Name string }, reply *rpcclient.StatusReply) error

func (*Supervisor) ClearLog 

func (s *Supervisor) ClearLog(args *struct{}, reply *rpcclient.StatusReply) error

func (*Supervisor) GetAllProcessInfo 

func (s *Supervisor) GetAllProcessInfo(args *struct{}, reply *rpcclient.AllProcessInfoReply) error

func (*Supervisor) GetEnv 

func (s *Supervisor) GetEnv(args *rpcclient.GetEnvArg, reply *rpcclient.GetEnvRet) error

func (*Supervisor) GetIncludeDir 

func (s *Supervisor) GetIncludeDir(args *struct{}, reply *rpcclient.IncludeDirReply) error

func (*Supervisor) GetPID 

func (s *Supervisor) GetPID(args *struct{}, reply *struct{ Pid int }) error

Get all the name of prorams

Return the name of all the programs 

func (s *Supervisor) GetPrograms() []string {
	return s.config.GetProgramNames()
}

func (*Supervisor) GetProcessInfo 

func (s *Supervisor) GetProcessInfo(args *struct{ Name string }, reply *rpcclient.ProcessInfoReply) error

func (*Supervisor) GetState 

func (s *Supervisor) GetState(args *struct{}, reply *struct{ StateInfo StateInfo }) error

func (*Supervisor) GetSupervisorVersion 

func (s *Supervisor) GetSupervisorVersion(args *rpcclient.GetVersionArg, reply *rpcclient.GetVersionRet) error

func (*Supervisor) GetVersion 

func (s *Supervisor) GetVersion(args *rpcclient.GetVersionArg, reply *rpcclient.GetVersionRet) error

func (*Supervisor) Install 

func (s *Supervisor) Install(args *rpcclient.InstallArg, reply *rpcclient.InstallRet) error

func (*Supervisor) ReadLog 

func (s *Supervisor) ReadLog(args *LogReadInfo, reply *struct{ Log string }) error

func (*Supervisor) ReloadConfig 

func (s *Supervisor) ReloadConfig(args *rpcclient.ReloadConfigArg, reply *rpcclient.ReloadConfigRet) error

func (*Supervisor) Remove 

func (s *Supervisor) Remove(args *rpcclient.RemoveArg, reply *rpcclient.RemoveRet) error

func (*Supervisor) RemoveProcessGroup 

func (s *Supervisor) RemoveProcessGroup(args *struct{ Name string }, reply *rpcclient.StatusReply) error

func (*Supervisor) Restart 

func (s *Supervisor) Restart(args *struct{}, reply *rpcclient.StatusReply) error

func (*Supervisor) RestartAllProcesses 

func (s *Supervisor) RestartAllProcesses(args *struct {
	Wait bool `default:"true"`
}, reply *rpcclient.AllProcessInfoReply) error

func (*Supervisor) RestartProcess 

func (s *Supervisor) RestartProcess(args *StartProcessArgs, reply *rpcclient.StatusReply) error

func (*Supervisor) SendProcessStdin 

func (s *Supervisor) SendProcessStdin(args *ProcessStdin, reply *rpcclient.StatusReply) error

func (*Supervisor) SendRemoteCommEvent 

func (s *Supervisor) SendRemoteCommEvent(args *RemoteCommEvent, reply *rpcclient.StatusReply) error

func (*Supervisor) SetEnv 

func (s *Supervisor) SetEnv(args *rpcclient.SetEnvArg, reply *rpcclient.SetEnvRet) error

func (*Supervisor) Shutdown 

func (s *Supervisor) Shutdown(args *struct{}, reply *rpcclient.StatusReply) error

func (*Supervisor) SignalAllProcesses 

func (s *Supervisor) SignalAllProcesses(args *rpcclient.SignalAllProcessesArg, reply *rpcclient.SignalAllProcessesRet) error

func (*Supervisor) SignalProcess 

func (s *Supervisor) SignalProcess(args *types.ProcessSignal, reply *rpcclient.StatusReply) error

func (*Supervisor) SignalProcessGroup 

func (s *Supervisor) SignalProcessGroup(args *types.ProcessSignal, reply *rpcclient.AllProcessInfoReply) error

func (*Supervisor) StartAllProcesses 

func (s *Supervisor) StartAllProcesses(args *struct {
	Wait bool `default:"true"`
}, reply *rpcclient.AllProcessInfoReply) error

func (*Supervisor) StartProcess 

func (s *Supervisor) StartProcess(args *StartProcessArgs, reply *rpcclient.StatusReply) error

func (*Supervisor) StartProcessGroup 

func (s *Supervisor) StartProcessGroup(args *StartProcessArgs, reply *rpcclient.AllProcessInfoReply) error

func (*Supervisor) StopAllProcesses 

func (s *Supervisor) StopAllProcesses(args *struct {
	Wait bool `default:"true"`
}, reply *rpcclient.AllProcessInfoReply) error

func (*Supervisor) StopProcess 

func (s *Supervisor) StopProcess(args *StartProcessArgs, reply *rpcclient.StatusReply) error

func (*Supervisor) StopProcessGroup 

func (s *Supervisor) StopProcessGroup(args *StartProcessArgs, reply *rpcclient.AllProcessInfoReply) error

type SupervisorRestful 

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

func NewSupervisorRestful 

func NewSupervisorRestful(supervisor *Supervisor) *SupervisorRestful

func (*SupervisorRestful) CreateProgramHandler 

func (sr *SupervisorRestful) CreateProgramHandler() http.Handler

func (*SupervisorRestful) ListProgram 

func (sr *SupervisorRestful) ListProgram(w http.ResponseWriter, req *http.Request)

list the status of all the programs

json array to present the status of all programs

func (*SupervisorRestful) ReadStdoutLog 

func (sr *SupervisorRestful) ReadStdoutLog(w http.ResponseWriter, req *http.Request)

func (*SupervisorRestful) Reload 

func (sr *SupervisorRestful) Reload(w http.ResponseWriter, req *http.Request)

func (*SupervisorRestful) Shutdown 

func (sr *SupervisorRestful) Shutdown(w http.ResponseWriter, req *http.Request)

func (*SupervisorRestful) StartProgram 

func (sr *SupervisorRestful) StartProgram(w http.ResponseWriter, req *http.Request)

func (*SupervisorRestful) StartPrograms 

func (sr *SupervisorRestful) StartPrograms(w http.ResponseWriter, req *http.Request)

func (*SupervisorRestful) StopProgram 

func (sr *SupervisorRestful) StopProgram(w http.ResponseWriter, req *http.Request)

func (*SupervisorRestful) StopPrograms 

func (sr *SupervisorRestful) StopPrograms(w http.ResponseWriter, req *http.Request)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.