Module host

Module host 

Source
Expand description

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.

Constants§

HOST_ARCHITECTURE
Operating system architecture.
HOST_BOOT_ID
Linux boot uuid taken from /proc/sys/kernel/random/boot_id. Note the boot_id value from /proc may or may not be the same in containers as on the host. Some container runtimes will bind mount a new boot_id value onto the proc file in each container.
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.
HOST_DISK_READ_BYTES
The total number of bytes (gauge) read successfully (aggregated from all disks) since the last metric collection.
HOST_DISK_WRITE_BYTES
The total number of bytes (gauge) written successfully (aggregated from all disks) since the last metric collection.
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.
HOST_GEO_CITY_NAME
City name.
HOST_GEO_CONTINENT_CODE
Two-letter code representing continent’s name.
HOST_GEO_CONTINENT_NAME
Name of the continent.
HOST_GEO_COUNTRY_ISO_CODE
Country ISO code.
HOST_GEO_COUNTRY_NAME
Country name.
HOST_GEO_LOCATION
Longitude and latitude.
HOST_GEO_NAME
User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation.
HOST_GEO_POSTAL_CODE
Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country.
HOST_GEO_REGION_ISO_CODE
Region ISO code.
HOST_GEO_REGION_NAME
Region name.
HOST_GEO_TIMEZONE
The time zone of the location, such as IANA time zone name.
HOST_HOSTNAME
Hostname of the host. It normally contains what the hostname command returns on the host machine.
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.
HOST_IP
Host ip addresses.
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.
HOST_NAME
Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name (FQDN), or a name specified by the user. The recommended value is the lowercase FQDN of the host.
HOST_NETWORK_EGRESS_BYTES
The number of bytes (gauge) sent out on all network interfaces by the host since the last metric collection.
HOST_NETWORK_EGRESS_PACKETS
The number of packets (gauge) sent out on all network interfaces by the host since the last metric collection.
HOST_NETWORK_INGRESS_BYTES
The number of bytes received (gauge) on all network interfaces by the host since the last metric collection.
HOST_NETWORK_INGRESS_PACKETS
The number of packets (gauge) received on all network interfaces by the host since the last metric collection.
HOST_OS_FAMILY
OS family (such as redhat, debian, freebsd, windows).
HOST_OS_FULL
Operating system name, including the version or code name.
HOST_OS_KERNEL
Operating system kernel version as a raw string.
HOST_OS_NAME
Operating system name, without the version.
HOST_OS_PLATFORM
Operating system platform (such centos, ubuntu, windows).
HOST_OS_TYPE
Use the os.type field to categorize the operating system into one of the broad commercial families. If the OS you’re dealing with is not listed as an expected value, the field should not be populated. Please let us know by opening an issue with ECS, to propose its addition.
HOST_OS_VERSION
Operating system version as a raw string.
HOST_PID_NS_INO
This is the inode number of the namespace in the namespace file system (nsfs). Unsigned int inum in include/linux/ns_common.h.
HOST_RISK_CALCULATED_LEVEL
A risk classification level calculated by an internal system as part of entity analytics and entity risk scoring.
HOST_RISK_CALCULATED_SCORE
A risk classification score calculated by an internal system as part of entity analytics and entity risk scoring.
HOST_RISK_CALCULATED_SCORE_NORM
A risk classification score calculated by an internal system as part of entity analytics and entity risk scoring, and normalized to a range of 0 to 100.
HOST_RISK_STATIC_LEVEL
A risk classification level obtained from outside the system, such as from some external Threat Intelligence Platform.
HOST_RISK_STATIC_SCORE
A risk classification score obtained from outside the system, such as from some external Threat Intelligence Platform.
HOST_RISK_STATIC_SCORE_NORM
A risk classification score obtained from outside the system, such as from some external Threat Intelligence Platform, and normalized to a range of 0 to 100.
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.
HOST_UPTIME
Seconds the host has been up.