IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› ›

Host Fields

edit

Host Fields

edit

A host is defined as a general computing instance.

ECS host.* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes.

Host Field Details

edit

Field	Description	Level
host.architecture	Operating system architecture. type: keyword example: `x86_64`	core
host.cpu.usage	Percent CPU used which is normalized by the number of CPU cores and it ranges from 0 to 1. Scaling factor: 1000. For example: For a two core host, this value should be the average of the two cores, between 0 and 1. type: scaled_float	extended
host.disk.read.bytes	The total number of bytes (gauge) read successfully (aggregated from all disks) since the last metric collection. type: long	extended
host.disk.write.bytes	The total number of bytes (gauge) written successfully (aggregated from all disks) since the last metric collection. type: long	extended
host.domain	Name of the domain of which the host is a member. For example, on Windows this could be the host’s Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host’s LDAP provider. type: keyword example: `CONTOSO`	extended
host.hostname	Hostname of the host. It normally contains what the `hostname` command returns on the host machine. type: keyword	core
host.id	Unique host id. As hostname is not always unique, use values that are meaningful in your environment. Example: The current usage of `beat.name`. type: keyword	core
host.ip	Host ip addresses. type: ip Note: this field should contain an array of values.	core
host.mac	Host MAC addresses. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. type: keyword Note: this field should contain an array of values. example: `["00-00-5E-00-53-23", "00-00-5E-00-53-24"]`	core
host.name	Name of the host. It can contain what `hostname` returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use. type: keyword	core
host.network.egress.bytes	The number of bytes (gauge) sent out on all network interfaces by the host since the last metric collection. type: long	extended
host.network.egress.packets	The number of packets (gauge) sent out on all network interfaces by the host since the last metric collection. type: long	extended
host.network.ingress.bytes	The number of bytes received (gauge) on all network interfaces by the host since the last metric collection. type: long	extended
host.network.ingress.packets	The number of packets (gauge) received on all network interfaces by the host since the last metric collection. type: long	extended
host.type	Type of host. For Cloud providers this can be the machine type like `t2.medium`. If vm, this could be the container, for example, or other information meaningful in your environment. type: keyword	core
host.uptime	Seconds the host has been up. type: long example: `1325`	extended

Field Reuse

edit

Field sets that can be nested under Host

edit

Field Set	Location	Description
geo	`host.geo.*`	Fields describing a location.
os	`host.os.*`	OS fields contain information about the operating system.
user	`host.user.*`	Fields to describe the user relevant to the event.

« Hash Fields HTTP Fields »