Python Client for Stackdriver Trace API#

alpha pypi versions

The Stackdriver Trace API sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API.

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 the trace API.

  3. Setup Authentication.


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

With virtualenv, 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.5

Deprecated Python Versions#

Python == 2.7. Python 2.7 support will be removed on January 1, 2020.


pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-trace


pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\pip.exe install google-cloud-trace

For more information on setting up your Python development environment, such as installing pip and virtualenv on your system, please refer to Python Development Environment Setup Guide for Google Cloud Platform.

Example Usage#

from import trace_service_client

client = trace_service_client.TraceServiceClient()
project_id = 'your-project-123'

# Iterate over all results
for element in client.list_traces(project_id):
    # process element

Next Steps#

API Reference#

The current version of the API is v2:

Support for the previous API release, v1, is provided for code previously written against it. In order to use this release, you will want to import from e.g. in lieu of


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