GCP Functions

(New in version 0.17.1)

Install

Add the Sentry SDK to your requirements.txt:

requirements.txt
Copied
 sentry-sdk>=0.17.1

Configure

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

Copied
import sentry_sdk
from sentry_sdk.integrations.gcp import GcpIntegration

sentry_sdk.init(
    dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
    integrations=[GcpIntegration()],
)

def http_function_entrypoint(request):
    # ...

Check out Sentry's GCP sample apps for detailed examples.

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:

Copied
sentry_sdk.init(
    dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
    integrations=[GcpIntegration(timeout_warning=True)],
)

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

Behavior

With the GCP Functions integration enabled, the Python SDK will:

  • Automatically report all exceptions from your google cloud functions

  • 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 context 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.

You can edit this page on GitHub.