As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Python Client for Cloud Logging

Cloud Logging API: Writes log entries and manages your Cloud Logging configuration.

• Client Library Documentation

• Product Documentation

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 Cloud Logging API.

4. Setup Authentication.

For an interactive walkthrough on how to use this library in a python application, click the Guide Me button below:

Installation

Install this library in a venv using pip. venv is a tool to create isolated Python environments. The basic problem it addresses is one of dependencies and versions, and indirectly permissions.

With venv, it’s possible to install this library without needing system install permissions, and without clashing with the installed system dependencies.

Supported Python Versions

Python >= 3.7

Unsupported Python Versions

Python == 2.7. The last version of the library compatible with Python 2.7 is google-cloud-logging==1.15.1.

Python == 3.6. The last version of the library compatible with Python 3.6 is google-cloud-logging==3.1.2.

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

Next Steps

• Read the Setting Up Cloud Logging for Python How-to Guide

• Read the Product documentation to learn more about the product and see other How-to Guides.

• Read the Client Library Documentation for to see other available methods on the client.

Usage Guide

• Usage Guide
  • Integration with logging Standard Library
  • Automatic Trace/Span ID Extraction
  • Integration with Python Web Frameworks
  • Direct Library Usage
  • gRPC vs HTTP

Documentation

• Cloud Logging Client
• Logger
• Log Entries
• Metrics
• Resource
• Sinks
• Handlers
  • Cloud Logging Handler
  • Structured Log Handler
  • [DEPRECATED] App Engine Handler
  • [DEPRECATED] Kubernetes Engine Handler
• Transports
  • Base Transport
  • Background Thread Transport
  • Synchronous Transport

Migration Guides

See the guide below for instructions on migrating between major releases of this library.

• 3.0.0 Migration Guide
  • Primary Changes
• 2.0.0 Migration Guide
  • Supported Python Versions
  • Primary Changes
  • Changes in GAPIC layer

Changelog

For a list of all google-cloud-logging releases:

• Changelog
  • 3.11.3 (2024-10-15)
  • 3.11.2 (2024-08-15)
  • 3.11.1 (2024-08-06)
  • 3.11.0 (2024-07-15)
  • 3.10.0 (2024-03-13)
  • 3.9.0 (2023-12-08)
  • 3.8.0 (2023-10-03)
  • 3.7.0 (2023-09-25)
  • 3.6.0 (2023-07-05)
  • 3.5.0 (2023-01-24)
  • 3.4.0 (2022-12-15)
  • 3.3.1 (2022-12-05)
  • 3.3.0 (2022-11-26)
  • 3.2.4 (2022-10-04)
  • 3.2.3 (2022-09-30)
  • 3.2.2 (2022-08-12)
  • 3.2.1 (2022-07-13)
  • 3.2.0 (2022-07-11)
  • 3.1.2 (2022-06-03)
  • 3.1.1 (2022-05-23)
  • 3.1.0 (2022-05-08)
  • 3.0.0 (2022-01-27)
  • 2.7.0 (2021-11-02)
  • 2.6.0 (2021-07-28)
  • 2.5.0 (2021-06-10)
  • 2.4.0 (2021-05-12)
  • 2.3.1 (2021-03-24)
  • 2.3.0 (2021-03-15)
  • 2.2.0 (2021-01-27)
  • 2.1.1 (2021-01-14)
  • 2.1.0 (2021-01-12)
  • 2.0.2 (2020-12-14)
  • 2.0.1 (2020-12-02)
  • 2.0.0 (2020-11-19)
  • 1.15.1 (2020-07-01)
  • 1.15.0 (2020-02-26)
  • 1.14.0
  • 1.13.0
  • 1.12.1
  • 1.12.0
  • 1.11.0
  • 1.10.0
  • 1.9.1
  • 1.9.0
  • 1.8.0
  • 1.7.0
  • 1.6.0
  • 1.5.0
  • 1.4.0