README
¶
libagent
agent封装类库，用于快速开发agent
开发方式
已支持功能
-
与agent-server创建websocket连接并进行握手分配agent id
-
标准化日志输出
- 支持stdout和日志文件双目标输出
- 支持DEBUG、WARNING、INFO、ERROR级别的标准格式日志输出
- 支持日志文件的滚动存储
-
支持json、yaml或kv格式的配置文件，以下是一个kv格式配置文件示例
id = example-01 server = 127.0.0.1:13081 # log log.target = stdout #log.target = stdout,file #log.dir = ./logs #log.size = 10M #log.rotate = 7 # monitor monitor.enabled = true monitor.interval = 10s # limit limit.cpu_quota = 100 limit.memory_limit = 1G limit.disk_limit = [{"dev":"8:0","read_bytes":"1M","write_bytes":"1M","read_iops":4000,"write_iops":4000}] -
支持agent的自监控数据上报，可通过配置文件中的monitor相关选项进行配置
-
支持断线重连功能
-
支持系统服务注册
Documentation
¶
Index ¶
- func RegisterService(app App) error
- func Restart(app App) error
- func Run(app App) error
- func Start(app App) error
- func Status(app App) (service.Status, error)
- func Stop(app App) error
- func UnregisterService(app App) error
- type App
- type DummyApp
- func (dm *DummyApp) AgentName() string
- func (dm *DummyApp) ConfDir() string
- func (dm *DummyApp) Configure() *conf.Configure
- func (dm *DummyApp) LoopWrite(context.Context, chan *anet.Msg) error
- func (dm *DummyApp) OnConnect()
- func (dm *DummyApp) OnDisconnect()
- func (dm *DummyApp) OnMessage(*anet.Msg) error
- func (dm *DummyApp) OnReportMonitor()
- func (dm *DummyApp) OnRewriteConfigure() error
- func (dm *DummyApp) OnStop()
- func (dm *DummyApp) Version() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type App ¶
type App interface {
// 获取当前agent名称
AgentName() string
// 获取当前agent版本号
Version() string
// 获取配置文件路径
ConfDir() string
// 获取libagent所需配置
// 该对象必须是一个相对全局作用域的变量，在后续执行过程中该变量将会被更新
Configure() *conf.Configure
// 重置配置文件时的回调函数，在以下情况下会回调
// - 连接成功后服务端分配了新的agent id
OnRewriteConfigure() error
// 连接成功后的回调函数
OnConnect()
// 断开连接时的回调函数
OnDisconnect()
// 触发上报监控信息时的回调函数，该回调一般被用来上报一些自定义监控数据
OnReportMonitor()
// 收到数据包时的回调函数
OnMessage(*anet.Msg) error
// 返回数据包时的回调函数，该函数必须是一个循环，
// 且在有数据需要返回时将其放入第二个参数中的队列内
LoopWrite(context.Context, chan *anet.Msg) error
// 服务退出信号
OnStop()
}
App app 接口，每一个agent必须实现以下接口
type DummyApp ¶ added in v1.1.4
type DummyApp struct {
// contains filtered or unexported fields
}
DummyApp 用于系统服务注册的空App
func NewDummyApp ¶ added in v1.1.0
NewDummyApp 创建一个dummy的APP用于系统服务注册等
func (*DummyApp) OnDisconnect ¶ added in v1.1.4
func (dm *DummyApp) OnDisconnect()
OnDisconnect 连接断开时的回调接口
func (*DummyApp) OnReportMonitor ¶ added in v1.1.4
func (dm *DummyApp) OnReportMonitor()
OnReportMonitor 上报监控数据时的回调接口
func (*DummyApp) OnRewriteConfigure ¶ added in v1.1.4
OnRewriteConfigure 重写配置文件回调接口
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.