Setting Up Stackdriver Error Reporting for Python

You can send error reports to Stackdriver Error Reporting from Python applications by using the Stackdriver Error Reporting library for Python.

Stackdriver Error Reporting is integrated with some products, such as App Engine. Stackdriver Error Reporting displays the errors that are logged to Stackdriver Logging by applications running on those products. See Running on Google Cloud Platform for more information.

Before you begin

  1. Sign in to your Google Account.

    If you don't already have one, sign up for a new account.

  2. Select or create a GCP project.

    Go to the Manage resources page

  3. Make sure that billing is enabled for your project.

    Learn how to enable billing

  4. Enable the Stackdriver Error Reporting API.

    Enable the API

  5. Prepare your environment for Python development.

    Go to the Python setup guide

Installing the client library

Stackdriver Error Reporting library for Python lets you monitor and view errors reported by Python applications running nearly anywhere.

  1. Use pip to install the package:

    sudo pip install google-cloud-error-reporting --upgrade
    
  2. Import the library and instantiate a client in order to begin reporting errors:

    def simulate_error():
        from google.cloud import error_reporting
    
        client = error_reporting.Client()
        try:
            # simulate calling a method that's not defined
            raise NameError
        except Exception:
            client.report_exception()

For more information on installation, see the documentation for the Stackdriver Error Reporting library for Python. You can also report issues using the issue tracker.

Configuring the client library

You can customize the behavior of Stackdriver Error Reporting library for Python. See [client library documentation](https://googleapis.github.io/google-cloud-python/latest/error-reporting/usage.html#authentication-and-configuration){: class="external" } for configuration examples.

Reporting errors

You can manually report an error by calling the `report` method, as seen in the following example:

def report_manual_error():
    from google.cloud import error_reporting

    client = error_reporting.Client()
    client.report("An error has occurred.")

Running on Google Cloud Platform

Using the Stackdriver Error Reporting library for Python requires the Cloud IAM Error Reporting Writer role. Most Google Cloud Platform computing platforms provide this role by default.

App Engine flexible environment

Google App Engine grants the Error Reporting Writer role by default.

The Stackdriver Error Reporting library for Python can be used without needing to explicitly provide credentials.

Stackdriver Error Reporting is automatically enabled for App Engine environment applications. No additional setup is required.

Kubernetes Engine

On Google Kubernetes Engine, you must add the cloud-platform access scope when creating the cluster, as the following example command shows:

gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

Compute Engine

When using Google Compute Engine VM instances, add the cloud-platform access scope to each instance. When creating a new instance through the Google Cloud Platform Console, you can do this in the Identity and API access section of the Create Instance panel. Use the Compute Engine default service account or another service account of your choice, and select Allow full access to all Cloud APIs in the Identity and API access section. Whichever service account you select, ensure that it has been granted the Error Reporting Writer role in the IAM & admin section of the GCP Console.

Running locally and elsewhere

To use the Stackdriver Error Reporting library for Python outside of Google Cloud Platform, you must supply your GCP project ID and appropriate service account credentials directly to the Stackdriver Error Reporting library for Python. This applies to running the library on your own workstation, on your data center's computers, or on the VM instances of another cloud provider. For more information see Obtaining and providing service account credentials manually.

Viewing error reports

After deployment, you can view error reports in the GCP Console Error Reporting dashboard.

Go to the Error Reporting dashboard

For more information, see Viewing Errors.

Was this page helpful? Let us know how we did:

Send feedback about...

Stackdriver Error Reporting