fix!: Use StructuredLogHandler for Cloud Run Job (#898)

gkevinzheng · gcf-owl-bot[bot] · web-flow · commit 758d43982321 · 2024-07-30T11:47:11.000-04:00
* fix!: Use StructuredLogHandler for Cloud Run Job * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * chore: Merge main into experimental-v4 (#906) * fix: Added missing import into logger.py (#896) * test: Fixed unsupported resource type in system test (#904) * fix: Added type hints to CloudLoggingHandler constructor (#903) * fix: Added type hints to CloudLoggingHandler constructor * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Removed Client typing due to circular imports --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> * feat!: Use StructuredLogHandler on App Engine instead of CloudLoggingHandler (#908) * feat!: Use StructuredLogHandler on App Engine instead of CloudLoggingHandler * linting * fix!: Use StructuredLogHandler for Cloud Run Job * Removed print statement * Resolved all merge conflicts * linting --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
diff --git a/google/cloud/logging_v2/client.py b/google/cloud/logging_v2/client.py
@@ -32,8 +32,14 @@
 from google.cloud.logging_v2.handlers import setup_logging
 from google.cloud.logging_v2.handlers.handlers import EXCLUDED_LOGGER_DEFAULTS
 from google.cloud.logging_v2.resource import Resource
-from google.cloud.logging_v2.handlers._monitored_resources import detect_resource
-
+from google.cloud.logging_v2.handlers._monitored_resources import (
+    detect_resource,
+    _GAE_RESOURCE_TYPE,
+    _GKE_RESOURCE_TYPE,
+    _GCF_RESOURCE_TYPE,
+    _RUN_RESOURCE_TYPE,
+    _CLOUD_RUN_JOB_RESOURCE_TYPE,
+)
 
 from google.cloud.logging_v2.logger import Logger
 from google.cloud.logging_v2.metric import Metric
@@ -56,11 +62,6 @@
 
 _USE_GRPC = _HAVE_GRPC and not _DISABLE_GRPC
 
-_GAE_RESOURCE_TYPE = "gae_app"
-_GKE_RESOURCE_TYPE = "k8s_container"
-_GCF_RESOURCE_TYPE = "cloud_function"
-_RUN_RESOURCE_TYPE = "cloud_run_revision"
-
 
 class Client(ClientWithProject):
     """Client to bundle configuration needed for API requests."""
@@ -381,6 +382,7 @@ def get_default_handler(self, **kw):
             _GKE_RESOURCE_TYPE,
             _GCF_RESOURCE_TYPE,
             _RUN_RESOURCE_TYPE,
+            _CLOUD_RUN_JOB_RESOURCE_TYPE,
         ]
 
         if (
diff --git a/google/cloud/logging_v2/handlers/_monitored_resources.py b/google/cloud/logging_v2/handlers/_monitored_resources.py
@@ -60,6 +60,9 @@
 _GCE_INSTANCE_ID = "instance/id"
 """Attribute in metadata server for compute region and instance."""
 
+_GKE_RESOURCE_TYPE = "k8s_container"
+"""Resource type for the GKE environment."""
+
 _GKE_CLUSTER_NAME = "instance/attributes/cluster-name"
 """Attribute in metadata server when in GKE environment."""
 
@@ -72,6 +75,12 @@
 _GAE_RESOURCE_TYPE = "gae_app"
 """Resource type for App Engine environment."""
 
+_GCF_RESOURCE_TYPE = "cloud_function"
+"""Resource type for Cloud Functions environment."""
+
+_RUN_RESOURCE_TYPE = "cloud_run_revision"
+"""Resource type for Cloud Run environment."""
+
 _CLOUD_RUN_JOB_RESOURCE_TYPE = "cloud_run_job"
 """Resource type for Cloud Run Jobs."""
 
diff --git a/tests/unit/test_client.py b/tests/unit/test_client.py
@@ -798,6 +798,26 @@ def test_get_default_handler_container_engine(self):
 
         self.assertIsInstance(handler, StructuredLogHandler)
 
+    def test_get_default_handler_cloud_run_jobs(self):
+        import os
+        from google.cloud._testing import _Monkey
+        from google.cloud.logging_v2.handlers._monitored_resources import (
+            _CLOUD_RUN_JOB_ENV_VARS,
+        )
+        from google.cloud.logging.handlers import StructuredLogHandler
+
+        credentials = _make_credentials()
+        client = self._make_one(
+            project=self.PROJECT, credentials=credentials, _use_grpc=False
+        )
+
+        cloud_run_job_env_vars = {var: "TRUE" for var in _CLOUD_RUN_JOB_ENV_VARS}
+
+        with _Monkey(os, environ=cloud_run_job_env_vars):
+            handler = client.get_default_handler()
+
+        self.assertIsInstance(handler, StructuredLogHandler)
+
     def test_get_default_handler_general(self):
         import io
         from google.cloud.logging.handlers import CloudLoggingHandler
