如何实时收集Terraform plan命令输出并展示到前端

核心实现方式 #

terraform-exec库原生支持自定义绑定stdout/stderr的输出流，不需要自己额外拦截进程输出，直接通过官方提供的接口就能实现实时采集：

• 首先实现自定义的io.Writer结构体，所有Terraform的输出都会逐段触发Write方法的调用
• 在Write方法内将输出内容推送到和前端建立的长连接通道（WebSocket/SSE都可以）
• 初始化Terraform执行实例时，将自定义Writer绑定到实例的stdout/stderr上

代码示例 #

// 自定义输出Writer，负责把Terraform输出实时推送给前端
type RealtimeLogWriter struct {
    PushChannel chan []byte // 关联对应前端连接的消息推送通道
}

func (w *RealtimeLogWriter) Write(content []byte) (n int, err error) {
    // 可在此处添加过滤逻辑：比如移除敏感信息、格式化日志结构
    w.PushChannel <- content
    return len(content), nil
}

// 初始化Terraform执行实例并绑定输出
func initTerraformExec(workDir string, execPath string, pushChan chan []byte) (*exec.Terraform, error) {
    tf, err := exec.NewTerraform(workDir, execPath)
    if err != nil {
        return nil, err
    }
    // 绑定自定义输出流
    logWriter := &RealtimeLogWriter{
        PushChannel: pushChan,
    }
    tf.SetStdout(logWriter)
    tf.SetStderr(logWriter) // 如需采集错误输出也加上这行
    return tf, nil
}

// 执行Plan操作，输出会实时写入自定义Writer
func runTerraformPlan(tf *exec.Terraform) error {
    // 可根据需要添加Plan参数，比如指定变量文件、输出plan文件等
    _, err := tf.Plan(context.Background(), exec.PlanOption{})
    return err
}

可选优化方案 #

• 如果需要同时解析Plan的结构化变更信息：给Plan方法添加exec.PlanWithJSON(planOutputFile)参数，将结构化的变更数据输出到指定文件供后台逻辑解析，不影响原生可读日志的实时采集
• 如果不需要彩色日志：给Plan/Apply操作添加exec.WithNoColor()参数，输出会自动移除ANSI转义码，前端不需要额外做转义处理就可以直接展示
• 如果需要做日志持久化：可以在自定义Writer的Write方法里同时将输出写入本地日志文件，兼顾实时推送和存储需求

前端对接注意点 #

• 后端和前端需要提前建立长连接，每个Terraform执行任务对应独立的连接或者消息ID，避免多个任务的日志混乱
• 前端收到分段日志后直接追加到日志展示容器即可，不需要做额外的拼接处理
• 如需实现和Terraform CLI一致的彩色输出效果，前端可以引入ANSI转义码解析库处理收到的日志内容

内容的提问来源于stack exchange，提问作者Muzafar Ali