运维类接口

查询日志采集状态

URL

GET /api/v1/help/log

描述

查询该Loggie Agent的日志采集状态

请求参数

  • pipeline: 表示只查询某个pipeline的状态
  • status: 如果status=pending,表示只返回正在采集的日志文件状态(包括0%),忽略采集进度100%、文件不存在NaN%和ignored状态

示例:

  1. /api/v1/help/log?pipeline=test&status=pending

表示只返回pipeline为test的正在采集的所有日志文件状态

返回参数

参数名称说明参数类型备注
fdStatus文件句柄状态
fdStatus.activeFdCount活跃的fd个数int
fdStatus.inActiveFdCount不活跃的fd个数int
fileStatus文件采集状态
fileStatus.pipeline.<name>管道状态,对应配置中的pipeline name,参考下面的pipeline参数map
pipeline
参数名称说明参数类型备注
source.<name>pipeline中source的状态,参考下面的source参数map
source
参数名称说明参数类型备注
paths配置文件source中定义的pathstring数组
detailpipeline中source的状态数组
detail[n].filename文件名称string
detail[n].offset采集进度offsetint
detail[n].size文件大小int
detail[n].modify文件最近的更新时间intunix milliseconds
detail[n].ignored文件是否被忽略(由file source中的ignoreOlder配置决定)bool

Example

  1. {
  2. "fdStatus": {
  3. "activeFdCount": 0,
  4. "inActiveFdCount": 1
  5. },
  6. "fileStatus": {
  7. "pipeline": {
  8. "local": {
  9. "source": {
  10. "demo": {
  11. "paths": [
  12. "/tmp/log/*.log"
  13. ],
  14. "detail": [
  15. {
  16. "filename": "/tmp/log/access.log",
  17. "offset": 469,
  18. "size": 469,
  19. "modify": 1673436846523,
  20. "ignored": false
  21. }
  22. ]
  23. }
  24. }
  25. }
  26. }
  27. }
  28. }