Update the description of the host.image attribute (#3194)

open-telemetry · Apr 11, 2023 · b0ba0a9 · b0ba0a9
1 parent 0f6fbe5
commit b0ba0a9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/semantic_conventions/resource/host.yaml b/semantic_conventions/resource/host.yaml
@@ -3,7 +3,7 @@ groups:
     prefix: host
     type: resource
     brief: >
-        A host is defined as a general computing instance.
+        A host is defined as a computing instance. For example, physical servers, virtual machines, switches or disk array.
     attributes:
       - id: id
         type: string
@@ -62,11 +62,11 @@ groups:
       - id: image.id
         type: string
         brief: >
-          VM image ID. For Cloud, this value is from the provider.
+          VM image ID or host OS image ID. For Cloud, this value is from the provider.
         examples: ['ami-07b06b442921831e5']
       - id: image.version
         type: string
         brief: >
-          The version string of the VM image as defined in
+          The version string of the VM image or host OS as defined in
           [Version Attributes](README.md#version-attributes).
         examples: ['0.1']
diff --git a/specification/resource/semantic_conventions/host.md b/specification/resource/semantic_conventions/host.md
@@ -4,7 +4,7 @@
 
 **type:** `host`
 
-**Description:** A host is defined as a general computing instance.
+**Description:** A host is defined as a computing instance. For example, physical servers, virtual machines, switches or disk array.
 
 <!-- semconv host -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
@@ -14,8 +14,8 @@
 | `host.type` | string | Type of host. For Cloud, this must be the machine type. | `n1-standard-1` | Recommended |
 | `host.arch` | string | The CPU architecture the host system is running on. | `amd64` | Recommended |
 | `host.image.name` | string | Name of the VM image or OS install the host was instantiated from. | `infra-ami-eks-worker-node-7d4ec78312`; `CentOS-8-x86_64-1905` | Recommended |
-| `host.image.id` | string | VM image ID. For Cloud, this value is from the provider. | `ami-07b06b442921831e5` | Recommended |
-| `host.image.version` | string | The version string of the VM image as defined in [Version Attributes](README.md#version-attributes). | `0.1` | Recommended |
+| `host.image.id` | string | VM image ID or host OS image ID. For Cloud, this value is from the provider. | `ami-07b06b442921831e5` | Recommended |
+| `host.image.version` | string | The version string of the VM image or host OS as defined in [Version Attributes](README.md#version-attributes). | `0.1` | Recommended |
 
 `host.arch` has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.