Add semantic conventions for Resource labels

.mdlstyle.rb

@@ -17,3 +17,6 @@
 
 # Fenced code blocks should have a language specified
 exclude_rule 'MD040'
+
+# Allow multiple top level headers in the same document
+exclude_rule 'MD025'

specification/data-resource-semantic-conventions.md

@@ -0,0 +1,123 @@
+# Resource Conventions
+
+This section defines standard labels for [Resources](sdk-resource.md). The
+majority of these labels are inherited from
+[OpenCensus Resource standard](https://github.com/census-instrumentation/opencensus-specs/blob/master/resource/StandardResources.md).
+
+* [Service](#service)
+* [Compute Unit](#compute-unit)
+  * [Container](#container)
+* [Deployment Service](#deployment-service)
+  * [Kubernetes](#kubernetes)
+* [Compute Instance](#compute-instance)
+  * [Host](#host)
+* [Environment](#environment)
+  * [Cloud](#cloud)
+  * [Cluster](#cluster)
+
+## TODOs
+
+* Add more compute units: Process, Lambda Function, AppEngine unit, etc.
+* Add Device (mobile) and Web Browser.
+* Decide if lower case strings only.
+* Consider to add optional/required for each label and combination of labels
+  (e.g when supplying a k8s resource all k8s may be required).
+
+### Document Conventions
+
+Labels are grouped logically by the type of the concept that they described. Labels in the same group have a common prefix that ends with a dot. For example all labels that describe Kubernetes properties start with "k8s."
+
+Certain label groups in this document have a **Required** column. For these groups if any label from the particular group is present in the Resource then all labels that are marked as Required MUST be also present in the Resource. However it is also valid if the entire label group is omitted (i.e. none of the labels from the particular group are present even though some of them are marked as Required in this document).
+
+## Service
+
+**type:** `service`
+
+**Description:** A service instance.
+
+| Label  | Description  | Example  | Required? |
+|---|---|---|---|
+| service.name | Logical name of the service. <br/> MUST be the same for all instances of horizontally scaled services. | `shoppingcart` | Yes |
+| service.namespace | A namespace for `service.name`.<br/>A string value having a meaning that helps to distinguish a group of services, for example the team name that owns a group of services. `service.name` is expected to be unique within the same namespace. The field is optional. If `service.namespace` is not specified in the Resource then `service.name` is expected to be unique for all services that have no explicit namespace defined (so the empty/unspecified namespace is simply one more valid namespace). Zero-length namespace string is assumed equal to unspecified namespace. | `Shop` | No |
+| service.instance.id | The string ID of the service instance. <br/>MUST be unique for each instance of the same `service.name/service.namespace` pair and SHOULD be globally unique. Helps to distinguish instances of the same service that exist at the same time (e.g. instances of a horizontally scaled service). It is preferable for the ID to be persistent and stay the same for the lifetime of the service instance, however it is acceptable that the ID is ephemeral and changes during important lifetime events for the service (e.g. service restarts). If the service has no inherent unique ID that can be used as the value of this label it is recommended to generate a random Version 1 or Version 4 RFC 4122 UUID (services aiming for reproducible UUIDs may also use Version 5, see RFC 4122 for more recommendations). | `627cc493-f310-47de-96bd-71410b7dec09` | Yes |
+
+Note: `service.namespace` and `service.name` are not intended to be concatenated for the purpose of forming a single globally unique name for the service. For example the following 2 sets of labels actually describe 2 different services (despite the fact that the concatenation would result in the same string):
+
+```
+# Resource labels that describes a service.
+namespace = Company.Shop
+service.name = shoppingcart
+```
+
+```
+# Another set of resource labels that describe a different service.
+namespace = Company
+service.name = Shop.shoppingcart
+```
+
+## Compute Unit
+
+Labels defining a compute unit (e.g. Container, Process, Lambda Function).
+
+### Container
+
+**type:** `container`
+
+**Description:** A container instance.
+
+| Label  | Description  | Example  |
+|---|---|---|
+| container.name | Container name. | `opentelemetry-autoconf` |
+| container.image.name | Name of the image the container was built on. | `gcr.io/opentelemetry/operator` |
+| container.image.tag | Container image tag. | `0.1` |
+
+## Deployment Service
+
+Labels defining a deployment service (e.g. Kubernetes).
+
+### Kubernetes
+
+**type:** `k8s`
+
+**Description:** A Kubernetes resource.
+
+| Label  | Description  | Example  |
+|---|---|---|
+| k8s.cluster.name | The name of the cluster that the pod is running in. | `opentelemetry-cluster` |
+| k8s.namespace.name | The name of the namespace that the pod is running in. | `default` |
+| k8s.pod.name | The name of the pod. | `opentelemetry-pod-autoconf` |
+| k8s.deployment.name | The name of the deployment. | `opentelemetry` |
+
+## Compute Instance
+
+Labels defining a computing instance (e.g. host).
+
+### Host
+
+**type:** `host`
+
+**Description:** A host is defined as a general computing instance.
+
+| Label  | Description  | Example  |
+|---|---|---|
+| host.hostname | Hostname of the host.<br/> It contains what the `hostname` command returns on the host machine. | `opentelemetry-test` |
+| host.id | Unique host id.<br/> For Cloud this must be the instance_id assigned by the cloud provider | `opentelemetry-test` |
+| host.name | Name of the host.<br/> It may contain what `hostname` returns on Unix systems, the fully qualified, or a name specified by the user. | `opentelemetry-test` |
+| host.type | Type of host.<br/> For Cloud this must be the machine type.| `n1-standard-1` |
+
+## Environment
+
+Labels defining a running environment (e.g. Cloud, Data Center).
+
+### Cloud
+
+**type:** `cloud`
+
+**Description:** A cloud infrastructure (e.g. GCP, Azure, AWS).
+
+| Label  | Description  | Example  |
+|---|---|---|
+| cloud.provider | Name of the cloud provider.<br/> Example values are aws, azure, gcp. | `gcp` |
+| cloud.account.id | The cloud account id used to identify different entities. | `opentelemetry` |
+| cloud.region | A specific geographical location where different entities can run | `us-central1` |
+| cloud.zone | Zones are a sub set of the region connected through low-latency links.<br/> In aws it is called availability-zone. | `us-central1-a` |

specification/data-semantic-conventions.md

@@ -1,7 +1,14 @@
 # Semantic Conventions
 
-This document defines reserved attributes that can be used to add operation and
-protocol specific information.
+_TODO: Remove rule `exclude_rule 'MD025'` from `.mdlstyle.rb` once this document is split and we no longer need 2 top-level headers._
+
+These documents define standard names and values of Resource labels and
+Span attributes.
+
+* [Resource Conventions](data-resource-semantic-conventions.md)
+* [Span Conventions](#span-conventions)
+
+# Span Conventions
 
 In OpenTelemetry spans can be created freely and it’s up to the implementor to
 annotate them with attributes specific to the represented operation. Spans
@@ -22,7 +29,7 @@ For a HTTP client span, `SpanKind` MUST be `Client`.
 
 Given an [RFC 3986](https://www.ietf.org/rfc/rfc3986.txt) compliant URI of the form
 `scheme:[//authority]path[?query][#fragment]`, the span name of the span SHOULD
-be set to to the URI path value.
+be set to the URI path value.
 
 If a framework can identify a value that represents the identity of the request
 and has a lower cardinality than the URI path, this value MUST be used for the span name instead.