From 3b3e665d64116875dd2cf688e97335f2ec1c0872 Mon Sep 17 00:00:00 2001 From: maryliag Date: Thu, 28 Mar 2024 12:06:48 -0400 Subject: [PATCH] chore: update readme for gcp resource detector Update README of GCP Resource Detector to clarify the source of the data and add semantic conventions. Part Of #2055 Part Of #2025 Signed-off-by: maryliag --- .../README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/detectors/node/opentelemetry-resource-detector-gcp/README.md b/detectors/node/opentelemetry-resource-detector-gcp/README.md index 5262d02c33..5eee1f8820 100644 --- 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][]