From e68d103693e2a9192509c105d6199c671509a55a Mon Sep 17 00:00:00 2001 From: Kevin Zheng <147537668+gkevinzheng@users.noreply.github.com> Date: Thu, 18 Apr 2024 11:58:32 -0400 Subject: [PATCH 1/9] docs: Update `dictConfig` snippet to add line that applies the config --- samples/snippets/usage_guide.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/snippets/usage_guide.py b/samples/snippets/usage_guide.py index f4292a9de..abdc5e7c3 100644 --- a/samples/snippets/usage_guide.py +++ b/samples/snippets/usage_guide.py @@ -510,9 +510,9 @@ def logging_dict_config(client): "my_other_logger": {"handlers": ["structured_log"], "level": "INFO"}, }, } - # [END logging_dict_config] logging.config.dictConfig(LOGGING) + # [END logging_dict_config] def _line_no(func): From 109ce92fb73c44305a2c4af84da2b221c419b058 Mon Sep 17 00:00:00 2001 From: Kevin Zheng <147537668+gkevinzheng@users.noreply.github.com> Date: Thu, 18 Apr 2024 12:03:53 -0400 Subject: [PATCH 2/9] Added `import logging.config` into snippet --- samples/snippets/usage_guide.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/snippets/usage_guide.py b/samples/snippets/usage_guide.py index abdc5e7c3..a636fc24e 100644 --- a/samples/snippets/usage_guide.py +++ b/samples/snippets/usage_guide.py @@ -486,9 +486,9 @@ def setup_logging(client): @snippet def logging_dict_config(client): + # [START logging_dict_config] import logging.config - # [START logging_dict_config] import google.cloud.logging client = google.cloud.logging.Client() From 89b216740046704df1dd98838af6909186ec6133 Mon Sep 17 00:00:00 2001 From: Kevin Zheng <147537668+gkevinzheng@users.noreply.github.com> Date: Thu, 18 Apr 2024 12:09:23 -0400 Subject: [PATCH 3/9] Update root handlers dict entry in dictConfig --- samples/snippets/usage_guide.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/snippets/usage_guide.py b/samples/snippets/usage_guide.py index a636fc24e..b4f0287d2 100644 --- a/samples/snippets/usage_guide.py +++ b/samples/snippets/usage_guide.py @@ -504,7 +504,7 @@ def logging_dict_config(client): "class": "google.cloud.logging.handlers.StructuredLogHandler" }, }, - "root": {"handlers": ["console"], "level": "WARNING"}, + "root": {"handlers": ["cloud_logging", "structured_log"], "level": "WARNING"}, "loggers": { "my_logger": {"handlers": ["cloud_logging"], "level": "INFO"}, "my_other_logger": {"handlers": ["structured_log"], "level": "INFO"}, From 54edff6c0fbdc646e341e5f6b0bfc5e00c4b8d34 Mon Sep 17 00:00:00 2001 From: Kevin Zheng <147537668+gkevinzheng@users.noreply.github.com> Date: Thu, 18 Apr 2024 15:07:43 -0400 Subject: [PATCH 4/9] Update usage_guide.py --- samples/snippets/usage_guide.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/samples/snippets/usage_guide.py b/samples/snippets/usage_guide.py index b4f0287d2..1d1f8cb9e 100644 --- a/samples/snippets/usage_guide.py +++ b/samples/snippets/usage_guide.py @@ -496,18 +496,18 @@ def logging_dict_config(client): LOGGING = { "version": 1, "handlers": { - "cloud_logging": { + "cloud_logging_handler": { "class": "google.cloud.logging.handlers.CloudLoggingHandler", "client": client, }, - "structured_log": { + "structured_log_handler": { "class": "google.cloud.logging.handlers.StructuredLogHandler" }, }, - "root": {"handlers": ["cloud_logging", "structured_log"], "level": "WARNING"}, + "root": {"handlers": [], "level": "WARNING"}, "loggers": { - "my_logger": {"handlers": ["cloud_logging"], "level": "INFO"}, - "my_other_logger": {"handlers": ["structured_log"], "level": "INFO"}, + "cloud_logger": {"handlers": ["cloud_logging_handler"], "level": "INFO", "propagate": False}, + "structured_logger": {"handlers": ["structured_log_handler"], "level": "INFO", "propagate": False}, }, } From 3847510c31d27d7d8cb9bb80979d2539387abc5f Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Thu, 18 Apr 2024 19:10:00 +0000 Subject: [PATCH 5/9] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20po?= =?UTF-8?q?st-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- samples/snippets/usage_guide.py | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/samples/snippets/usage_guide.py b/samples/snippets/usage_guide.py index 1d1f8cb9e..8730e1100 100644 --- a/samples/snippets/usage_guide.py +++ b/samples/snippets/usage_guide.py @@ -506,8 +506,16 @@ def logging_dict_config(client): }, "root": {"handlers": [], "level": "WARNING"}, "loggers": { - "cloud_logger": {"handlers": ["cloud_logging_handler"], "level": "INFO", "propagate": False}, - "structured_logger": {"handlers": ["structured_log_handler"], "level": "INFO", "propagate": False}, + "cloud_logger": { + "handlers": ["cloud_logging_handler"], + "level": "INFO", + "propagate": False, + }, + "structured_logger": { + "handlers": ["structured_log_handler"], + "level": "INFO", + "propagate": False, + }, }, } From cd7d2135cf7f7310482e1c86382c5eb7ec72ecc0 Mon Sep 17 00:00:00 2001 From: Kevin Zheng <147537668+gkevinzheng@users.noreply.github.com> Date: Thu, 18 Apr 2024 15:16:36 -0400 Subject: [PATCH 6/9] Remove propagate config option from loggers --- samples/snippets/usage_guide.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/samples/snippets/usage_guide.py b/samples/snippets/usage_guide.py index 8730e1100..a4f356cbd 100644 --- a/samples/snippets/usage_guide.py +++ b/samples/snippets/usage_guide.py @@ -508,13 +508,11 @@ def logging_dict_config(client): "loggers": { "cloud_logger": { "handlers": ["cloud_logging_handler"], - "level": "INFO", - "propagate": False, + "level": "INFO" }, "structured_logger": { "handlers": ["structured_log_handler"], - "level": "INFO", - "propagate": False, + "level": "INFO" }, }, } From e92baee331ee0bf27235048ee83a2e2b9bac16b8 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Thu, 18 Apr 2024 19:18:58 +0000 Subject: [PATCH 7/9] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20po?= =?UTF-8?q?st-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- samples/snippets/usage_guide.py | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/samples/snippets/usage_guide.py b/samples/snippets/usage_guide.py index a4f356cbd..ef8847ba5 100644 --- a/samples/snippets/usage_guide.py +++ b/samples/snippets/usage_guide.py @@ -506,13 +506,10 @@ def logging_dict_config(client): }, "root": {"handlers": [], "level": "WARNING"}, "loggers": { - "cloud_logger": { - "handlers": ["cloud_logging_handler"], - "level": "INFO" - }, + "cloud_logger": {"handlers": ["cloud_logging_handler"], "level": "INFO"}, "structured_logger": { "handlers": ["structured_log_handler"], - "level": "INFO" + "level": "INFO", }, }, } From b6a02b053590119c27f1329492ba4d729c5b1b64 Mon Sep 17 00:00:00 2001 From: Kevin Zheng <147537668+gkevinzheng@users.noreply.github.com> Date: Thu, 18 Apr 2024 15:21:20 -0400 Subject: [PATCH 8/9] Added test for dictConfig snippet --- samples/snippets/usage_guide_test.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/samples/snippets/usage_guide_test.py b/samples/snippets/usage_guide_test.py index f02d82fbd..82ddb1524 100644 --- a/samples/snippets/usage_guide_test.py +++ b/samples/snippets/usage_guide_test.py @@ -88,3 +88,8 @@ def test_client_list_entries(): for item in to_delete: usage_guide._backoff_not_found(item.delete) + +def test_dict_config(): + client = Client() + + usage_guide.logging_dict_config(client) From 4fa191f355763576be5459cf944280f78aef8984 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Thu, 18 Apr 2024 19:24:09 +0000 Subject: [PATCH 9/9] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20po?= =?UTF-8?q?st-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- samples/snippets/usage_guide_test.py | 1 + 1 file changed, 1 insertion(+) diff --git a/samples/snippets/usage_guide_test.py b/samples/snippets/usage_guide_test.py index 82ddb1524..3f606dd65 100644 --- a/samples/snippets/usage_guide_test.py +++ b/samples/snippets/usage_guide_test.py @@ -89,6 +89,7 @@ def test_client_list_entries(): for item in to_delete: usage_guide._backoff_not_found(item.delete) + def test_dict_config(): client = Client()