Documentation
¶
Index ¶
- func SaveHistory(report *HealthReport, historyDir string) error
- func WatchHealth(ctx context.Context, cfg *config.Config, workdir string, ...) (<-chan *HealthReport, error)
- type DockerClient
- type HealthReport
- type HealthResult
- type RestartContainer
- type RestartContainerInfo
- type RestartPolicy
- type Restarter
- type ServiceState
- type ShellDockerClient
- func (s *ShellDockerClient) ContainerInspect(ctx context.Context, id string) (RestartContainerInfo, error)
- func (s *ShellDockerClient) ContainerList(ctx context.Context, _ map[string]string) ([]RestartContainer, error)
- func (s *ShellDockerClient) ContainerRestart(ctx context.Context, id string, timeout int) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func SaveHistory ¶
func SaveHistory(report *HealthReport, historyDir string) error
SaveHistory appends a single HealthReport as one JSON line to {historyDir}/history.jsonl. The directory is created if it does not exist.
func WatchHealth ¶
func WatchHealth(ctx context.Context, cfg *config.Config, workdir string, interval time.Duration) (<-chan *HealthReport, error)
WatchHealth starts a continuous monitoring loop that sends a fresh HealthReport on the returned channel at the given interval. The loop exits when ctx is cancelled; the channel is closed on exit.
Types ¶
type DockerClient ¶
type DockerClient interface {
// ContainerList returns running containers, optionally filtered by label.
ContainerList(ctx context.Context, filters map[string]string) ([]RestartContainer, error)
// ContainerInspect returns detailed info for a single container by ID or name.
ContainerInspect(ctx context.Context, id string) (RestartContainerInfo, error)
// ContainerRestart restarts a container. timeout is in seconds; 0 uses Docker default.
ContainerRestart(ctx context.Context, id string, timeout int) error
}
DockerClient abstracts the Docker operations needed by Restarter for testability.
type HealthReport ¶
type HealthReport struct {
Timestamp time.Time `json:"timestamp"`
Results []HealthResult `json:"results"`
Healthy int `json:"healthy"`
Unhealthy int `json:"unhealthy"`
Total int `json:"total"`
}
HealthReport aggregates the results of checking all services.
func GetHistory ¶
func GetHistory(historyDir string, limit int) ([]HealthReport, error)
GetHistory reads the last limit HealthReport entries from {historyDir}/history.jsonl. If the file does not exist an empty slice is returned. When limit <= 0 all entries are returned.
func RunAllChecks ¶
RunAllChecks queries Docker health status for every enabled service and returns a consolidated HealthReport.
It uses docker compose ps --format json (via the compose manifest) to query health status directly from the Docker Compose project, which is immune to container name guessing issues. It falls back to per-container docker inspect for any service not reported by compose ps.
type HealthResult ¶
type HealthResult struct {
Service string `json:"service"`
Status string `json:"status"` // healthy, unhealthy, starting, none, not_found, error
Duration time.Duration `json:"duration"`
Details string `json:"details"`
}
HealthResult holds the outcome of a single service health check.
func CheckEndpoint ¶
func CheckEndpoint(ctx context.Context, url string) (*HealthResult, error)
CheckEndpoint performs an HTTP GET against the given URL and reports whether it returned a 2xx status code. The request uses a 10-second timeout by default, or inherits the context deadline if shorter.
func CheckService ¶
func CheckService(ctx context.Context, service string) (*HealthResult, error)
CheckService checks the Docker health status of a single named service. The service name should match the docker-compose service name (e.g. "postgres", "hasura", "redis") or a full container name.
type RestartContainer ¶
RestartContainer is a minimal container descriptor returned by ContainerList.
type RestartContainerInfo ¶
RestartContainerInfo holds the health state of an inspected container.
type RestartPolicy ¶
type RestartPolicy struct {
MaxAttempts int // default: 3
PollInterval time.Duration // default: 30s
RestartDelay time.Duration // default: 5s
}
RestartPolicy configures the behaviour of a Restarter.
func DefaultRestartPolicy ¶
func DefaultRestartPolicy() RestartPolicy
DefaultRestartPolicy returns a RestartPolicy with sensible defaults, overridden by the NSELF_HEALTH_POLL_INTERVAL and NSELF_HEALTH_MAX_RESTARTS env vars if set.
type Restarter ¶
type Restarter struct {
// contains filtered or unexported fields
}
Restarter polls container health and automatically restarts unhealthy services according to the configured RestartPolicy.
func NewRestarter ¶
func NewRestarter(docker DockerClient, policy RestartPolicy) *Restarter
NewRestarter creates a new Restarter. Call Start to begin polling.
func (*Restarter) Start ¶
Start begins the health-poll loop in a goroutine. It returns immediately. Cancel ctx to stop the loop cleanly.
func (*Restarter) Status ¶
func (r *Restarter) Status() []ServiceState
Status returns a snapshot of all tracked service states.
type ServiceState ¶
ServiceState records the restart history for a single service.
type ShellDockerClient ¶
type ShellDockerClient struct {
// contains filtered or unexported fields
}
ShellDockerClient implements DockerClient by delegating to the local docker CLI and the docker.InspectContainer helper.
func NewShellDockerClient ¶
func NewShellDockerClient(projectName string) *ShellDockerClient
NewShellDockerClient returns a ShellDockerClient scoped to the given project. The project name is used to filter containers by the compose project label.
func (*ShellDockerClient) ContainerInspect ¶
func (s *ShellDockerClient) ContainerInspect(ctx context.Context, id string) (RestartContainerInfo, error)
ContainerInspect returns health info for the given container ID using docker.InspectContainer.
func (*ShellDockerClient) ContainerList ¶
func (s *ShellDockerClient) ContainerList(ctx context.Context, _ map[string]string) ([]RestartContainer, error)
ContainerList returns running containers for this project using docker ps.
func (*ShellDockerClient) ContainerRestart ¶
ContainerRestart restarts the given container using docker restart.
Source Files