Python Client for Stackdriver Logging

imageimage

Stackdriver Logging API: Writes log entries and manages your StackdriverLogging configuration.

Quick Start

In order to use this library, you first need to go through the following steps:

  1. Select or create a Cloud Platform project.

  2. Enable billing for your project.

  3. Enable the Stackdriver Logging API.

  4. Setup Authentication.

Installation

Install this library in avenv using pip.venv is a tool tocreate isolated Python environments. The basic problem it addresses is one ofdependencies and versions, and indirectly permissions.

Withvenv, it’s possible to install this library without needing systeminstall permissions, and without clashing with the installed systemdependencies.

Supported Python Versions

Python >= 3.5

Deprecated Python Versions

Python == 2.7. Python 2.7 support was removed on January 1, 2020.

Mac/Linux

python -m venv <your-env>source <your-env>/bin/activate<your-env>/bin/pip install google-cloud-logging

Windows

python -m venv <your-env><your-env>\Scripts\activate<your-env>\Scripts\pip.exe install google-cloud-logging

Using the API

from google.cloud importlogging_v2client =logging_v2.LoggingServiceV2Client()resource = {    "type": "global",    "labels": {        "project_id": "[PROJECT_ID]"    }}"""Log entries can be either LogEntry or dict.You can describe the same data in the following format:e = {    "log_name": "projects/[PROJECT_ID]/logs/test-logging",    "resource": resource,    "text_payload": "this is a log statement",}"""e =logging_v2.types.LogEntry(    log_name="projects/[PROJECT_ID]/logs/test-logging", # optional    resource=resource, # optional    text_payload="this is a log statement")entries = [e]response = client.write_log_entries(entries)
from google.cloud import loggingclient = logging.Client()logger = client.logger('log_name')logger.log_text('A simple entry')  # API call

Example of fetching entries:

from google.cloud import loggingclient = logging.Client()logger = client.logger('log_name')for entry in logger.list_entries():    print(entry.payload)

Next Steps

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-10 UTC.