实现自定义容器运行时的状态查询与列表展示功能
在实现了容器的后台独立运行功能后,系统需要一种机制来追踪和展示这些脱离父进程的容器实例。这要求我们在容器生命周期中引入状态持久化,并提供查询接口。
容器状态持久化设计
为了追踪后台容器,必须在容器启动时将其核心元数据(如进程ID、启动命令、创建时间等)序列化并存储到宿主机的文件系统中。参考主流容器运行时的设计,我们将状态文件统一存放在 /var/run/mydocker/containers/{containerID}/state.json 路径下。
定义元数据结构
首先,定义一个结构体来承载容器的运行时状态信息,并为其添加 JSON 标签以便于序列化。
type ContainerState struct {
ProcessID string `json:"pid"`
ContainerID string `json:"id"`
Name string `json:"name"`
EntryPoint string `json:"command"`
StartedAt string `json:"started_at"`
State string `json:"state"`
}
生成唯一标识
每个容器需要一个唯一的标识符。这里实现一个简单的随机数字字符串生成器来作为容器 ID。
func generateRandomID(length int) string {
charset := "0123456789"
seededRand := rand.New(rand.NewSource(time.Now().UnixNano()))
idBytes := make([]byte, length)
for i := range idBytes {
idBytes[i] = charset[seededRand.Intn(len(charset))]
}
return string(idBytes)
}
持久化逻辑实现
在容器进程启动后,调用持久化函数将状态写入磁盘。如果用户未指定容器名称,则默认使用容器 ID 作为名称。
func SaveContainerMetadata(pid int, cmdArgs []string, name, id string) error {
if name == "" {
name = id
}
state := &ContainerState{
ProcessID: strconv.Itoa(pid),
ContainerID: id,
Name: name,
EntryPoint: strings.Join(cmdArgs, " "),
StartedAt: time.Now().Format("2006-01-02 15:04:05"),
State: "running",
}
data, err := json.Marshal(state)
if err != nil {
return fmt.Errorf("failed to marshal container state: %w", err)
}
dirPath := fmt.Sprintf("/var/run/mydocker/containers/%s", id)
if err := os.MkdirAll(dirPath, 0755); err != nil {
return fmt.Errorf("failed to create state directory: %w", err)
}
filePath := filepath.Join(dirPath, "state.json")
if err := os.WriteFile(filePath, data, 0644); err != nil {
return fmt.Errorf("failed to write state file: %w", err)
}
return nil
}
同时,需要提供清理机制,在容器前台运行结束或退出时,删除对应的状态目录。
func CleanupContainerState(id string) {
dirPath := fmt.Sprintf("/var/run/mydocker/containers/%s", id)
if err := os.RemoveAll(dirPath); err != nil {
log.Printf("Warning: failed to remove state directory %s: %v", dirPath, err)
}
}
实现容器列表查询
查询功能的核心在于遍历状态存储目录,读取并解析每个子目录中的 JSON 文件,最后将结果格式化输出到终端。
读取与解析状态文件
编写辅助函数,根据目录条目读取并反序列化容器状态。
func loadContainerState(entry os.DirEntry) (*ContainerState, error) {
filePath := filepath.Join("/var/run/mydocker/containers", entry.Name(), "state.json")
data, err := os.ReadFile(filePath)
if err != nil {
return nil, fmt.Errorf("failed to read state file: %w", err)
}
var state ContainerState
if err := json.Unmarshal(data, &state); err != nil {
return nil, fmt.Errorf("failed to parse state JSON: %w", err)
}
return &state, nil
}
格式化输出
利用 Go 标准库中的 text/tabwriter 来实现整齐的表格输出,提升命令行工具的交互体验。
func ListRunningContainers() {
entries, err := os.ReadDir("/var/run/mydocker/containers")
if err != nil {
log.Printf("Failed to read containers directory: %v", err)
return
}
writer := tabwriter.NewWriter(os.Stdout, 10, 1, 3, ' ', 0)
fmt.Fprintln(writer, "ID\tNAME\tPID\tSTATUS\tCOMMAND\tSTARTED")
for _, entry := range entries {
if !entry.IsDir() {
continue
}
state, err := loadContainerState(entry)
if err != nil {
log.Printf("Skipping invalid container %s: %v", entry.Name(), err)
continue
}
fmt.Fprintf(writer, "%s\t%s\t%s\t%s\t%s\t%s\n",
state.ContainerID,
state.Name,
state.ProcessID,
state.State,
state.EntryPoint,
state.StartedAt,
)
}
if err := writer.Flush(); err != nil {
log.Printf("Failed to flush tabwriter: %v", err)
}
}
功能验证
通过启动后台容器并执行查询命令,验证状态持久化与列表展示功能。
启动后台容器
使用自定义参数启动一个后台运行的 top 进程,并指定容器名称。
$ ./mydocker run -d --name my_top_container top
检查宿主机上的状态文件是否正确生成:
$ cat /var/run/mydocker/containers/9482716355/state.json
{"pid":"28491","id":"9482716355","name":"my_top_container","command":"top","started_at":"2023-10-25 10:15:30","state":"running"}
执行列表查询
调用 ps 子命令,查看当前系统中的活动容器。
$ ./mydocker ps
ID NAME PID STATUS COMMAND STARTED
9482716355 my_top_container 28491 running top 2023-10-25 10:15:30
3847561920 3847561920 28550 running sleep 100 2023-10-25 10:18:12
输出结果准确反映了后台容器的运行状态、PID 及启动时间,证明状态追踪与查询机制已按预期工作。