probe

package
v0.4.1 Latest Latest
Warning

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

Go to latest
Published: Jul 13, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Exec

type Exec func(ctx context.Context, cmd []string) (output string, exitCode int, err error)

Exec runs a command in the probed container and returns its captured result.

type Report

type Report struct {
	Service     string
	Healthcheck *docker.HealthcheckSpec
	Steps       []Step
	Suggestions []string
}

Report contains the full result of probing one service container.

func Run

func Run(ctx context.Context, service string, hc *docker.HealthcheckSpec, ports []string, exec Exec) *Report

Run executes a lightweight, one-shot startup probe for a service container.

type Step

type Step struct {
	Label  string
	Status StepStatus
	Output string
}

Step is a single diagnostic check performed during a probe run.

type StepStatus

type StepStatus int

StepStatus describes the outcome of one diagnostic probe step.

const (
	StepPass StepStatus = iota
	StepFail
	StepWarn
	StepSkip
)

Probe step statuses.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL