id         = <agent-id>
server     = <server-addr>
log.target = stdout,file  # log写入目标，目前仅支持stdout和file
log.dir    = <dir>        # log文件保存路径
log.size   = 10M          # log文件滚动生成时的文件大小
log.rotate = 7            # log文件滚动生成时的保留数量
monitor.enabled    = true # 是否开启监控信息上报
monitor.interval   = 30s  # 监控数据上报频率
limit.cpu_quota    = 100  # CPU最大使用率，100表示一个CPU核心
limit.memory_limit = 512M # 内存最大使用容量
# 以下配置项的内容为一个json数组，其中的字段含义如下：
#   dev: 磁盘设备号，可通过lsblk命令查询
#   read_bytes:  每秒读取字节数
#   write_bytes: 每秒写入字节数
#   read_iops:   每秒读取次数
#   write_iops:  每秒写入次数
# 注意: 该配置项只支持linux操作系统，且支持cgroups时有效
limit.disk_limit = [{"dev":"8:0","read_bytes":"10M","write_bytes":"10M","read_iops":1000,"write_iops":1000}]

type ComePayload struct {
	ID              string `json:"id"` // agent-id
	Name            string `json:"name"`
	Version         string `json:"version"`          // 版本号
	IP              net.IP `json:"ip"`               // ip地址
	MAC             string `json:"mac"`              // mac地址
	HostName        string `json:"host_name"`        // 主机名
	OS              string `json:"os"`               // 操作系统名称，windows或linux
	Platform        string `json:"platform"`         // 操作系统名称，debian、centos等
	PlatformVersion string `json:"platform_version"` // 操作系统版本号，如7.7.1908
	KernelVersion   string `json:"kernel_version"`   // 内核版本号，如3.10.0-1062.el7.x86_64
	Arch            string `json:"arch"`             // 操作系统位数，amd64、i386等
	CPU             string `json:"cpu"`              // CPU型号，如AMD Ryzen 7 4800U with Radeon Graphics
	CPUCore         uint64 `json:"cpu_core"`         // CPU核心数
	Memory          uint64 `json:"memory"`           // 内存大小
}

type HandshakePayload struct {
	OK       bool     `json:"ok"`                 // 握手是否成功
	ID       string   `json:"id"`                 // 被分配的agent id
	Msg      string   `json:"msg"`                // 错误信息
	Redirect []string `json:"redirect,omitempty"` // 重定向地址
}

# HELP agent_info 
# TYPE agent_info gauge
agent_info{agent_type="example-agent",id="example-agent",tag="cpu_usage"} 0.1730158030986786
agent_info{agent_type="example-agent",id="example-agent",tag="gc_0"} 1.0801e-05
agent_info{agent_type="example-agent",id="example-agent",tag="gc_0.25"} 1.0801e-05
agent_info{agent_type="example-agent",id="example-agent",tag="gc_0.5"} 1.6512e-05
agent_info{agent_type="example-agent",id="example-agent",tag="gc_0.75"} 1.6512e-05
agent_info{agent_type="example-agent",id="example-agent",tag="gc_1"} 1.6512e-05
agent_info{agent_type="example-agent",id="example-agent",tag="heap_in_use"} 1.9652608e+07
agent_info{agent_type="example-agent",id="example-agent",tag="in_bytes"} 0
agent_info{agent_type="example-agent",id="example-agent",tag="in_packets"} 0
agent_info{agent_type="example-agent",id="example-agent",tag="memory_usage"} 0.9135397672653198
agent_info{agent_type="example-agent",id="example-agent",tag="out_bytes"} 0
agent_info{agent_type="example-agent",id="example-agent",tag="out_packets"} 0
agent_info{agent_type="example-agent",id="example-agent",tag="read_chan_size"} 0
agent_info{agent_type="example-agent",id="example-agent",tag="reconnect_count"} 0
agent_info{agent_type="example-agent",id="example-agent",tag="report_time"} 1.668065623e+09
agent_info{agent_type="example-agent",id="example-agent",tag="routines"} 10
agent_info{agent_type="example-agent",id="example-agent",tag="startup"} 1.668065613e+09
agent_info{agent_type="example-agent",id="example-agent",tag="threads"} 10
agent_info{agent_type="example-agent",id="example-agent",tag="write_chan_size"} 0
# HELP agent_version 
# TYPE agent_version gauge
agent_version{go_version="go1.19.3",id="example-agent",version="1.0.0"} 1

- key: basic.id
  type: string
  name:
    zh: AgentID
  desc:
    zh: Agent的ID，在当前服务器下的集群内唯一
  required: true
- key: basic.server
  type: naddr
  name:
    zh: 服务端地址
  desc:
    zh: 链接服务器端的地址
  default: 127.0.0.1:13081
  required: true
- key: basic.log.target
  type: csv
  name:
    zh: 日志保存目标
  desc:
    zh: 日志保存目标，目前仅支持stdout和文件
  default: stdout
  csv_valid: [ stdout, file ]
  required: false
- key: basic.log.dir
  type: path
  name:
    zh: 日志保存路径
  desc:
    zh: 日志保存路径
  default: ./logs
  required: false
- key: basic.log.size
  type: bytes
  name:
    zh: 日志文件滚动大小
  desc:
    zh: 日志文件生成时每个文件的大小
  default: 10M
  min: 1M
  max: 100M
  required: false
- key: basic.log.rotate
  type: uint
  name:
    zh: 日志文件保留份数
  desc:
    zh: 日志文件生成时最多保留份数
  default: 7
  min: 1
  max: 100
  required: false

log.target = stdout,file
log.dir = ./logs
log.size = 10M
log.rotate = 7

monitor.enabled = true
monitor.interval = 10s

- key: basic.log.dir
  ...
  enabled:
    when:
      target: basic.log.target
      contain: file
- key: basic.monitor.interval
  ...
  enabled:
    when:
      target: basic.monitor.enabled
      equal: true

{
  "code": 0,
  "payload": 任务ID
}

{
  "code": 404,
  "msg": "client not found"
}

{
  "code": 500,
  "msg": 错误内容
}

{
  "code": 0,
  "payload": {
    "done": 是否完成,
    "actions": [
      {
        "action": 任务类型,
        "name": 名称,
        "time": 时间戳,
        "ok": 是否成功,
        "msg": 失败信息
      }, ...
    ]
  }
}

{
  "code": 404,
  "msg": 错误信息
}

{
  "code": 0
}

{
  "code": 0,
  "payload": {
    "clients": 连接客户端数量,
    "plugins": 插件数量,
    "version": 版本号,
    "created": 安装时间
  }
}

{
  "code": 0,
  "payload": {
    "hostname": 主机名,
    "os": linux或windows
  }
}

{
  "code": 0,
  "payload": [
    {
      "id": 机器ID,
      "version": agent版本号,
      "ip": ip地址,
      "mac": mac地址,
      "os": 操作系统（windows或linux）,
      "platform": 操作系统名称（centos或debian）,
      "arch": 操作系统位数（amd64或i386）
    }, ...
  ]
}

{
  "code": 0,
  "payload": 主机ID
}

{
  "code": 404,
  "msg": "client not found"
}

{
  "code": 0,
  "payload": 任务ID
}

{
  "code": 1,
  "msg": 错误内容
}

{
  "code": 404,
  "msg": 错误内容
}

{
  "code": 0,
  "payload": {
    "done": 是否全部完成,
    "created": 开始时间戳,
    "finished": 结束时间戳未完成时为0,
    "total_count": 总触达节点数量,
    "finished_count": 完成节点数量,
    "nodes": [
      {
        "id": 节点ID,
        "created": 开始时间戳,
        "finished": 结束时间戳未完成时为0,
        "ok": 是否成功,
        "msg": 错误信息
      }, ...
    ]
  }
}

{
  "code": 404,
  "msg": 错误内容
}

{
  "code": 0
}

{
  "code": 404,
  "msg": "(client|process) not found"
}

{
  "code": 0,
  "payload": [
    {
      "id": 进程ID,
      "channel": 输出信息的管道ID,
      "name": 进程名称,
      "start_time": 进程创建时间戳,
      "up_time": 启动时间（秒）
    }, ...
  ]
}

{
  "code": 404,
  "msg": "client not found"
}

{
  "code": 0,
  "payload": {
    "channel_id": "20220706-00002-f230bae72f2ca269", // 任务ID
    "pid": 9655 // 进程id
  }
}

{
  "code": 404,
  "msg": "client not found"
}

{
  "code": 408,
  "msg": "timeout"
}

{
  "code": 1,
  "msg": "错误原因"
}

{
  "code": 0,
  "payload": {
    "id": 进程ID,
    "channel": 该进程的channel id,
    "created": 进程创建时间,
    "running": 该进程是否在执行中,
    "code": 返回码（仅当running=false时有效）
  }
}

{
  "code": 404,
  "msg": 错误内容
}

{
  "code": 0,
  "payload": {
    "code": 0, // 返回码（-65535表示执行失败或超时）
    "data": "aGVsbG8gd29ybGQ=", // 返回内容经过base64编码
  }
}

{
  "code": 404,
  "msg": "client not found"
}

{
  "code": 408,
  "msg": "timeout"
}

{
  "code": 1,
  "msg": "错误原因"
}

{
  "code": 0
}

{
  "code": 1,
  "msg": 错误内容
}

{
  "code": 0
}

{
  "code": 404,
  "msg": 错误内容
}

{
  "code": 0
}

{
  "code": 1,
  "msg": 错误内容
}

{
  "code": 404,
  "msg": 错误内容
}

{
  "code": 0
}

{
  "code": 1,
  "msg": 错误内容
}

{
  "code": 404,
  "msg": 错误内容
}

{
  "code": 0,
    "payload": {
      "type": 任务类型,
      "exclude": 去除日志的正则,
      "batch": 批量上报条数,
      "buffer": 批量上报数据量,
      "interval": 批量上报间隔超时时间,
      "created": 创建时间戳,
      "nodes": [
        {
          "id": 节点ID,
          "status": running或stoped,
          "info": [
            { // k8s
              "ns": namespace,
              "name": 项目名,
              "dir": 文件路径,
              "pods": 上一次采集时的pod数量，定期上报
            },
            { // docker
            },
            { // file
              "dir": 文件路径
            }, ...
          ]
        }, ...
      ]
    }
  }
}

{
  "code": 404,
  "msg": 错误内容
}

{
  "code": 0,
  "payload": {
    "dir": 目录,
    "files": [
      {
        "name": 名称,
        "auth": 权限,
        "user": 所属用户,
        "group": 所属组,
        "size": 文件大小,
        "mod_time": 更新时间戳,
        "is_dir": 是否是目录,
        "is_link": 是否是软链
      }, ...
    ]
  }
}

{
  "code": 404,
  "msg": "(client/directory) not found"
}

{
  "code": 408,
  "msg": "timeout"
}

{
  "code": 500,
  "msg": 错误内容
}

{
  "code": 0,
  "payload": {
    "dir": 文件存放路径
  }
}

{
  "code": 404,
  "msg": "client not found"
}

{
  "code": 500,
  "msg": 错误内容
}

{
  "code": 1,
  "msg": 错误内容
}

{
  "code": 2,
  "msg": 错误内容
}

{
  "code": 0,
  "payload": null
}

{
  "code": 404,
  "msg": "client not found"
}

{
  "code": 500,
  "msg": 错误内容
}

{
  "code": 1,
  "msg": 错误内容
}

{
  "code": 2,
  "msg": 错误内容
}

{
  "code": 0,
  "payload": {
    "timestamp": 上报时间戳,
    "host_name": 主机名,
    "uptime": 启动时长,
    "os_name": 系统类型，linux、windows,
    "platform": 系统名称，如debian、centos,
    "platform_version": 系统版本号,
    "kernel_arch": 内核类型，如i386、amd64,
    "kernel_version": 内核版本，如3.10.0-1062.el7.x86_64,
    "physical_core": 物理核心数,
    "logical_core": 逻辑核心数,
    "cores": [
      {
        "processor": 该核心编号,
        "model": 名称，如Intel(R) Xeon(R) CPU E5-2620 v2 @ 2.10GHz,
        "core": 所在物理核上的编号,
        "cores": 某块CPU上的编号,
        "physical": 物理CPU编号
      }, ...
    ]
    "physical_memory": 物理内存大小,
    "swap_memory": swap内存大小,
    "disks": [
      {
        "name": 名称，linux为挂载路径如/run，windows为盘符如C:,
        "type": 文件系统类型，如NTFS,
        "options": [附加参数，如rw，nosuid，nodev, ...],
        "total": 总容量,
        "inodes": inode数量
      }, ...
    ],
    "intfs": [
      {
        "index": 编号,
        "name": 名称,
        "mtu": mtu,
        "flags": [附加信息, ...],
        "mac": mac地址,
        "addrs": [ip地址, ...],
      }, ...
    ]
  }
}

{
  "code": 404,
  "msg": "client not found"
}

{
  "code": 408,
  "msg": "timeout"
}