View Source OpenTelemetry.SemConv.Incubating.HostAttributes (OpenTelemetry.SemConv v1.27.0)
OpenTelemetry Semantic Conventions for Host attributes.
Summary
Types
The CPU architecture the host system is running on.
Functions
The CPU architecture the host system is running on.
The amount of level 2 memory cache available to the processor (in Bytes).
Family or generation of the CPU.
Model identifier. It provides more granular information about the CPU, distinguishing it from other CPUs within the same family.
Model designation of the processor.
Stepping or core revisions.
Processor manufacturer identifier. A maximum 12-character string.
Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider. For non-containerized systems, this should be the machine-id
. See the table below for the sources to use to determine the machine-id
based on operating system.
VM image ID or host OS image ID. For Cloud, this value is from the provider.
Name of the VM image or OS install the host was instantiated from.
The version string of the VM image or host OS as defined in Version Attributes.
Available IP addresses of the host, excluding loopback interfaces.
Available MAC addresses of the host, excluding loopback interfaces.
Name of the host. On Unix systems, it may contain what the hostname command returns, or the fully qualified hostname, or another name specified by the user.
Type of host. For Cloud, this must be the machine type.
Types
Functions
@spec host_arch() :: :"host.arch"
The CPU architecture the host system is running on.
iex> OpenTelemetry.SemConv.Incubating.HostAttributes.host_arch()
:"host.arch"
iex> OpenTelemetry.SemConv.Incubating.HostAttributes.host_arch_values().amd64
:amd64
iex> %{OpenTelemetry.SemConv.Incubating.HostAttributes.host_arch() => OpenTelemetry.SemConv.Incubating.HostAttributes.host_arch_values().amd64}
%{:"host.arch" => :amd64}
?HOST_ARCH.
'host.arch'
?HOST_ARCH_VALUES_AMD64.
'amd64'
#{?HOST_ARCH => ?HOST_ARCH_VALUES_AMD64}.
#{'host.arch' => 'amd64'}
@spec host_arch_values() :: host_arch_values()
@spec host_cpu_cache_l2_size() :: :"host.cpu.cache.l2.size"
The amount of level 2 memory cache available to the processor (in Bytes).
Value type
Value must be of type integer()
.
Examples
[12288000]
iex> OpenTelemetry.SemConv.Incubating.HostAttributes.host_cpu_cache_l2_size()
:"host.cpu.cache.l2.size"
?HOST_CPU_CACHE_L2_SIZE.
'host.cpu.cache.l2.size'
@spec host_cpu_family() :: :"host.cpu.family"
Family or generation of the CPU.
Value type
Value must be of type atom() | String.t()
.
Examples
["6", "PA-RISC 1.1e"]
iex> OpenTelemetry.SemConv.Incubating.HostAttributes.host_cpu_family()
:"host.cpu.family"
?HOST_CPU_FAMILY.
'host.cpu.family'
@spec host_cpu_model_id() :: :"host.cpu.model.id"
Model identifier. It provides more granular information about the CPU, distinguishing it from other CPUs within the same family.
Value type
Value must be of type atom() | String.t()
.
Examples
["6", "9000/778/B180L"]
iex> OpenTelemetry.SemConv.Incubating.HostAttributes.host_cpu_model_id()
:"host.cpu.model.id"
?HOST_CPU_MODEL_ID.
'host.cpu.model.id'
@spec host_cpu_model_name() :: :"host.cpu.model.name"
Model designation of the processor.
Value type
Value must be of type atom() | String.t()
.
Examples
["11th Gen Intel(R) Core(TM) i7-1185G7 @ 3.00GHz"]
iex> OpenTelemetry.SemConv.Incubating.HostAttributes.host_cpu_model_name()
:"host.cpu.model.name"
?HOST_CPU_MODEL_NAME.
'host.cpu.model.name'
@spec host_cpu_stepping() :: :"host.cpu.stepping"
Stepping or core revisions.
Value type
Value must be of type atom() | String.t()
.
Examples
["1", "r1p1"]
iex> OpenTelemetry.SemConv.Incubating.HostAttributes.host_cpu_stepping()
:"host.cpu.stepping"
?HOST_CPU_STEPPING.
'host.cpu.stepping'
@spec host_cpu_vendor_id() :: :"host.cpu.vendor.id"
Processor manufacturer identifier. A maximum 12-character string.
Value type
Value must be of type atom() | String.t()
.
Notes
CPUID command returns the vendor ID string in EBX, EDX and ECX registers. Writing these to memory in this order results in a 12-character string.
Examples
["GenuineIntel"]
iex> OpenTelemetry.SemConv.Incubating.HostAttributes.host_cpu_vendor_id()
:"host.cpu.vendor.id"
?HOST_CPU_VENDOR_ID.
'host.cpu.vendor.id'
@spec host_id() :: :"host.id"
Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider. For non-containerized systems, this should be the machine-id
. See the table below for the sources to use to determine the machine-id
based on operating system.
Value type
Value must be of type atom() | String.t()
.
Examples
["fdbf79e8af94cb7f9e8df36789187052"]
iex> OpenTelemetry.SemConv.Incubating.HostAttributes.host_id()
:"host.id"
?HOST_ID.
'host.id'
@spec host_image_id() :: :"host.image.id"
VM image ID or host OS image ID. For Cloud, this value is from the provider.
Value type
Value must be of type atom() | String.t()
.
Examples
["ami-07b06b442921831e5"]
iex> OpenTelemetry.SemConv.Incubating.HostAttributes.host_image_id()
:"host.image.id"
?HOST_IMAGE_ID.
'host.image.id'
@spec host_image_name() :: :"host.image.name"
Name of the VM image or OS install the host was instantiated from.
Value type
Value must be of type atom() | String.t()
.
Examples
["infra-ami-eks-worker-node-7d4ec78312", "CentOS-8-x86_64-1905"]
iex> OpenTelemetry.SemConv.Incubating.HostAttributes.host_image_name()
:"host.image.name"
?HOST_IMAGE_NAME.
'host.image.name'
@spec host_image_version() :: :"host.image.version"
The version string of the VM image or host OS as defined in Version Attributes.
Value type
Value must be of type atom() | String.t()
.
Examples
["0.1"]
iex> OpenTelemetry.SemConv.Incubating.HostAttributes.host_image_version()
:"host.image.version"
?HOST_IMAGE_VERSION.
'host.image.version'
@spec host_ip() :: :"host.ip"
Available IP addresses of the host, excluding loopback interfaces.
Value type
Value must be of type [atom() | String.t()]
.
Notes
IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses MUST be specified in the RFC 5952 format.
Examples
["192.168.1.140", "fe80::abc2:4a28:737a:609e"]
iex> OpenTelemetry.SemConv.Incubating.HostAttributes.host_ip()
:"host.ip"
?HOST_IP.
'host.ip'
@spec host_mac() :: :"host.mac"
Available MAC addresses of the host, excluding loopback interfaces.
Value type
Value must be of type [atom() | String.t()]
.
Notes
MAC Addresses MUST be represented in IEEE RA hexadecimal form: as hyphen-separated octets in uppercase hexadecimal form from most to least significant.
Examples
["AC-DE-48-23-45-67", "AC-DE-48-23-45-67-01-9F"]
iex> OpenTelemetry.SemConv.Incubating.HostAttributes.host_mac()
:"host.mac"
?HOST_MAC.
'host.mac'
@spec host_name() :: :"host.name"
Name of the host. On Unix systems, it may contain what the hostname command returns, or the fully qualified hostname, or another name specified by the user.
Value type
Value must be of type atom() | String.t()
.
Examples
["opentelemetry-test"]
iex> OpenTelemetry.SemConv.Incubating.HostAttributes.host_name()
:"host.name"
?HOST_NAME.
'host.name'
@spec host_type() :: :"host.type"
Type of host. For Cloud, this must be the machine type.
Value type
Value must be of type atom() | String.t()
.
Examples
["n1-standard-1"]
iex> OpenTelemetry.SemConv.Incubating.HostAttributes.host_type()
:"host.type"
?HOST_TYPE.
'host.type'