主机对象

主机对象采集器用于收集主机基本信息，如硬件型号、基础资源消耗等。

配置¶

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

主机安装Kubernetes

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

[inputs.hostobject]

## Datakit does not collect network virtual interfaces under the linux system.
## Setting enable_net_virtual_interfaces to true will collect network virtual interfaces stats for linux.
# enable_net_virtual_interfaces = true

## Absolute path to the configuration file
# config_path = ["/usr/local/datakit/conf.d/datakit.conf"]

# Do not collect disks that with these file systems
ignore_fstypes = '''^(tmpfs|autofs|binfmt_misc|devpts|fuse.lxcfs|overlay|proc|squashfs|sysfs)$'''
ignore_mountpoints = '''^(/usr/local/datakit/.*|/run/containerd/.*)$'''

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

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

## 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 false)
# merge_on_device = false

## Ignore the disk which space is zero
ignore_zero_bytes_disk = true

# use nsenter to get disk usage
# NOTE: only available under kubernetes
use_nsenter = false

## Disable cloud provider information synchronization
disable_cloud_provider_sync = false

## Enable put cloud provider region/zone_id information into global election tags, (default to true).
# enable_cloud_host_tags_as_global_election_tags = true

## Enable put cloud provider region/zone_id information into global host tags, (default to true).
# enable_cloud_host_tags_as_global_host_tags = true

## Enable AWS IMDSv2
enable_cloud_aws_imds_v2 = false

## Enable AWS IPv6
enable_cloud_aws_ipv6 = false

## Automatically add tags based on whether the host is a physical machine or virtual machine
## Tags in [inputs.hostobject.virtual] section will be added when running on virtual machines
## Tags in [inputs.hostobject.physical] section will be added when running on physical machines
# [inputs.hostobject.virtual]
  # host_type = "virtual"
  # env = "cloud"
  # monitoring_mode = "vm"

# [inputs.hostobject.physical]
  # host_type = "physical"
  # env = "on-premise"
  # hardware_optimized = "true"

## [inputs.hostobject.tags] # (optional) custom tags
  # cloud_provider = "aliyun" # aliyun/tencent/aws/hwcloud/azure/volcengine, probe automatically if not set
  # some_tag = "some_value"
  # more_tag = "some_other_value"
  # ...

## [inputs.hostobject.cloud_meta_url]
  # tencent = "xxx"  # URL for Tencent Cloud metadata
  # aliyun = "yyy"   # URL for Alibaba Cloud metadata
  # aws = "zzz"
  # azure = ""
  # Hwcloud = ""
  # volcengine = ""

## [inputs.hostobject.cloud_meta_token_url]
  # aws = "yyy"   # URL for AWS Cloud metadata token

配置好后，重启 DataKit 即可。

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

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

ENV_INPUT_HOSTOBJECT_ENABLE_NET_VIRTUAL_INTERFACES

允许采集虚拟网卡

字段类型: Boolean

采集器配置字段: enable_net_virtual_interfaces

默认值: false
ENV_INPUT_HOSTOBJECT_IGNORE_ZERO_BYTES_DISK

忽略大小为 0 的磁盘

字段类型: Boolean

采集器配置字段: ignore_zero_bytes_disk

默认值: false
ENV_INPUT_HOSTOBJECT_IGNORE_FSTYPES

磁盘列表采集时忽略特定的文件系统

字段类型: String

采集器配置字段: ignore_fstypes

默认值: ^(tmpfs|autofs|binfmt_misc|devpts|fuse.lxcfs|overlay|proc|squashfs|sysfs)$
ENV_INPUT_HOSTOBJECT_IGNORE_MOUNTPOINTS

磁盘列表采集时忽略特定的挂载点

字段类型: String

采集器配置字段: ignore_mountpoints

默认值: ^(/usr/local/datakit/.*|/run/containerd/.*)$
ENV_INPUT_HOSTOBJECT_EXCLUDE_DEVICE

忽略的 device

字段类型: List

采集器配置字段: exclude_device

示例: /dev/loop0,/dev/loop1
ENV_INPUT_HOSTOBJECT_EXTRA_DEVICE

额外增加的 device

字段类型: List

采集器配置字段: extra_device

示例: /nfsdata,other
ENV_INPUT_HOSTOBJECT_CLOUD_META_AS_ELECTION_TAGS

将云服务商 region/zone_id 信息放入全局选举标签

字段类型: Boolean

采集器配置字段: enable_cloud_host_tags_global_election_tags

默认值: true
ENV_INPUT_HOSTOBJECT_CLOUD_META_AS_HOST_TAGS

将云服务商 region/zone_id 信息放入全局主机标签

字段类型: Boolean

采集器配置字段: enable_cloud_host_tags_global_host_tags

默认值: true
ENV_INPUT_HOSTOBJECT_CLOUD_AWS_IMDS_V2

开启 AWS IMDSv2

字段类型: Boolean

采集器配置字段: enable_cloud_aws_imds_v2

默认值: false
ENV_INPUT_HOSTOBJECT_CLOUD_AWS_IPV6

开启 AWS IPv6

字段类型: Boolean

采集器配置字段: enable_cloud_aws_ipv6

默认值: false
ENV_INPUT_HOSTOBJECT_TAGS

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

字段类型: Map

采集器配置字段: tags

示例: tag1=value1,tag2=value2
ENV_INPUT_HOSTOBJECT_CLOUD_PROVIDER

指定云服务商

字段类型: String

采集器配置字段: none

示例: aliyun/aws/tencent/hwcloud/azure
ENV_INPUT_HOSTOBJECT_CLOUD_META_URL

云服务商元数据 URL 映射

字段类型: Map

采集器配置字段: cloud_meta_url

示例: {"tencent":"xxx", "aliyun":"yyy"}
ENV_INPUT_HOSTOBJECT_CLOUD_META_TOKEN_URL

云服务商获取元数据的 Token URL 映射

字段类型: Map

采集器配置字段: cloud_meta_token_url

示例: {"aws":"xxx","aliyun":"yyy"}
ENV_INPUT_HOSTOBJECT_DISABLE_CLOUD_PROVIDER_SYNC

禁止同步主机云信息

字段类型: Boolean

采集器配置字段: disable_cloud_provider_sync

示例: true
ENV_INPUT_HOSTOBJECT_USE_NSENTER

用 nsenter 方式来采集磁盘用量信息

字段类型: Boolean

采集器配置字段: use_nsenter

示例: true

开启云同步¶

DataKit 默认开启云同步，目前支持阿里云/腾讯云/AWS/华为云/微软云/火山引擎/谷歌云。可以通过设置 cloud_provider tag 显式指定云厂商，也可以由 DataKit 自动进行探测：

[inputs.hostobject.tags]
  # 此处目前支持 aliyun/tencent/aws/hwcloud/azure/gcp 几种，若不设置，则由 DataKit 自动探测并设置此 tag
  cloud_provider = "aliyun"

可以通过在配置文件中配置 disable_cloud_provider_sync = true 关闭云同步功能。

对象¶

以下所有数据采集，默认会追加名为 host 的全局 tag（tag 值为 DataKit 所在主机名），也可以在配置中通过 [inputs.hostobject.tags] 指定其它标签：

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

Quote

这里添加自定义 tag 时，尽量不要跟已有的 tag key/field key 同名。如果同名，DataKit 将选择配置里面的 tag 来覆盖采集的数据，可能导致一些数据问题。

`HOST`¶

Tags & Fields	Description
arch (`tag`)	Host OS Arch
host (`tag`)	Hostname. Required.
name (`tag`)	Hostname
os (`tag`)	Host OS type
unicast_ip (`tag`)	Host unicast ip
cpu_usage	CPU usage Type: float \| (gauge) Unit: percent,percent
datakit_ver	Collector version Type: string Unit: -
disk_total	Disk total Type: int \| (gauge) Unit: digital,B
disk_used_percent	Disk usage Type: float \| (gauge) Unit: percent,percent
diskio_read_bytes_per_sec	Disk read rate Type: int \| (gauge) Unit: traffic,B/S
diskio_write_bytes_per_sec	Disk write rate Type: int \| (gauge) Unit: traffic,B/S
dk_upgrader	Upgrade's host and port Type: string Unit: -
is_docker	Docker mode Type: int Unit: -
load	System load Type: float \| (gauge) Unit: -
logging_level	Log level Type: string Unit: -
mem_used_percent	Memory usage Type: float \| (gauge) Unit: percent,percent
message	Summary of all host information Type: string Unit: -
net_recv_bytes_per_sec	Network receive rate Type: int \| (gauge) Unit: traffic,B/S
net_send_bytes_per_sec	Network send rate Type: int \| (gauge) Unit: traffic,B/S
num_cpu	CPU numbers Type: int \| (gauge) Unit: count
start_time	Host startup time (Unix timestamp) Type: int Unit: time,ms

如果开启了云同步，会多出如下一些字段（以同步到的字段为准）：

字段名	描述	类型
`cloud_provider`	云服务商	string
`description`	描述	string
`instance_id`	实例 ID	string
`instance_name`	实例名	string
`instance_type`	实例类型	string
`instance_charge_type`	实例计费类型	string
`instance_network_type`	实例网络类型	string
`instance_status`	实例状态	string
`security_group_id`	实例分组	string
`private_ip`	实例私网 IP	string
`zone_id`	实例 Zone ID	string
`region`	实例 Region ID	string
`project_id`	项目 ID	string

`message` 指标字段结构¶

message 字段基本结构如下：

{
  "host": {
    "meta": ...,
    "cpu": ...,
    "mem": ...,
    "net": ...,
    "disk": ...,
    "conntrack": ...,
    "filefd": ...,
    "election": ...,
    "config_file": ...,
  },

  "collectors": [ # 各个采集器的运行情况
    ...
  ]
}

`host.meta`¶

字段名	描述	类型
`host_name`	主机名	string
`boot_time`	开机时间	int
`os`	操作系统类型，如 `linux/windows/darwin`	string
`platform`	平台名称，如 `ubuntu`	string
`platform_family`	平台分类，如 `ubuntu` 属于 `debian` 分类	string
`platform_version`	平台版本，如 `18.04`，即 Ubuntu 的某个分发版本	string
`kernel_release`	内核版本，如 `4.15.0-139-generic`	string
`arch`	CPU 硬件架构，如 `x86_64/arm64` 等	string
`extra_cloud_meta`	开启云同步时，会带上一串云属性的 JSON 数据	string

`host.cpu`¶

字段名	描述	类型
`vendor_id`	供应商 ID，如 `GenuineIntel`	string
`module_name`	CPU 型号，如 `Intel(R) Core(TM) i5-8210Y CPU @ 1.60GHz`	string
`cores`	核数	int
`mhz`	频率	int
`cache_size`	L2 缓存大小（KB）	int

`host.mem`¶

字段名	描述	类型
`memory_total`	总内存大小	int
`swap_total`:	swap 大小	int

`host.net`¶

字段名	描述	类型
`mtu`	最大传输单元	int
`name`	网卡名称	string
`mac`	MAC 地址	string
`flags`	状态位（可能多个）	[]string
`ip4`	IPv4 地址	string
`ip6`	IPv6 地址	string
`ip4_all`	所有 IPv4 地址	[]string
`ip6_all`	所有 IPv6 地址	[]string

`host.disk`¶

Quote

之前的版本中，同一个设备只会采集一个挂载点（具体采集哪一个，以具体挂载点在 /proc/self/mountpoint 出现的顺序为准）。在 Version-1.66.0 版本中，主机对象中的磁盘部份会将符合条件（比如设备名以 /dev 开头）挂载点都采集上来，其目的是为了展示 DataKit 能看到的所有设备，避免遗漏。

字段名	描述	类型
`device`	磁盘设备名	string
`total`	磁盘总大小	int
`mountpoint`	挂载点	string
`fstype`	文件系统类型	string

`host.election`¶

Quote

当配置文件中 enable_election 选项关闭时，该字段为 null

字段名	描述	类型
`elected`	选举状态	string
`namespace`	选举空间	string

`host.conntrack`¶

Quote

conntrack 仅 Linux 平台支持
Linux 下有时候这俩个指标采集不到，显示为 -1。此时我们需要加载 nf_conntrack 模块，终端执行如下命令即可：
```
modprobe nf_conntrack
```

字段名	描述	类型
`entries`	当前连接数量	int
`entries_limit`	连接跟踪表的大小	int
`stat_found`	成功的搜索条目数目	int
`stat_invalid`	不能被跟踪的包数目	int
`stat_ignore`	已经被跟踪的报数目	int
`stat_insert`	插入的包数目	int
`stat_insert_failed`	插入失败的包数目	int
`stat_drop`	跟踪失败被丢弃的包数目	int
`stat_early_drop`	由于跟踪表满而导致部分已跟踪包条目被丢弃的数目	int
`stat_search_restart`	由于 hash 表大小修改而导致跟踪表查询重启的数目	int

`host.filefd`¶

Quote

filefd 仅 Linux 平台支持

字段名	描述	类型
`allocated`	已分配文件句柄的数目	int
`maximum`	文件句柄的最大数目（已弃用，用 `maximum_mega` 替代）	int
`maximum_mega`	文件句柄的最大数目，单位 M(10^6)	float

`host.config_file`¶

config_file 是一个 {"file-path": "file-content"} 的 map，每个字段的含义如下：

字段名	描述	类型
`file-path`	配置文件的绝对路径	string
`file-content`	配置文件的内容	string

采集器运行情况字段列表¶

collectors 字段是一个对象列表，每个对象的字段如下：

字段名	描述	类型
`name`	采集器名称	string
`count`	采集次数	int
`last_err`	最后一次报错信息，只报告最近 30 秒（含）以内的错误	string
`last_err_time`	最后一次报错时间（Unix 时间戳，单位为秒）	int
`last_time`	最近一次采集时间（Unix 时间戳，单位为秒）	int

主机对象

配置¶

开启云同步¶

对象¶

HOST¶

message 指标字段结构¶

host.meta¶

host.cpu¶

host.mem¶

host.net¶

host.disk¶

host.election¶

host.conntrack¶

host.filefd¶

host.config_file¶

采集器运行情况字段列表¶

文档内容是否对您有帮助？ ×

`HOST`¶

`message` 指标字段结构¶

`host.meta`¶

`host.cpu`¶

`host.mem`¶

`host.net`¶

`host.disk`¶

`host.election`¶

`host.conntrack`¶

`host.filefd`¶

`host.config_file`¶