Add spec compliant GKE detection (#233)

Author: aabmass

opentelemetry-resourcedetector-gcp/src/opentelemetry/resourcedetector/gcp_resource_detector/_detector.py

@@ -16,6 +16,7 @@
 
 from opentelemetry.resourcedetector.gcp_resource_detector import (
     _gce,
+    _gke,
     _metadata,
 )
 from opentelemetry.sdk.resources import Resource, ResourceDetector
@@ -52,12 +53,31 @@ def detect(self) -> Resource:
         if not _metadata.is_available():
             return Resource.get_empty()
 
+        if _gke.on_gke():
+            return _gke_resource()
         if _gce.on_gce():
             return _gce_resource()
 
         return Resource.get_empty()
 
 
+def _gke_resource() -> Resource:
+    zone_or_region = _gke.availability_zone_or_region()
+    zone_or_region_key = (
+        ResourceAttributes.CLOUD_AVAILABILITY_ZONE
+        if zone_or_region.type == "zone"
+        else ResourceAttributes.CLOUD_REGION
+    )
+    return _make_resource(
+        {
+            ResourceAttributes.CLOUD_PLATFORM_KEY: ResourceAttributes.GCP_KUBERNETES_ENGINE,
+            zone_or_region_key: zone_or_region.value,
+            ResourceAttributes.K8S_CLUSTER_NAME: _gke.cluster_name(),
+            ResourceAttributes.HOST_ID: _gke.host_id(),
+        }
+    )
+
+
 def _gce_resource() -> Resource:
     zone_and_region = _gce.availability_zone_and_region()
     return _make_resource(

opentelemetry-resourcedetector-gcp/src/opentelemetry/resourcedetector/gcp_resource_detector/_gce.py

@@ -16,10 +16,7 @@
 import re
 from dataclasses import dataclass
 
-from opentelemetry.resourcedetector.gcp_resource_detector._metadata import (
-    MetadataAccessException,
-    get_metadata,
-)
+from opentelemetry.resourcedetector.gcp_resource_detector import _metadata
 
 # Format described in
 # https://cloud.google.com/compute/docs/metadata/default-metadata-values#vm_instance_metadata
@@ -32,8 +29,8 @@
 
 def on_gce() -> bool:
     try:
-        get_metadata()["instance"]["machineType"]
-    except (MetadataAccessException, KeyError):
+        _metadata.get_metadata()["instance"]["machineType"]
+    except (_metadata.MetadataAccessException, KeyError):
         _logger.debug(
             "Could not fetch metadata attribute instance/machineType, "
             "assuming not on GCE.",
@@ -44,15 +41,15 @@ def on_gce() -> bool:
 
 
 def host_type() -> str:
-    return get_metadata()["instance"]["machineType"]
+    return _metadata.get_metadata()["instance"]["machineType"]
 
 
 def host_id() -> str:
-    return get_metadata()["instance"]["id"]
+    return _metadata.get_metadata()["instance"]["id"]
 
 
 def host_name() -> str:
-    return get_metadata()["instance"]["name"]
+    return _metadata.get_metadata()["instance"]["name"]
 
 
 @dataclass
@@ -62,7 +59,7 @@ class ZoneAndRegion:
 
 
 def availability_zone_and_region() -> ZoneAndRegion:
-    full_zone = get_metadata()["instance"]["zone"]
+    full_zone = _metadata.get_metadata()["instance"]["zone"]
     match = _ZONE_REGION_RE.search(full_zone)
     if not match:
         raise Exception(

opentelemetry-resourcedetector-gcp/src/opentelemetry/resourcedetector/gcp_resource_detector/_gke.py

@@ -0,0 +1,58 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+from dataclasses import dataclass
+
+from opentelemetry.resourcedetector.gcp_resource_detector import (
+    _gce,
+    _metadata,
+)
+
+# TODO: remove when Python 3.7 is dropped
+from typing_extensions import Literal
+
+KUBERNETES_SERVICE_HOST_ENV = "KUBERNETES_SERVICE_HOST"
+
+
+def on_gke() -> bool:
+    return os.environ.get(KUBERNETES_SERVICE_HOST_ENV) is not None
+
+
+def host_id() -> str:
+    return _gce.host_id()
+
+
+def cluster_name() -> str:
+    return _metadata.get_metadata()["instance"]["attributes"]["cluster-name"]
+
+
+@dataclass
+class ZoneOrRegion:
+    type: Literal["zone", "region"]
+    value: str
+
+
+def availability_zone_or_region() -> ZoneOrRegion:
+    cluster_location = _metadata.get_metadata()["instance"]["attributes"][
+        "cluster-location"
+    ]
+    hyphen_count = cluster_location.count("-")
+    if hyphen_count == 1:
+        return ZoneOrRegion(type="region", value=cluster_location)
+    if hyphen_count == 2:
+        return ZoneOrRegion(type="zone", value=cluster_location)
+    raise Exception(
+        f"unrecognized format for cluster location: {cluster_location}"
+    )

opentelemetry-resourcedetector-gcp/src/opentelemetry/resourcedetector/gcp_resource_detector/_metadata.py

@@ -33,7 +33,13 @@ class Project(TypedDict):
     projectId: str
 
 
+Attributes = TypedDict(
+    "Attributes", {"cluster-location": str, "cluster-name": str}
+)
+
+
 class Instance(TypedDict):
+    attributes: Attributes
     id: str
     machineType: str
     name: str

opentelemetry-resourcedetector-gcp/tests/__snapshots__/test_detector.ambr

@@ -22,3 +22,31 @@
     'telemetry.sdk.version': '1.15.0',
   })
 # ---
+# name: test_detects_gke[regional]
+  dict({
+    'cloud.account.id': 'fakeProject',
+    'cloud.platform': 'gcp_kubernetes_engine',
+    'cloud.provider': 'gcp',
+    'cloud.region': 'us-east4',
+    'host.id': 'fakeId',
+    'k8s.cluster.name': 'fakeClusterName',
+    'service.name': 'unknown_service',
+    'telemetry.sdk.language': 'python',
+    'telemetry.sdk.name': 'opentelemetry',
+    'telemetry.sdk.version': '1.15.0',
+  })
+# ---
+# name: test_detects_gke[zonal]
+  dict({
+    'cloud.account.id': 'fakeProject',
+    'cloud.availability_zone': 'us-east4-b',
+    'cloud.platform': 'gcp_kubernetes_engine',
+    'cloud.provider': 'gcp',
+    'host.id': 'fakeId',
+    'k8s.cluster.name': 'fakeClusterName',
+    'service.name': 'unknown_service',
+    'telemetry.sdk.language': 'python',
+    'telemetry.sdk.name': 'opentelemetry',
+    'telemetry.sdk.version': '1.15.0',
+  })
+# ---

opentelemetry-resourcedetector-gcp/tests/conftest.py

@@ -0,0 +1,32 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+from unittest.mock import MagicMock, patch
+
+import pytest
+from opentelemetry.resourcedetector.gcp_resource_detector import _metadata
+
+
+@pytest.fixture(name="fake_get_metadata")
+def fixture_fake_get_metadata(monkeypatch: pytest.MonkeyPatch) -> MagicMock:
+    mock = MagicMock()
+    monkeypatch.setattr(_metadata, "get_metadata", mock)
+    return mock
+
+
+@pytest.fixture(name="fake_environ")
+def fixture_fake_environ():
+    with patch.dict(os.environ, {}, clear=True):
+        yield

opentelemetry-resourcedetector-gcp/tests/test_detector.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import os
 from unittest.mock import Mock
 
 import pytest
@@ -22,27 +23,34 @@
 )
 
 
-@pytest.fixture(autouse=True)
+@pytest.fixture(name="reset_cache")
 def fixture_reset_cache():
     yield
     _metadata.get_metadata.cache_clear()
     _metadata.is_available.cache_clear()
 
 
-@pytest.fixture(name="fake_get", autouse=True)
+@pytest.fixture(name="fake_get")
 def fixture_fake_get(monkeypatch: pytest.MonkeyPatch):
     mock = Mock()
     monkeypatch.setattr(requests, "get", mock)
     return mock
 
 
-@pytest.fixture(name="fake_metadata", autouse=True)
+@pytest.fixture(name="fake_metadata")
 def fixture_fake_metadata(fake_get: Mock):
     json = {"instance": {}, "project": {}}
     fake_get().json.return_value = json
     return json
 
 
+# Reset stuff before every test
+# pylint: disable=unused-argument
+@pytest.fixture(autouse=True)
+def autouse(reset_cache, fake_get, fake_metadata, fake_environ):
+    pass
+
+
 def test_detects_empty_when_not_available(snapshot, fake_get: Mock):
     fake_get.side_effect = requests.HTTPError()
     assert dict(GoogleCloudResourceDetector().detect().attributes) == snapshot
@@ -66,3 +74,35 @@ def test_detects_gce(snapshot, fake_metadata: _metadata.Metadata):
     )
 
     assert dict(GoogleCloudResourceDetector().detect().attributes) == snapshot
+
+
+@pytest.mark.parametrize(
+    "cluster_location",
+    (
+        pytest.param("us-east4", id="regional"),
+        pytest.param("us-east4-b", id="zonal"),
+    ),
+)
+def test_detects_gke(
+    cluster_location: str, snapshot, fake_metadata: _metadata.Metadata
+):
+    os.environ["KUBERNETES_SERVICE_HOST"] = "fakehost"
+    fake_metadata.update(
+        # All the same attributes as GCE
+        {
+            "project": {"projectId": "fakeProject"},
+            "instance": {
+                "name": "fakeName",
+                "id": "fakeId",
+                "machineType": "fakeMachineType",
+                "zone": "projects/233510669999/zones/us-east4-b",
+                # Plus some attributes
+                "attributes": {
+                    "cluster-name": "fakeClusterName",
+                    "cluster-location": cluster_location,
+                },
+            },
+        }
+    )
+
+    assert dict(GoogleCloudResourceDetector().detect().attributes) == snapshot

opentelemetry-resourcedetector-gcp/tests/test_gce.py

@@ -21,15 +21,14 @@
 )
 
 
-@pytest.fixture(name="fake_get_metadata")
-def fixture_fake_get_metadata(monkeypatch: pytest.MonkeyPatch) -> MagicMock:
-    mock = MagicMock()
-    monkeypatch.setattr(_gce, "get_metadata", mock)
-    return mock
+# Reset stuff before every test
+# pylint: disable=unused-argument
+@pytest.fixture(autouse=True)
+def autouse(fake_get_metadata, fake_environ):
+    pass
 
 
-# pylint: disable=unused-argument
-def test_detects_on_gce(fake_get_metadata: MagicMock) -> None:
+def test_detects_on_gce() -> None:
     assert _gce.on_gce()