You can send error reports to Stackdriver Error Reporting from Python applications by using the Stackdriver Error Reporting library for Python.
Error Reporting is integrated with some Google Cloud Platform services, such as App Engine, Compute Engine, and Google Kubernetes Engine. Error Reporting displays the errors that are logged to Stackdriver Logging by applications running on those services. For more information, go to Running on Google Cloud Platform on this page.
Before you begin
Sign in to your Google Account.
If you don't already have one, sign up for a new account.
Select or create a GCP project.
Make sure that billing is enabled for your Google Cloud Platform project.
- Enable the Error Reporting API .
- Prepare your environment for Python development.
Installing the client library
Stackdriver Error Reporting library for Python lets you monitor and view errors reported by Python applications running nearly anywhere.
Instantiate a virtual environment and use pip to install the package:
pip install google-cloud-error-reporting --upgrade
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()
Configuring the client library
You can customize the behavior of Stackdriver Error Reporting library for Python. See client library documentation for configuration examples.
You can manually report an error by calling the
report method, as seen in the
def report_manual_error(): from google.cloud import error_reporting client = error_reporting.Client() client.report("An error has occurred.") if __name__ == '__main__': simulate_error() report_manual_error()
Running on Google Cloud Platform
App Engine flexible environment
The Stackdriver Error Reporting library for Python can be used without needing to explicitly provide credentials.Error Reporting is automatically enabled for App Engine flexible environment applications. No additional setup is required.
On GKE, you must add the
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
When using Compute Engine VM instances, add the
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
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
Running locally and elsewhere
To use the Stackdriver Error Reporting library for Python outside of GCP, including running the library on your own workstation, on your data center's computers, or on the VM instances of another cloud provider, you must supply your GCP project ID and appropriate service account credentials directly to the Stackdriver Error Reporting library for Python.
You can create and obtain service account credentials manually. When specifying the Role field, use the Error Reporting Writer role. For more information on Cloud Identity and Access Management roles, go to Access control guide.
Viewing error reports
After deployment, you can view error reports in the GCP Console Error Reporting dashboard.
For more information, see Viewing Errors.