Skip to content

Disk

Disk collector is used to collect disk information, such as disk storage space, inode usage, etc.

Configuration

After successfully installing and starting DataKit, the disk collector will be enabled by default without the need for manual activation.

Collector Configuration

Go to the conf.d/host directory under the DataKit installation directory, copy disk.conf.sample and name it disk.conf. Examples are as follows:

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

  ## Physical devices only (e.g. hard disks, cd-rom drives, USB keys)
  ## and ignore all others (e.g. memory partitions such as /dev/shm)
  only_physical_device = false

  ## merge disks that with the same device name(default true)
  # merge_on_device = true

  ## We collect all devices prefixed with dev by default,If you want to collect additional devices, it's in extra_device add
  # extra_device = ["/nfsdata"]

  ## exclude some with dev prefix (We collect all devices prefixed with dev by default)
  # exclude_device = ["/dev/loop0","/dev/loop1"]

  ignore_fstypes = '''^(tmpfs|autofs|binfmt_misc|devpts|fuse.lxcfs|overlay|proc|squashfs|sysfs)$'''
  ignore_mountpoints = '''^(/usr/local/datakit/.*|/run/containerd/.*)$'''

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

Once configured, restart DataKit.

Can be turned on by ConfigMap Injection Collector Configuration or Config ENV_DATAKIT_INPUTS .

Can also be turned on by environment variables, (needs to be added as the default collector in ENV_DEFAULT_ENABLED_INPUTS):

  • ENV_INPUT_DISK_INTERVAL

    Collect interval

    Type: Duration

    input.conf: interval

    Default: 10s

  • ENV_INPUT_DISK_TAGS

    Customize tags. If there is a tag with the same name in the configuration file, it will be overwritten

    Type: Map

    input.conf: tags

    Example: tag1=value1,tag2=value2

  • ENV_INPUT_DISK_EXTRA_DEVICE

    Additional device prefix. (By default collect all devices with dev as the prefix)

    Type: List

    input.conf: extra_device

    Example: /nfsdata,other_data

  • ENV_INPUT_DISK_EXCLUDE_DEVICE

    Excluded device prefix. (By default collect all devices with dev as the prefix)

    Type: List

    input.conf: exclude_device

    Example: /dev/loop0,/dev/loop1

  • ENV_INPUT_DISK_IGNORE_MOUNTPOINTS

    Excluded mount points

    Type: String

    input.conf: ignore_mountpoints

    Example: ^(/usr/local/datakit/.*|/run/containerd/.*)$

  • ENV_INPUT_DISK_INPUT_DISK_IGNORE_FSTYPES

    Excluded file systems

    Type: String

    input.conf: input_disk_ignore_fstypes

    Example: ^(tmpfs|autofs|binfmt_misc|devpts|fuse.lxcfs|overlay|proc|squashfs|sysfs)$

Metric

For all of the following data collections, a global tag named host is appended by default (the tag value is the host name of the DataKit), or other tags can be specified in the configuration by [inputs.disk.tags]:

 [inputs.disk.tags]
  # some_tag = "some_value"
  # more_tag = "some_other_value"
  # ...
Source of disk metrics

Under Linux, we first get device and mount info from /proc/self/mountinfo, then get disk usage metrics via statfs() syscall. For Windows, we get device and mount info via Windows APIs like GetLogicalDriveStringsW(), and get disk usage by another API GetDiskFreeSpaceExW()

In the Version-1.66.0 release, the disk collector has been optimized. However, mount points for the same device will still be merged into one, with only the first mount point being taken. If you need to collect all mount points, a specific flag(merge_on_device/ENV_INPUT_DISK_MERGE_ON_DEVICE) must be disable. While this flag disabled, this may result in a significant increase in the number of time series in the disk measurement.

disk

  • Tags
Tag Description
device Disk device name. (on /dev/mapper return symbolic link, like readlink /dev/mapper/* result)
disk_name Disk name.
fstype File system name.
host System hostname.
mount_point Mount point.
  • Metrics
Metric Description Type Unit
free Free disk size in bytes. int B
inodes_free Free Inode(DEPRECATED: use inodes_free_mb instead). int count
inodes_free_mb Free Inode(need to multiply by 10^6). int count
inodes_total Total Inode(DEPRECATED: use inodes_total_mb instead). int count
inodes_total_mb Total Inode(need to multiply by 10^6). int count
inodes_used Used Inode(DEPRECATED: use inodes_used_mb instead). int count
inodes_used_mb Used Inode(need to multiply by 10^6). int count
inodes_used_percent Inode used percent float percent
total Total disk size in bytes. int B
used Used disk size in bytes. int B
used_percent Used disk size in percent. float percent

Feedback

Is this page helpful? ×