Host Object¶

Host Object is used to collect basic host information, such as hardware model, basic resource consumption and so on.

Configuration¶

Collector Configuration¶

In general, the host object is turned on by default and does not need to be configured.

[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

##############################
# Disk related options
##############################
## Deprecated
# ignore_fs = ["tmpfs", "devtmpfs", "devfs", "iso9660", "overlay", "autofs", "squashfs", "aufs"]

## 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

# Ignore the disk which space is zero
ignore_zero_bytes_disk = true

# 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_global_election = true

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

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

Enable collect network virtual interfaces

**Type**: Boolean

**ConfField**: `enable_net_virtual_interfaces`

**Default**: false

Turn on Cloud Synchronization¶

Datakit turns on cloud synchronization by default, and currently supports Alibaba Cloud/Tencent Cloud/AWS/Huawei Cloud/Microsoft Cloud. You can specify the cloud vendor explicitly by setting the cloud_provider tag, or you can detect it automatically by Datakit:

[inputs.hostobject.tags]
  # There are several kinds of aliyun/tencent/aws/hwcloud/azure supported at present. If not set, Datakit will detect and set this tag automatically
  cloud_provider = "aliyun"

You can turn off cloud synchronization by configuring disable_cloud_provider_sync = true in the Host Object configuration file.

Object¶

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.hostobject.tags]:

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

Note: When adding custom tags here, try not to have the same name as the existing tag key/field key. If it has the same name, DataKit will choose to configure the tag inside to overwrite the collected data, which may cause some data problems.

HOST¶

• tag

• metric list

If cloud synchronization is turned on, the following additional fields will be added (whichever field is synchronized to):

message Metric Field Structure¶

The basic structure of the message field is as follows:

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

  "collectors": [ # Operation of each collector
    ...
  ]
}

host.meta¶

host.cpu¶

host.mem¶

host.net¶

host.disk¶

host.election¶

Note: This field is null when the enable_election option is turned off in the configuration file

host.conntrack¶

host.filefd¶

Collector Performance Field List¶

The collectors field is a list of objects with the following fields for each object:

FAQ¶

Why no entries and entries_limit, the value shows -1？¶

Need to load nf_conntrack module, run modprobe nf_conntrack in a terminal.