这是本节的多页打印视图。 点击此处打印.

返回本页常规视图.

日志采集相关接口

日志采集相关接口，依赖log-agent

1 - /logging/config

下发日志采集配置

参数

  1. pid: 项目ID
  2. type: k8s、docker、logtail中的任意一个
  3. exclude: 去除日志的正则，可选
  4. batch: 批量上报条数，默认1000
  5. buffer: 批量上报数据量，单位字节，默认4096
  6. interval: 批量上报间隔超时时间，单位秒，默认30

k8s参数

  1. ns: 所需采集的namespace
  2. name: 所需采集的项目名，csv
  3. dir: 文件路径，支持通配符
  4. api: k8s接口地址
  5. token: k8s采集时所需的token信息

docker参数

  1. ids: 目标机器id，csv
  2. ct_name: 容器名称
  3. ct_tag: 容器tag，可选
  4. dir: 文件路径，支持通配符

logtail参数

  1. ids: 目标机器id，csv
  2. dir: 文件路径，支持通配符

返回值

{
  "code": 0
}

错误：没有可用的采集节点

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

说明

  1. 当type参数为k8s或docker且dir参数为空时表示采集该容器的stdout输出信息

2 - /logging/remove

删除采集任务

参数

  1. pid: 项目ID

返回值

{
  "code": 0
}

错误，任务不存在

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

3 - /logging/start

启动采集任务

参数

  1. pid: 项目ID

返回值

{
  "code": 0
}

错误，项目已启动

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

错误，任务不存在

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

4 - /logging/stop

停止采集任务

参数

  1. pid: 项目ID

返回值

{
  "code": 0
}

错误，项目未启动

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

错误，任务不存在

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

5 - /logging/task_info

获取采集任务详情

参数

  1. pid: 项目ID

返回值

{
  "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": 错误内容
}