8000 feat!: Use StructuredLogHandler on App Engine instead of CloudLoggingHandler by gkevinzheng · Pull Request #908 · googleapis/python-logging · GitHub
[go: up one dir, main page]

Skip to content

feat!: Use StructuredLogHandler on App Engine instead of CloudLoggingHandler #908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8000 28 changes: 18 additions & 10 deletions google/cloud/logging_v2/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -376,18 +376,26 @@ def get_default_handler(self, **kw):
"""
monitored_resource = kw.pop("resource", detect_resource(self.project))

if isinstance(monitored_resource, Resource):
if monitored_resource.type == _GAE_RESOURCE_TYPE:
return CloudLoggingHandler(self, resource=monitored_resource, **kw)
elif monitored_resource.type == _GKE_RESOURCE_TYPE:
return StructuredLogHandler(**kw, project_id=self.project)
elif monitored_resource.type == _GCF_RESOURCE_TYPE:
_structured_log_types = [
_GAE_RESOURCE_TYPE,
_GKE_RESOURCE_TYPE,
_GCF_RESOURCE_TYPE,
_RUN_RESOURCE_TYPE,
]

if (
isinstance(monitored_resource, Resource)
and monitored_resource.type in _structured_log_types
):
if monitored_resource.type == _GCF_RESOURCE_TYPE:
# __stdout__ stream required to support structured logging on Python 3.7
kw["stream"] = kw.get("stream", sys.__stdout__)
return StructuredLogHandler(**kw, project_id=self.project)
elif monitored_resource.type == _RUN_RESOURCE_TYPE:
return StructuredLogHandler(**kw, project_id=self.project)
return CloudLoggingHandler(self, resource=monitored_resource, **kw)

handler = StructuredLogHandler(**kw, project_id=self.project)
else:
handler = CloudLoggingHandler(self, resource=monitored_resource, **kw)

return handler

def setup_logging(
self, *, log_level=logging.INFO, excluded_loggers=EXCLUDED_LOGGER_DEFAULTS, **kw
Expand Down
6 changes: 2 additions & 4 deletions tests/unit/test_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -766,7 +766,7 @@ def test_get_default_handler_app_engine(self):
import os
from google.cloud._testing import _Monkey
from google.cloud.logging_v2.handlers._monitored_resources import _GAE_ENV_VARS
from google.cloud.logging.handlers import CloudLoggingHandler
from google.cloud.logging.handlers import StructuredLogHandler

credentials = _make_credentials()
client = self._make_one(
Expand All @@ -778,9 +778,7 @@ def test_get_default_handler_app_engine(self):
with _Monkey(os, environ=gae_env_vars):
handler = client.get_default_handler()

handler.transport.worker.stop()

self.assertIsInstance(handler, CloudLoggingHandler)
self.assertIsInstance(handler, StructuredLogHandler)

def test_get_default_handler_container_engine(self):
from google.cloud.logging.handlers import StructuredLogHandler
Expand Down
0