Skip to content

feat(logging)!: Use StructuredLogHandler for Cloud Run Jobs by default #18707

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.

Sign up for GitHub

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

Open
fajpunk wants to merge 1 commit into
base: main
Choose a base branch
from
+35 −2
Open

feat(logging)!: Use StructuredLogHandler for Cloud Run Jobs by default #18707

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions packages/google-cloud-logging/google/cloud/logging_v2/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
_GAE_RESOURCE_TYPE = "gae_app"
_GKE_RESOURCE_TYPE = "k8s_container"
_GCF_RESOURCE_TYPE = "cloud_function"
_JOB_RESOURCE_TYPE = "cloud_run_job"
_RUN_RESOURCE_TYPE = "cloud_run_revision"


Expand Down Expand Up @@ -380,15 +381,17 @@ def get_default_handler(self, **kw):
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:
# Bypassing redirects via __stdout__ ensures structured logging
# works robustly on Google Cloud Functions even if stdout is redirected.
kw["stream"] = kw.get("stream", sys.__stdout__)
return StructuredLogHandler(**kw, project_id=self.project)
elif monitored_resource.type == _GKE_RESOURCE_TYPE:
return StructuredLogHandler(**kw, project_id=self.project)
elif monitored_resource.type == _RUN_RESOURCE_TYPE:
return StructuredLogHandler(**kw, project_id=self.project)
elif monitored_resource.type == _JOB_RESOURCE_TYPE:
return StructuredLogHandler(**kw, project_id=self.project)
Comment on lines 391 to +394

@gemini-code-assist gemini-code-assist Bot Oct 15, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Instead of having separate elif blocks that return the exact same StructuredLogHandler instance, we can combine them into a single elif block using membership testing (in). This reduces duplication and improves maintainability.

Suggested change
elif monitored_resource.type == _RUN_RESOURCE_TYPE:
return StructuredLogHandler(**kw, project_id=self.project)
elif monitored_resource.type == _JOB_RESOURCE_TYPE:
return StructuredLogHandler(**kw, project_id=self.project)
elif monitored_resource.type in (_RUN_RESOURCE_TYPE, _JOB_RESOURCE_TYPE):
return StructuredLogHandler(**kw, project_id=self.project)

return CloudLoggingHandler(self, resource=monitored_resource, **kw)

def setup_logging(
Expand Down
30 changes: 30 additions & 0 deletions packages/google-cloud-logging/tests/unit/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -777,6 +777,36 @@ def test_get_default_handler_app_engine(self):

self.assertIsInstance(handler, CloudLoggingHandler)

def test_get_default_handler_cloud_run_job(self):
import os

from google.cloud._testing import _Monkey

from google.cloud.logging.handlers import StructuredLogHandler
from google.cloud.logging_v2.handlers._monitored_resources import (
_CLOUD_RUN_EXECUTION_ID,
_CLOUD_RUN_JOB_ID,
_CLOUD_RUN_TASK_ATTEMPT,
_CLOUD_RUN_TASK_INDEX,
)

credentials = _make_credentials()
client = self._make_one(
project=self.PROJECT, credentials=credentials, _use_grpc=False
)

cloud_run_job_env_vars = {
_CLOUD_RUN_JOB_ID: "TRUE",
_CLOUD_RUN_EXECUTION_ID: "TRUE",
_CLOUD_RUN_TASK_INDEX: "0",
_CLOUD_RUN_TASK_ATTEMPT: "0",
}

with _Monkey(os, environ=cloud_run_job_env_vars):
handler = client.get_default_handler()

self.assertIsInstance(handler, StructuredLogHandler)

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

Expand Down
Loading