Google Cloud Functions

Install

Add the Sentry SDK to your requirements.txt:

 sentry-sdk>=0.17.1

Configure

You can use the Google Cloud Functions integration for the Python SDK like this:

In addition to capturing errors, you can monitor interactions between multiple services or applications by enabling tracing. You can also collect and analyze performance profiles from real users with profiling.

Select which Sentry features you'd like to install in addition to Error Monitoring to get the corresponding installation and configuration instructions below.

import sentry_sdk
from sentry_sdk.integrations.gcp import GcpIntegration

sentry_sdk.init(
    dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
    # Set traces_sample_rate to 1.0 to capture 100%
    # of transactions for tracing.
    traces_sample_rate=1.0,
    # Set profiles_sample_rate to 1.0 to profile 100%
    # of sampled transactions.
    # We recommend adjusting this value in production.
    profiles_sample_rate=1.0,
    integrations=[
        GcpIntegration(),
    ],
)

def http_function_entrypoint(request):
    # ...

Timeout Warning

The timeout warning reports an issue when the function execution time is near the configured timeout.

To enable the warning, update the SDK initialization to set timeout_warning to true:

sentry_sdk.init(
    # ...
    integrations=[
        GcpIntegration(
            timeout_warning=True
        ),
    ],
)

The timeout warning is sent only if the timeout in the Cloud Function configuration is set to a value greater than one second.

Behavior

With the Google Cloud Functions integration enabled, the Python SDK will:

• Automatically report all events from your Cloud Functions

• You can modify the transaction sample rate using traces_sample_rate.

• Issues reports automatically include:

  • A link to the stackdriver logs
  • Function details
  • sys.argv for the function
  • Function execution time (in milliseconds)
  • Function configured time (in seconds)
  • You can add more data as described here

• Request data is attached to all events: HTTP method, URL, headers, form data, JSON payloads. Sentry excludes raw bodies and multipart file uploads. Sentry also excludes personally identifiable information (such as user ids, usernames, cookies, authorization headers, IP addresses) unless you set send_default_pii to True.

• Each request has a separate scope. Changes to the scope within a view, for example setting a tag, will only apply to events sent as part of the request being handled.