search
数据采集 采集器 DataKit DataKit远程管理工具

dkctrl

简介

dkctrl 是datakit远程管理工具,可以通过命令行,查看datakit正常运行状态及数据采集状态,搜索已开启的采集器,开启/关闭采集器,上传/下载采集器配置等等。

下载:

注意: DataKit 版本需在 v1.0.0-1584-g3459928(含)以上,DataWay 版本需在 v1.0.1-518-gd0e23fb(含)以上。

配置

  • 以下命令 dkctrl 替代 ./dkctrl(以linux为例)
  • dkctrl -init -token "wkcli_xxx" 初始化配置,也可以 dkctrl -init 然后自行修改,以下所有命名均可指定token属性 如 dkctrl -list -token "xx"
  • 修改 config.yaml 默认为用户 home 路径 如/Users/admin/config.yaml
dfClient:
  cli_token: wkcli_xxxx
  data_flux_host: "https://console-api.dataflux.cn"  # 默认 dataflux api路径不修改

命令

  • dkctrl -list 列出 datakit online 列表,status 字段 0 表示正常, 2 表示 datakit offline,如不是人为需自行检查datakit状态,输出如下:
[
  {
    "dkUUID": "dkid_btk0mm18d3b2j62nh4o0sssss",
    "ip": "10.100.64.225",
    "name": "hjj",
    "version": "v1.0.0-1526-g3bedc332",
    "status": 2
  },
  {
    "dkUUID": "dkid_btk0mm18d3b2j62nh4o0",
    "ip": "10.100.64.155",
    "name": "ccc",
    "version": "v1.0.0-1525-g362f8d44",
    "status": 0
  }
]

dkctrl -list -format table 可使用 -format 表格输出,默认 json ,其余输出列表format一致,不做赘述。

    ┌────────────────────────────────┬───────────────┬───────────┬───────────────────────┬────────┐
    │ dkUUID                         │ ip            │ name      │ version               │ status │
    ├────────────────────────────────┼───────────────┼───────────┼───────────────────────┼────────┤
    │ dkid_btk0mm18d3b2j62nh4o0sssss │ 10.100.64.225 │ hjj       │ v1.0.0-1526-g3bedc332 │ 2      │
    │ dkid_btk0mm18d3b2j62nh4o0      │ 10.100.64.155 │ xxx       │ v1.0.0-1525-g362f8d44 │ 0      │
    └────────────────────────────────┴───────────────┴───────────┴───────────────────────┴────────┘

  • dkctrl -search "disk" -format table 搜索已经开启某个采集器或 dk name 的 datakit,输出如下:
    ┌────────────────────────────────┬───────────────┬───────────┬───────────────────────┬────────┐
    │ dkUUID                         │ ip            │ name      │ version               │ status │
    ├────────────────────────────────┼───────────────┼───────────┼───────────────────────┼────────┤
    │ dkid_btk0mm18d3b2j62nh4o0sssss │ 10.100.64.225 │ hjj       │ v1.0.0-1526-g3bedc332 │ 2      │
    │ dkid_btk0mm18d3b2j62nh4o0      │ 10.100.64.155 │ xxx       │ v1.0.0-1525-g362f8d44 │ 0      │
    └────────────────────────────────┴───────────────┴───────────┴───────────────────────┴────────┘ 
  • dkctrl -show "dkid_btk0mm18d3b2j62nh4o0" 展示目标datakit的状态。
[
  {
    "category": "/v1/write/metric",
    "count": 34,
    "first": "2020-12-07T16:17:11.104632+08:00",
    "last": "2020-12-07T16:22:41.192337+08:00",
    "name": "disk",
    "total": 40297
  },
  {
    "category": "/v1/write/metric",
    "count": 34,
    "first": "2020-12-07T16:17:11.104639+08:00",
    "last": "2020-12-07T16:22:41.192345+08:00",
    "name": "mem",
    "total": 7578
  }
]

  • dkctrl -on "dkid_btk0mm18d3b2j62nh4o0sssss" -name "wechatminiprogram" 开启已经关闭的采集器。注意:此采集器需存在已经关闭的配置。

正确输出如下:

  on input:wechatminiprogram ok

不存在输出:

enable input err:"input not exist disabled config" 
  • dkctrl -off "dkid_btk0mm18d3b2j62nh4o0sssss" -name "wechatminiprogram" 关闭已经开启的采集器。注意:指定的采集器必须是开启状态。

正确输出如下:

off input:wechatminiprogram ok
  • dkctrl -load "dkid_btk0mm18d3b2j62nh4o0sssss" -name "wechatminiprogram" -path "xxxx/xx/xx.conf" 上传采集器配置到datakit。注意:该采集器是datakit支持的采集器。

正确输出如下:

load input:wechatminiprogram ok
  • dkctrl -save "dkid_btk0mm18d3b2j62nh4o0sssss" -name "wechatminiprogram" -path "xxxx/xx/xx.conf" 从datakit中下载采集器配置。注意:该采集器是开启状态。

正确输出如下:

save input:wechatminiprogram ok