Golang 通过 HTTP API 管理应用程序进程的插件库 APM 使用指南

APM (Application Process Management) 是一个用于管理应用程序进程的 Go 语言库，它提供了通过 HTTP API 来控制进程的启动、停止、重启等功能。下面我将介绍如何使用这个库。

安装 APM 库

首先，使用 go get 安装 APM 库：

go get github.com/yourusername/apm

基本使用示例

下面是一个简单的示例，展示如何使用 APM 来管理进程：

package main

import (
	"fmt"
	"log"
	"net/http"
	"os"
	"os/exec"
	"time"

	"github.com/yourusername/apm"
)

func main() {
	// 创建一个新的 APM 实例
	manager := apm.NewAPM()

	// 定义一个简单的进程配置
	processConfig := &apm.ProcessConfig{
		Name:    "myapp",
		Command: "go",
		Args:    []string{"run", "main.go"},
		Dir:     "./",
	}

	// 添加进程到管理器
	err := manager.AddProcess(processConfig)
	if err != nil {
		log.Fatalf("Failed to add process: %v", err)
	}

	// 启动 HTTP API 服务器
	go func() {
		http.HandleFunc("/start", func(w http.ResponseWriter, r *http.Request) {
			err := manager.StartProcess("myapp")
			if err != nil {
				http.Error(w, err.Error(), http.StatusInternalServerError)
				return
			}
			fmt.Fprintf(w, "Process started successfully")
		})

		http.HandleFunc("/stop", func(w http.ResponseWriter, r *http.Request) {
			err := manager.StopProcess("myapp")
			if err != nil {
				http.Error(w, err.Error(), http.StatusInternalServerError)
				return
			}
			fmt.Fprintf(w, "Process stopped successfully")
		})

		http.HandleFunc("/status", func(w http.ResponseWriter, r *http.Request) {
			status, err := manager.GetProcessStatus("myapp")
			if err != nil {
				http.Error(w, err.Error(), http.StatusInternalServerError)
				return
			}
			fmt.Fprintf(w, "Process status: %v", status)
		})

		log.Println("Starting API server on :8080")
		log.Fatal(http.ListenAndServe(":8080", nil))
	}()

	// 主程序保持运行
	select {}
}

API 端点说明

上面的示例创建了以下几个 HTTP 端点：

1. /start - 启动进程
2. /stop - 停止进程
3. /status - 获取进程状态

高级功能

1. 自动重启

可以配置进程在退出时自动重启：

processConfig := &apm.ProcessConfig{
	Name:        "myapp",
	Command:     "go",
	Args:        []string{"run", "main.go"},
	Dir:         "./",
	AutoRestart: true,
	RestartDelay: 5 * time.Second,
}

2. 环境变量

可以为进程设置环境变量：

processConfig := &apm.ProcessConfig{
	Name:    "myapp",
	Command: "go",
	Args:    []string{"run", "main.go"},
	Env:     []string{"ENV=production", "PORT=8080"},
}

3. 日志重定向

可以将进程的输出重定向到文件：

processConfig := &apm.ProcessConfig{
	Name:       "myapp",
	Command:    "go",
	Args:       []string{"run", "main.go"},
	StdoutFile: "myapp.log",
	StderrFile: "myapp.err",
}

完整的管理 API

下面是一个更完整的管理 API 示例：

package main

import (
	"encoding/json"
	"log"
	"net/http"

	"github.com/yourusername/apm"
)

func main() {
	manager := apm.NewAPM()

	// 添加示例进程
	manager.AddProcess(&apm.ProcessConfig{
		Name:    "webserver",
		Command: "go",
		Args:    []string{"run", "webserver.go"},
	})

	// API 路由
	http.HandleFunc("/processes", func(w http.ResponseWriter, r *http.Request) {
		switch r.Method {
		case "GET":
			// 获取所有进程状态
			processes := manager.ListProcesses()
			json.NewEncoder(w).Encode(processes)
		case "POST":
			// 添加新进程
			var config apm.ProcessConfig
			if err := json.NewDecoder(r.Body).Decode(&config); err != nil {
				http.Error(w, err.Error(), http.StatusBadRequest)
				return
			}
			if err := manager.AddProcess(&config); err != nil {
				http.Error(w, err.Error(), http.StatusInternalServerError)
				return
			}
			w.WriteHeader(http.StatusCreated)
		}
	})

	http.HandleFunc("/processes/", func(w http.ResponseWriter, r *http.Request) {
		name := r.URL.Path[len("/processes/"):]
		switch r.Method {
		case "GET":
			// 获取单个进程状态
			status, err := manager.GetProcessStatus(name)
			if err != nil {
				http.Error(w, err.Error(), http.StatusNotFound)
				return
			}
			json.NewEncoder(w).Encode(status)
		case "POST":
			// 启动进程
			if err := manager.StartProcess(name); err != nil {
				http.Error(w, err.Error(), http.StatusInternalServerError)
				return
			}
			w.WriteHeader(http.StatusOK)
		case "DELETE":
			// 停止进程
			if err := manager.StopProcess(name); err != nil {
				http.Error(w, err.Error(), http.StatusInternalServerError)
				return
			}
			w.WriteHeader(http.StatusOK)
		}
	})

	log.Println("Starting APM API server on :8080")
	log.Fatal(http.ListenAndServe(":8080", nil))
}

安全考虑

在生产环境中使用 APM 时，应该考虑以下安全措施：

1. 添加认证中间件
2. 限制只允许本地访问
3. 使用 HTTPS 加密通信

// 简单的认证中间件示例
func authMiddleware(next http.Handler) http.Handler {
	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		token := r.Header.Get("Authorization")
		if token != "Bearer mysecrettoken" {
			http.Error(w, "Unauthorized", http.StatusUnauthorized)
			return
		}
		next.ServeHTTP(w, r)
	})
}

// 使用中间件
http.ListenAndServe(":8080", authMiddleware(http.DefaultServeMux))

总结

APM 库提供了一个简单而强大的方式来通过 HTTP API 管理应用程序进程。通过它，你可以轻松地实现进程的启动、停止、状态监控等功能。在实际应用中，你可以根据需求扩展这个基础功能，添加更多的管理接口和监控功能。

注意：上述代码中的 github.com/yourusername/apm 是一个示例路径，实际使用时需要替换为真实的 APM 库路径。目前 Go 生态中有一些类似的库如 github.com/ochinchina/supervisord 等，你可以根据实际需求选择合适的库。