svcctl

Documentation

Overview

Package svcctl provides functions that make use of an IPC device, as well as common IPC handlers and requesters. The intent is to guard the authority and uniqueness of the state service, so localized error messages refer to the "service" rather than just the IPC server.

Index

• Variables
• func EnsureExecStartedAndLocateHTTP(ipComm IPCommunicator, exec, argText string, out output.Outputer) (addr string, err error)
• func EnsureStartedAndLocateHTTP(argText string, out output.Outputer) (addr string, err error)
• func ExitCodeHandler(cfg *config.Instance, resolver Resolver, analyticsReporter AnalyticsReporter) ipc.RequestHandler
• func HTTPAddrHandler(addr string) ipc.RequestHandler
• func HeartbeatHandler(cfg *config.Instance, resolver Resolver, analyticsReporter AnalyticsReporter) ipc.RequestHandler
• func LocateHTTP(ipComm IPCommunicator) (addr string, err error)
• func LogFileHandler(logFile string) ipc.RequestHandler
• func LogFileName(ipComm IPCommunicator) (string, error)
• func NewDefaultIPCClient() *ipc.Client
• func NewIPCSockPathFromGlobals() *ipc.SockPath
• func StopServer(ipComm IPCommunicator) error
• type AnalyticsReporter
• type Comm
  • func NewComm(req Requester) *Comm
  • func (c *Comm) GetHTTPAddr(ctx context.Context) (string, error)
  • func (c *Comm) GetLogFileName(ctx context.Context) (string, error)
• type IPCommunicator
• type Requester
• type Resolver

Variables

var (
	KeyHTTPAddr  = "http-addr"
	KeyLogFile   = "log-file"
	KeyHeartbeat = "heart<"
	KeyExitCode  = "exitcode<"
)

Functions

func EnsureExecStartedAndLocateHTTP

func EnsureExecStartedAndLocateHTTP(ipComm IPCommunicator, exec, argText string, out output.Outputer) (addr string, err error)

func EnsureStartedAndLocateHTTP

func EnsureStartedAndLocateHTTP(argText string, out output.Outputer) (addr string, err error)

func ExitCodeHandler

func ExitCodeHandler(cfg *config.Instance, resolver Resolver, analyticsReporter AnalyticsReporter) ipc.RequestHandler

func HTTPAddrHandler

func HTTPAddrHandler(addr string) ipc.RequestHandler

func HeartbeatHandler

func HeartbeatHandler(cfg *config.Instance, resolver Resolver, analyticsReporter AnalyticsReporter) ipc.RequestHandler

func LocateHTTP

func LocateHTTP(ipComm IPCommunicator) (addr string, err error)

func LogFileHandler

func LogFileHandler(logFile string) ipc.RequestHandler

func LogFileName

func LogFileName(ipComm IPCommunicator) (string, error)

func NewDefaultIPCClient

func NewDefaultIPCClient() *ipc.Client

func NewIPCSockPathFromGlobals

func NewIPCSockPathFromGlobals() *ipc.SockPath

func StopServer

func StopServer(ipComm IPCommunicator) error

Types

type AnalyticsReporter

type AnalyticsReporter interface {
	EventWithSource(category, action, source string, dims ...*dimensions.Values)
	EventWithSourceAndLabel(category, action, source, label string, dims ...*dimensions.Values)
}

type Comm

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

func NewComm

func NewComm(req Requester) *Comm

func (*Comm) GetHTTPAddr

func (c *Comm) GetHTTPAddr(ctx context.Context) (string, error)

func (*Comm) GetLogFileName

func (c *Comm) GetLogFileName(ctx context.Context) (string, error)

type IPCommunicator

type IPCommunicator interface {
	Requester
	PingServer(context.Context) (time.Duration, error)
	StopServer(context.Context) error
	SockPath() *ipc.SockPath
}

type Requester

type Requester interface {
	Request(ctx context.Context, key string) (value string, err error)
}

type Resolver

type Resolver interface {
	ReportRuntimeUsage(ctx context.Context, pid int, exec, source string, dimensionsJSON string) (*graph.ReportRuntimeUsageResponse, error)
}