Skip to content

docs: Refactor logging to use standard library integration #14324

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
camiekim wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Refactor logging to use standard library integration #14324

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ffdb12e
docs: Refactor logging to use standard library integration
camiekim Jun 16, 2026
c692707
docs: Update logging imports to use google.cloud.logging
camiekim Jun 16, 2026
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
47 changes: 26 additions & 21 deletions logging/samples/snippets/snippets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,34 +23,39 @@

import argparse

from google.cloud import logging
import google.cloud.logging

import logging

# [START logging_write_log_entry]
def write_entry(logger_name):
"""Writes log entries to the given logger."""
logging_client = logging.Client()
"""Writes log entries using the Python standard library integration."""
# Instantiate Cloud Logging client
client = google.cloud.logging.Client()
Comment thread
camiekim marked this conversation as resolved.

# This log can be found in the Cloud Logging console under 'Custom Logs'.
logger = logging_client.logger(logger_name)
# Set up standard library integration
# Attaches the CloudLoggingHandler to the root logger.
# The 'name' parameter sets the destination log ID in Cloud Logging.
client.setup_logging(name=logger_name)

# Make a simple text log
logger.log_text("Hello, world!")
# Simple text log
logging.info("Hello, world!")

# Simple text log with severity.
logger.log_text("Goodbye, world!", severity="WARNING")
# Simple text log with severity
# Standard Python logging levels map to Cloud Logging severities.
logging.warning("Goodbye, world!")

# Struct log. The struct can be any JSON-serializable dictionary.
logger.log_struct(
{
"name": "King Arthur",
"quest": "Find the Holy Grail",
"favorite_color": "Blue",
},
severity="INFO",
)
# Structured log (JSON payload)
# Use the 'json_fields' key in the 'extra' argument to log a dictionary.
# Data will appear as the jsonPayload in the Cloud Logging entry.
data_dict = {
"name": "King Arthur",
"quest": "Find the Holy Grail",
"favorite_color": "Blue",
}
logging.info("Quest details", extra={"json_fields": data_dict})

print("Wrote logs to {}.".format(logger.name))
print(f"Wrote logs to {logger_name}.")


# [END logging_write_log_entry]
Expand All @@ -59,7 +64,7 @@ def write_entry(logger_name):
# [START logging_list_log_entries]
def list_entries(logger_name):
"""Lists the most recent entries for a given logger."""
logging_client = logging.Client()
logging_client = google.cloud.logging.Client()
logger = logging_client.logger(logger_name)

print("Listing entries for logger {}:".format(logger.name))
Expand All @@ -78,7 +83,7 @@ def delete_logger(logger_name):

Note that a deletion can take several minutes to take effect.
"""
logging_client = logging.Client()
logging_client = google.cloud.logging.Client()
logger = logging_client.logger(logger_name)

logger.delete()
Expand Down