chore: update readme for gcp resource detector (#2062)

Update README of GCP Resource Detector to clarify the source of the data and add semantic conventions. Part Of #2055 Part Of #2025
open-telemetry · Apr 9, 2024 · 4da0268 · 4da0268
1 parent cf25c50
commit 4da0268
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/detectors/node/opentelemetry-resource-detector-gcp/README.md b/detectors/node/opentelemetry-resource-detector-gcp/README.md
@@ -27,6 +27,24 @@ const resource = await detectResources({
 const tracerProvider = new NodeTracerProvider({ resource });
 ```
 
+## Available detectors
+
+This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)
+
+### GCP Detector
+
+| Resource Attribute      | Description                                                   |
+|-------------------------|---------------------------------------------------------------|
+| cloud.account.id        | Value of `project-id` from GCP Metadata project               |
+| cloud.availability_zone | Value of `zone` from GCP Metadata instance                    |
+| cloud.provider          | The cloud provider. In this context, it's always "gcp"        |
+| container.name          | Value of Environment Variable `CONTAINER_NAME`                |
+| host.id                 | Value of `id` from GCP Metadata instance                      |
+| host.name               | Value of `hostname` from GCP Metadata instance                |
+| k8s.cluster.name        | Value of `attributes/cluster-name` from GCP Metadata instance |
+| k8s.namespace.name      | Value of Environment Variable `NAMESPACE`                     |
+| k8s.pod.name            | Value of Environment Variable `HOSTNAME`                      |
+
 ## Useful links
 
 - [GCP Metadata Documentation][]