agent

Documentation

Index

• func Start(config Config) error
• func Stop() error
• type CPUMetrics
• type Config
  • func (c *Config) SetDefaults()
  • func (c *Config) Validate() error
• type GCMetrics
• type GoroutineDump
• type GoroutineInfo
• type MemoryMetrics
• type Metrics
  • func GetMetrics() *Metrics
  • func (m *Metrics) Clone() *Metrics
• type SystemInfo

Functions

func Start

func Start(config Config) error

Start 启动 Agent，返回错误如果启动失败 此函数是非阻塞的，Agent 在后台运行

func Stop

func Stop() error

Stop 优雅停止 Agent，关闭所有连接和后台任务

Types

type CPUMetrics

type CPUMetrics struct {
	UsagePercent float64 `json:"usage_percent"` // CPU 使用率百分比
}

CPUMetrics CPU 相关指标

type Config

type Config struct {
	Port          int    // HTTP 服务器端口，默认 8563
	EnablePprof   bool   // 是否启用 pprof 端点，默认 true
	EnableMetrics bool   // 是否启用指标收集，默认 true
	LogLevel      string // 日志级别：debug, info, warn, error
}

Config 定义 Agent 的配置选项

func (*Config) SetDefaults

func (c *Config) SetDefaults()

SetDefaults 设置默认配置值

func (*Config) Validate

func (c *Config) Validate() error

Validate 验证配置的有效性

type GCMetrics

type GCMetrics struct {
	NumGC      uint32        `json:"num_gc"`      // GC 执行次数
	PauseTotal time.Duration `json:"pause_total"` // GC 总暂停时间
	LastPause  time.Duration `json:"last_pause"`  // 最后一次 GC 暂停时间
	PauseAvg   time.Duration `json:"pause_avg"`   // 平均 GC 暂停时间
}

GCMetrics GC 相关指标

type GoroutineDump

type GoroutineDump struct {
	Timestamp   time.Time       `json:"timestamp"`                   // 抓取时间
	Total       int             `json:"total"`                       // goroutine 总数
	StateCounts map[string]int  `json:"state_counts"`                // 按状态聚合的计数
	Suspected   []GoroutineInfo `json:"suspected_blocked,omitempty"` // 疑似长阻塞（runtime 标注 >=N 分钟，始终带栈）
	Goroutines  []GoroutineInfo `json:"goroutines,omitempty"`        // 全部 goroutine（仅当请求 stacks 时填充）
}

GoroutineDump 是某一时刻所有 goroutine 的转储与聚合，对应 Arthas 的 thread 命令

type GoroutineInfo

type GoroutineInfo struct {
	ID          int    `json:"id"`                     // goroutine 编号
	State       string `json:"state"`                  // 规范化状态，如 running / chan receive / select
	WaitMinutes int    `json:"wait_minutes,omitempty"` // 阻塞时长（分钟）；runtime 仅对 >=1 分钟的阻塞报告
	Stack       string `json:"stack,omitempty"`        // 完整调用栈（按需）
}

GoroutineInfo 描述单个 goroutine

type MemoryMetrics

type MemoryMetrics struct {
	HeapAlloc    uint64 `json:"heap_alloc"`    // 堆已分配字节数
	HeapInuse    uint64 `json:"heap_inuse"`    // 堆正在使用字节数
	HeapIdle     uint64 `json:"heap_idle"`     // 堆空闲字节数
	HeapReleased uint64 `json:"heap_released"` // 已释放给 OS 的字节数
	StackInuse   uint64 `json:"stack_inuse"`   // 栈正在使用字节数
	TotalAlloc   uint64 `json:"total_alloc"`   // 累计分配字节数
	Sys          uint64 `json:"sys"`           // 从 OS 获取的总字节数
}

MemoryMetrics 内存相关指标

type Metrics

type Metrics struct {
	Timestamp  time.Time     `json:"timestamp"`  // 采集时间戳
	Goroutines int           `json:"goroutines"` // 当前 goroutine 数量
	Memory     MemoryMetrics `json:"memory"`     // 内存指标
	CPU        CPUMetrics    `json:"cpu"`        // CPU 指标
	GC         GCMetrics     `json:"gc"`         // GC 指标
}

Metrics 包含所有运行时指标的快照

func GetMetrics

func GetMetrics() *Metrics

GetMetrics 返回当前的运行时指标快照

func (*Metrics) Clone

func (m *Metrics) Clone() *Metrics

Clone 创建 Metrics 的深拷贝

type SystemInfo

type SystemInfo struct {
	GoVersion string    `json:"go_version"` // Go 版本
	GOOS      string    `json:"goos"`       // 操作系统
	GOARCH    string    `json:"goarch"`     // 架构
	NumCPU    int       `json:"num_cpu"`    // CPU 核心数
	ProcessID int       `json:"process_id"` // 进程 ID
	StartTime time.Time `json:"start_time"` // 启动时间
	Uptime    string    `json:"uptime"`     // 运行时长
}

SystemInfo 系统信息