feat!: Infer default resource in logger (#315)

Author: daniel-sanche

packages/google-cloud-logging/.github/.OwlBot.lock.yaml

@@ -14,3 +14,4 @@
 docker:
   image: gcr.io/cloud-devrel-public-resources/owlbot-python:latest
   digest: sha256:ed1f9983d5a935a89fe8085e8bb97d94e41015252c5b6c9771257cf8624367e6
+

packages/google-cloud-logging/google/cloud/logging_v2/client.py

@@ -182,16 +182,21 @@ def metrics_api(self):
                 self._metrics_api = JSONMetricsAPI(self)
         return self._metrics_api
 
-    def logger(self, name):
+    def logger(self, name, *, labels=None, resource=None):
         """Creates a logger bound to the current client.
 
         Args:
             name (str): The name of the logger to be constructed.
+            resource (Optional[~logging_v2.Resource]): a monitored resource object
+                representing the resource the code was run on. If not given, will
+                be inferred from the environment.
+            labels (Optional[dict]): Mapping of default labels for entries written
+                via this logger.
 
         Returns:
             ~logging_v2.logger.Logger: Logger created with the current client.
         """
-        return Logger(name, client=self)
+        return Logger(name, client=self, labels=labels, resource=resource)
 
     def list_entries(
         self,

packages/google-cloud-logging/google/cloud/logging_v2/handlers/handlers.py

@@ -18,7 +18,6 @@
 import json
 import logging
 
-from google.cloud.logging_v2.logger import _GLOBAL_RESOURCE
 from google.cloud.logging_v2.handlers.transports import BackgroundThreadTransport
 from google.cloud.logging_v2.handlers._monitored_resources import detect_resource
 from google.cloud.logging_v2.handlers._helpers import get_request_data
@@ -144,7 +143,7 @@ def __init__(
         *,
         name=DEFAULT_LOGGER_NAME,
         transport=BackgroundThreadTransport,
-        resource=_GLOBAL_RESOURCE,
+        resource=None,
         labels=None,
         stream=None,
     ):
@@ -163,11 +162,14 @@ def __init__(
                 :class:`.BackgroundThreadTransport`. The other
                 option is :class:`.SyncTransport`.
             resource (~logging_v2.resource.Resource):
-                Resource for this Handler. Defaults to ``global``.
+                Resource for this Handler. If not given, will be inferred from the environment.
             labels (Optional[dict]): Additional labels to attach to logs.
             stream (Optional[IO]): Stream to be used by the handler.
         """
         super(CloudLoggingHandler, self).__init__(stream)
+        if not resource:
+            # infer the correct monitored resource from the local environment
+            resource = detect_resource(client.project)
         self.name = name
         self.client = client
         self.transport = transport(client, name)

packages/google-cloud-logging/google/cloud/logging_v2/logger.py

@@ -22,6 +22,7 @@
 from google.cloud.logging_v2.entries import StructEntry
 from google.cloud.logging_v2.entries import TextEntry
 from google.cloud.logging_v2.resource import Resource
+from google.cloud.logging_v2.handlers._monitored_resources import detect_resource
 
 import google.protobuf.message
 
@@ -51,19 +52,23 @@ class Logger(object):
     See https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs
     """
 
-    def __init__(self, name, client, *, labels=None, resource=_GLOBAL_RESOURCE):
+    def __init__(self, name, client, *, labels=None, resource=None):
         """
         Args:
             name (str): The name of the logger.
             client (~logging_v2.client.Client):
                 A client which holds credentials and project configuration
                 for the logger (which requires a project).
-            resource (~logging_v2.Resource): a monitored resource object
-                representing the resource the code was run on.
+            resource (Optional[~logging_v2.Resource]): a monitored resource object
+                representing the resource the code was run on. If not given, will
+                be inferred from the environment.
             labels (Optional[dict]): Mapping of default labels for entries written
                 via this logger.
 
         """
+        if not resource:
+            # infer the correct monitored resource from the local environment
+            resource = detect_resource(client.project)
         self.name = name
         self._client = client
         self.labels = labels

packages/google-cloud-logging/tests/unit/handlers/test_handlers.py

@@ -236,7 +236,9 @@ def _make_one(self, *args, **kw):
 
     def test_ctor_defaults(self):
         import sys
-        from google.cloud.logging_v2.logger import _GLOBAL_RESOURCE
+        from google.cloud.logging_v2.handlers._monitored_resources import (
+            _create_global_resource,
+        )
         from google.cloud.logging_v2.handlers.handlers import DEFAULT_LOGGER_NAME
 
         patch = mock.patch(
@@ -251,7 +253,8 @@ def test_ctor_defaults(self):
             self.assertIsInstance(handler.transport, _Transport)
             self.assertIs(handler.transport.client, client)
             self.assertEqual(handler.transport.name, DEFAULT_LOGGER_NAME)
-            self.assertEqual(handler.resource, _GLOBAL_RESOURCE)
+            global_resource = _create_global_resource(self.PROJECT)
+            self.assertEqual(handler.resource, global_resource)
             self.assertIsNone(handler.labels)
             self.assertIs(handler.stream, sys.stderr)
 

packages/google-cloud-logging/tests/unit/test_client.py

@@ -239,14 +239,20 @@ def make_api(client_obj):
 
     def test_logger(self):
         from google.cloud.logging import Logger
+        from google.cloud.logging_v2.logger import _GLOBAL_RESOURCE
 
         creds = _make_credentials()
         client = self._make_one(project=self.PROJECT, credentials=creds)
-        logger = client.logger(self.LOGGER_NAME)
+        labels = {"test": "true"}
+        logger = client.logger(
+            self.LOGGER_NAME, resource=_GLOBAL_RESOURCE, labels=labels
+        )
         self.assertIsInstance(logger, Logger)
         self.assertEqual(logger.name, self.LOGGER_NAME)
         self.assertIs(logger.client, client)
         self.assertEqual(logger.project, self.PROJECT)
+        self.assertEqual(logger.default_resource, _GLOBAL_RESOURCE)
+        self.assertEqual(logger.labels, labels)
 
     def test_list_entries_defaults(self):
         from google.cloud.logging import TextEntry

packages/google-cloud-logging/tests/unit/test_logger.py

@@ -99,11 +99,15 @@ def test_batch_w_alternate_client(self):
         self.assertIs(batch.client, client2)
 
     def test_log_empty_defaults_w_default_labels(self):
+        from google.cloud.logging_v2.handlers._monitored_resources import (
+            detect_resource,
+        )
+
         DEFAULT_LABELS = {"foo": "spam"}
         ENTRIES = [
             {
                 "logName": "projects/%s/logs/%s" % (self.PROJECT, self.LOGGER_NAME),
-                "resource": {"type": "global", "labels": {}},
+                "resource": detect_resource(self.PROJECT)._to_dict(),
                 "labels": DEFAULT_LABELS,
             }
         ]
@@ -170,7 +174,11 @@ def test_log_empty_w_explicit(self):
         self.assertEqual(api._write_entries_called_with, (ENTRIES, None, None, None))
 
     def test_log_text_defaults(self):
-        RESOURCE = {"type": "global", "labels": {}}
+        from google.cloud.logging_v2.handlers._monitored_resources import (
+            detect_resource,
+        )
+
+        RESOURCE = detect_resource(self.PROJECT)._to_dict()
         TEXT = "TEXT"
         ENTRIES = [
             {
@@ -188,8 +196,12 @@ def test_log_text_defaults(self):
         self.assertEqual(api._write_entries_called_with, (ENTRIES, None, None, None))
 
     def test_log_text_w_unicode_and_default_labels(self):
+        from google.cloud.logging_v2.handlers._monitored_resources import (
+            detect_resource,
+        )
+
         TEXT = "TEXT"
-        RESOURCE = {"type": "global", "labels": {}}
+        RESOURCE = detect_resource(self.PROJECT)._to_dict()
         DEFAULT_LABELS = {"foo": "spam"}
         ENTRIES = [
             {
@@ -265,8 +277,12 @@ def test_log_text_explicit(self):
         self.assertEqual(api._write_entries_called_with, (ENTRIES, None, None, None))
 
     def test_log_struct_defaults(self):
+        from google.cloud.logging_v2.handlers._monitored_resources import (
+            detect_resource,
+        )
+
         STRUCT = {"message": "MESSAGE", "weather": "cloudy"}
-        RESOURCE = {"type": "global", "labels": {}}
+        RESOURCE = detect_resource(self.PROJECT)._to_dict()
         ENTRIES = [
             {
                 "logName": "projects/%s/logs/%s" % (self.PROJECT, self.LOGGER_NAME),
@@ -283,8 +299,12 @@ def test_log_struct_defaults(self):
         self.assertEqual(api._write_entries_called_with, (ENTRIES, None, None, None))
 
     def test_log_struct_w_default_labels(self):
+        from google.cloud.logging_v2.handlers._monitored_resources import (
+            detect_resource,
+        )
+
         STRUCT = {"message": "MESSAGE", "weather": "cloudy"}
-        RESOURCE = {"type": "global", "labels": {}}
+        RESOURCE = detect_resource(self.PROJECT)._to_dict()
         DEFAULT_LABELS = {"foo": "spam"}
         ENTRIES = [
             {
@@ -360,6 +380,9 @@ def test_log_struct_w_explicit(self):
         self.assertEqual(api._write_entries_called_with, (ENTRIES, None, None, None))
 
     def test_log_proto_defaults(self):
+        from google.cloud.logging_v2.handlers._monitored_resources import (
+            detect_resource,
+        )
         import json
         from google.protobuf.json_format import MessageToJson
         from google.protobuf.struct_pb2 import Struct, Value
@@ -369,7 +392,7 @@ def test_log_proto_defaults(self):
             {
                 "logName": "projects/%s/logs/%s" % (self.PROJECT, self.LOGGER_NAME),
                 "protoPayload": json.loads(MessageToJson(message)),
-                "resource": {"type": "global", "labels": {}},
+                "resource": detect_resource(self.PROJECT)._to_dict(),
             }
         ]
         client = _Client(self.PROJECT)
@@ -381,6 +404,9 @@ def test_log_proto_defaults(self):
         self.assertEqual(api._write_entries_called_with, (ENTRIES, None, None, None))
 
     def test_log_proto_w_default_labels(self):
+        from google.cloud.logging_v2.handlers._monitored_resources import (
+            detect_resource,
+        )
         import json
         from google.protobuf.json_format import MessageToJson
         from google.protobuf.struct_pb2 import Struct, Value
@@ -391,7 +417,7 @@ def test_log_proto_w_default_labels(self):
             {
                 "logName": "projects/%s/logs/%s" % (self.PROJECT, self.LOGGER_NAME),
                 "protoPayload": json.loads(MessageToJson(message)),
-                "resource": {"type": "global", "labels": {}},
+                "resource": detect_resource(self.PROJECT)._to_dict(),
                 "labels": DEFAULT_LABELS,
             }
         ]
@@ -465,11 +491,15 @@ def test_log_proto_w_explicit(self):
         self.assertEqual(api._write_entries_called_with, (ENTRIES, None, None, None))
 
     def test_log_inference_empty(self):
+        from google.cloud.logging_v2.handlers._monitored_resources import (
+            detect_resource,
+        )
+
         DEFAULT_LABELS = {"foo": "spam"}
         ENTRIES = [
             {
                 "logName": "projects/%s/logs/%s" % (self.PROJECT, self.LOGGER_NAME),
-                "resource": {"type": "global", "labels": {}},
+                "resource": detect_resource(self.PROJECT)._to_dict(),
                 "labels": DEFAULT_LABELS,
             }
         ]
@@ -482,13 +512,16 @@ def test_log_inference_empty(self):
         self.assertEqual(api._write_entries_called_with, (ENTRIES, None, None, None))
 
     def test_log_inference_text(self):
-        RESOURCE = {"type": "global", "labels": {}}
+        from google.cloud.logging_v2.handlers._monitored_resources import (
+            detect_resource,
+        )
+
         TEXT = "TEXT"
         ENTRIES = [
             {
                 "logName": "projects/%s/logs/%s" % (self.PROJECT, self.LOGGER_NAME),
                 "textPayload": TEXT,
-                "resource": RESOURCE,
+                "resource": detect_resource(self.PROJECT)._to_dict(),
             }
         ]
         client = _Client(self.PROJECT)
@@ -500,13 +533,16 @@ def test_log_inference_text(self):
         self.assertEqual(api._write_entries_called_with, (ENTRIES, None, None, None))
 
     def test_log_inference_struct(self):
+        from google.cloud.logging_v2.handlers._monitored_resources import (
+            detect_resource,
+        )
+
         STRUCT = {"message": "MESSAGE", "weather": "cloudy"}
-        RESOURCE = {"type": "global", "labels": {}}
         ENTRIES = [
             {
                 "logName": "projects/%s/logs/%s" % (self.PROJECT, self.LOGGER_NAME),
                 "jsonPayload": STRUCT,
-                "resource": RESOURCE,
+                "resource": detect_resource(self.PROJECT)._to_dict(),
             }
         ]
         client = _Client(self.PROJECT)
@@ -521,13 +557,16 @@ def test_log_inference_proto(self):
         import json
         from google.protobuf.json_format import MessageToJson
         from google.protobuf.struct_pb2 import Struct, Value
+        from google.cloud.logging_v2.handlers._monitored_resources import (
+            detect_resource,
+        )
 
         message = Struct(fields={"foo": Value(bool_value=True)})
         ENTRIES = [
             {
                 "logName": "projects/%s/logs/%s" % (self.PROJECT, self.LOGGER_NAME),
                 "protoPayload": json.loads(MessageToJson(message)),
-                "resource": {"type": "global", "labels": {}},
+                "resource": detect_resource(self.PROJECT)._to_dict(),
             }
         ]
         client = _Client(self.PROJECT)