added section for browsers, clarified device as client-side only

open-telemetry · Nov 10, 2021 · 353a872 · 353a872
1 parent 480a19d
commit 353a872
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 3 deletions.
diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md
@@ -27,7 +27,6 @@ This document defines standard attributes for resources. These attributes are ty
 ## TODOs
 
 * Add more compute units: AppEngine unit, etc.
-* Add Web Browser.
 * Decide if lower case strings only.
 * Consider to add optional/required for each attribute and combination of attributes
   (e.g when supplying a k8s resource all k8s may be required).
@@ -151,11 +150,12 @@ Attributes defining a computing instance (e.g. host):
 Attributes defining a running environment (e.g. Operating System, Cloud, Data Center, Deployment Service):
 
 - [Operating System](./os.md)
-- [Device](./device.md)
+- [Device](./device.md) (client-side)
 - [Cloud](./cloud.md)
 - Deployment:
   - [Deployment Environment](./deployment_environment.md)
   - [Kubernetes](./k8s.md)
+- [Browser](./browser.md)
 
 ## Version attributes
 

diff --git a/specification/resource/semantic_conventions/browser.md b/specification/resource/semantic_conventions/browser.md
@@ -0,0 +1,15 @@
+# Browser
+
+**Status**: [Experimental](../../document-status.md)
+
+**type:** `browser`
+
+**Description**: The web browser in which the application represented by the resource is running. The `browser.*` attributes MUST be used only for resources that represent client-side devices - the presence of these attributes can be used to identify client-side telemetry.
+
+<!-- semconv device -->
+| Attribute  | Type | Description  | Examples  | Required |
+|---|---|---|---|---|
+| `browser.name` | string | The web browser name | `Chrome` | No |
+| `browser.version` | string | The web browser version | `90` | No |
+| `browser.platform` | string | The operating system | `Windows` | No |
+| `browser.mobile` | boolean | Flag indicating a mobile device | | No |
diff --git a/specification/resource/semantic_conventions/device.md b/specification/resource/semantic_conventions/device.md
@@ -4,7 +4,7 @@
 
 **type:** `device`
 
-**Description**: The device on which the process represented by this resource is running.
+**Description**: The device on which the process represented by this resource is running. The `device.*` attributes MUST be used only for resources that represent client-side devices - the presence of these attributes can be used to identify client-side telemetry.
 
 <!-- semconv device -->
 | Attribute  | Type | Description  | Examples  | Required |