DiskIO¶

磁盘 IO 采集器用于磁盘流量和时间的指标的采集。

配置¶

成功安装 DataKit 并启动后，会默认开启 DiskIO 采集器，无需手动开启。

前置条件¶

对于部分旧版本 Windows 操作系统，如若遇到 Datakit 报错： "The system cannot find the file specified."

请以管理员身份运行 PowerShell，并执行：

$ diskperf -Y
...

在执行成功后需要重启 Datakit 服务。

采集器配置¶

主机安装Kubernetes

进入 DataKit 安装目录下的 conf.d/host 目录，复制 diskio.conf.sample 并命名为 diskio.conf。示例如下：

[[inputs.diskio]]
  ##(optional) collect interval, default is 10 seconds
  interval = '10s'

  ## By default, gather stats for all devices including
  ## disk partitions.
  ## Setting interfaces using regular expressions will collect these expected devices.
  # devices = ['''^sda\d*''', '''^sdb\d*''', '''vd.*''']

  ## If the disk serial number is not required, please uncomment the following line.
  # skip_serial_number = true

  ## On systems which support it, device metadata can be added in the form of
  ## tags.
  ## Currently only Linux is supported via udev properties. You can view
  ## available properties for a device by running:
  ## 'udevadm info -q property -n /dev/sda'
  ## Note: Most, but not all, udev properties can be accessed this way. Properties
  ## that are currently inaccessible include DEVTYPE, DEVNAME, and DEVPATH.
  # device_tags = ["ID_FS_TYPE", "ID_FS_USAGE"]

  ## Using the same metadata source as device_tags,
  ## you can also customize the name of the device through a template.
  ## The "name_templates" parameter is a list of templates to try to apply equipment.
  ## The template can contain variables of the form "$PROPERTY" or "${PROPERTY}".
  ## The first template that does not contain any variables that do not exist
  ## for the device is used as the device name label.
  ## A typical use case for LVM volumes is to obtain VG/LV names,
  ## not DM-0 names which are almost meaningless.
  ## In addition, "device" is reserved specifically to indicate the device name.
  # name_templates = ["$ID_FS_LABEL","$DM_VG_NAME/$DM_LV_NAME", "$device:$ID_FS_TYPE"]

[inputs.diskio.tags]
  # some_tag = "some_value"
  # more_tag = "some_other_value"

配置好后，重启 DataKit 即可。

可通过 ConfigMap 方式注入采集器配置或配置 ENV_DATAKIT_INPUTS 开启采集器。

也支持以环境变量的方式修改配置参数（需要在 ENV_DEFAULT_ENABLED_INPUTS 中加为默认采集器）：

ENV_INPUT_DISKIO_INTERVAL

采集器重复间隔时长

Type: TimeDuration

ConfField: interval

Default: 10s
ENV_INPUT_DISKIO_DEVICES

使用正则表达式设置接口将收集这些预期的设备

Type: List

ConfField: devices

Example: ^sda\d,^sdb\d,vd.*
ENV_INPUT_DISKIO_DEVICE_TAGS

设备附加标签

Type: List

ConfField: device_tags

Example: ID_FS_TYPE,ID_FS_USAGE
ENV_INPUT_DISKIO_NAME_TEMPLATES

使用与 device_ tags 相同的元数据源

Type: List

ConfField: name_templates

Example: $ID_FS_LABEL,$DM_VG_NAME/$DM_LV_NAME
ENV_INPUT_DISKIO_SKIP_SERIAL_NUMBER

不需要磁盘序列号

Type: Boolean

ConfField: skip_serial_number

Default: false
ENV_INPUT_DISKIO_TAGS

自定义标签。如果配置文件有同名标签，将会覆盖它

Type: Map

ConfField: tags

Example: tag1=value1,tag2=value2

指标¶

以下所有数据采集，默认会追加名为 host 的全局 tag（tag 值为 DataKit 所在主机名），也可以在配置中通过 [[inputs.diskio.tags]] 另择 host 来命名。

`diskio`¶

标签

Tag	Description
`host`	System hostname.
`name`	Device name.

指标列表

Metric	Description	Type	Unit
`io_time`	Time spent doing I/Os.	int	ms
`iops_in_progress`	I/Os currently in progress.	int	count
`merged_reads`	The number of merged read requests.	int	count
`merged_writes`	The number of merged write requests.	int	count
`read_bytes`	The number of bytes read from the device.	int	B
`read_bytes/sec`	The number of bytes read from the per second.	int	B/S
`read_time`	Time spent reading.	int	ms
`reads`	The number of read requests.	int	count
`weighted_io_time`	Weighted time spent doing I/Os.	int	ms
`write_bytes`	The number of bytes written to the device.	int	B
`write_bytes/sec`	The number of bytes written to the device per second.	int	B/S
`write_time`	Time spent writing.	int	ms
`writes`	The number of write requests.	int	count

扩展指标¶

Version-1.5.7

Linux 平台下采集磁盘 `await`¶

默认情况下，DataKit 无法采集磁盘 await 指标，如果需要获取该指标，可以通过自定义 Python 采集器的方式来采集。

进入 DataKit 安装目录，复制 pythond.conf.sample 文件并将其命名为 pythond.conf。修改相应配置如下：

[[inputs.pythond]]

    # Python 采集器名称
    name = 'diskio'  # required

    # 运行 Python 采集器所需的环境变量
    #envs = ['LD_LIBRARY_PATH=/path/to/lib:$LD_LIBRARY_PATH',]

    # Python 采集器可执行程序路径(尽可能写绝对路径)
    cmd = "python3" # required. python3 is recommended.

    # 用户脚本的相对路径(填写文件夹，填好后该文件夹下一级目录的模块和 py 文件都将得到应用)
    dirs = ["diskio"]

安装 sar 命令，具体参考 https://github.com/sysstat/sysstat#installation

ubuntu 安装参考如下

sudo apt-get install sysstat

sudo vi /etc/default/sysstat
# change ENABLED="false" to ENABLED="true"

sudo service sysstat restart

安装完成后，可以执行下述命令，看是否成功。

sar -d -p 3 1

Linux 2.6.32-696.el6.x86_64 (lgh)   10/06/2019      _x86_64_        (32 CPU)

10:08:16 PM       DEV       tps  rd_sec/s  wr_sec/s  avgrq-sz  avgqu-sz     await     svctm     %util
10:08:17 PM    dev8-0      0.00      0.00      0.00      0.00      0.00      0.00      0.00      0.00
10:08:17 PM  dev253-0      0.00      0.00      0.00      0.00      0.00      0.00      0.00      0.00
10:08:17 PM  dev253-1      0.00      0.00      0.00      0.00      0.00      0.00      0.00      0.00

10:08:17 PM       DEV       tps  rd_sec/s  wr_sec/s  avgrq-sz  avgqu-sz     await     svctm     %util
10:08:18 PM    dev8-0      0.00      0.00      0.00      0.00      0.00      0.00      0.00      0.00
10:08:18 PM  dev253-0      0.00      0.00      0.00      0.00      0.00      0.00      0.00      0.00
10:08:18 PM  dev253-1      0.00      0.00      0.00      0.00      0.00      0.00      0.00      0.00

10:08:18 PM       DEV       tps  rd_sec/s  wr_sec/s  avgrq-sz  avgqu-sz     await     svctm     %util
10:08:19 PM    dev8-0      0.00      0.00      0.00      0.00      0.00      0.00      0.00      0.00
10:08:19 PM  dev253-0      0.00      0.00      0.00      0.00      0.00      0.00      0.00      0.00
10:08:19 PM  dev253-1      0.00      0.00      0.00      0.00      0.00      0.00      0.00      0.00

Average:          DEV       tps  rd_sec/s  wr_sec/s  avgrq-sz  avgqu-sz     await     svctm     %util
Average:       dev8-0      0.00      0.00      0.00      0.00      0.00      0.00      0.00      0.00
Average:     dev253-0      0.00      0.00      0.00      0.00      0.00      0.00      0.00      0.00
Average:     dev253-1      0.00      0.00      0.00      0.00      0.00      0.00      0.00      0.00

采集脚本¶

新建文件 <DataKit 目录>/python.d/diskio/diskio.py，脚本内容如下：

import subprocess
import re
from datakit_framework import DataKitFramework


class DiskIO(DataKitFramework):
    name = "diskio"
    interval = 10

    def run(self):
        stats = self.getStats()

        data = []

        for s in stats:
            tags = {
                "name": s.get("DEV", "")
            }
            awaitVal = 0.0
            svctmVal = 0.0

            try:
                awaitVal = float(s.get("await"))
            except:
                awaitVal = 0.0
            try:
                svctmVal = float(s.get("svctm"))
            except:
                svctmVal = 0.0

            fields = {
                "await": awaitVal,
                "svctm": svctmVal
            }
            data.append({
                "measurement": "diskio",
                "tags": tags,
                "fields": fields
            })

        in_data = {
            "M": data,
            "input": "datakitpy"
        }

        return self.report(in_data)

    def getStats(self):
        result = subprocess.run(
            ["sar", "-d", "-p", "3", "1"], stdout=subprocess.PIPE)
        output = result.stdout.decode("utf-8")

        str_list = output.splitlines()

        columns = []
        stats = []
        pattern = r'\s+'
        isAverage = False
        for l in enumerate(str_list):
            index, content = l
            if index < 2:
                continue

            stat = re.split(pattern, content)

            if len(stat) == 0 or stat[0] == "":
                isAverage = True
                continue

            if not isAverage:
                continue
            if "await" in stat and "DEV" in stat:
                columns = stat
            else:
                stat_info = {}
                if len(stat) != len(columns):
                    continue

                for s in enumerate(columns):
                    index, name = s
                    if index == 0:
                        continue
                    stat_info[name] = stat[index]
                stats.append(stat_info)
        return stats

文件保存后，重启 DataKit，稍后即可在观测云平台看到相应的指标。

指标列表¶

sar 命令可以获取很多有用的磁盘指标，上述脚本只采集了 await 和 svctm，如果需要采集额外的指标，可以对脚本进行相应修改。

Metric	Description	Type	Unit
`await`	The average time (in milliseconds) for I/O requests issued to the device to be served. This includes the time spent by the requests in queue and the time spent servicing them.	float	ms
`svctm`	awaitThe average service time (in milliseconds) for I/O requests that were issued to the device.	float	ms

FAQ¶

`diskio` 指标在 Linux 主机上的数据来源是什么¶

在 Linux 主机上，指标从 /proc/diskstats 文件获取并通过解析和计算得出；其中每一列的解释可参考 procfs-diskstats；

部分数据来源列和指标的对应关系为：

`diskstats` 字段	`diskio` 指标
col04: reads completed successfully	`reads`
col05: reads merged	`merged_reads`
col06: sectors read	`read_bytes = col06 * sector_size`; `read_bytes/sec = (read_bytes - last(read_bytes))/(time - last(time))`
col07: time spent reading (ms)	`read_time`
col08: writes completed	`writes`
col09: writes merged	`merged_writes`
col10: sectors written	`write_bytes = col10 * sector_size`; `write_bytes/sec = (write_bytes - last(write_bytes))/(time - last(time))`
col11: time spent writing (ms)	`write_time`
col12: I/Os currently in progress	`iops_in_progress`
col13: time spent doing I/Os (ms)	`io_time`
col14: weighted time spent doing I/Os (ms)	`weighted_io_time`

注意：

扇区大小（sector_size）为 512 字节；
除 read_bytes/sec 和 write_bytes/sec 外均为递增值。