Bottle

The Bottle integration adds support for the Bottle web framework. Currently it works well with the stable version of Bottle (0.12). However the integration with the development version (0.13) doesn't work properly.

Install

Install sentry-sdk from PyPI with the bottle extra:

pip install --upgrade 'sentry-sdk[bottle]'

Configure

If you have the bottle package in your dependencies, the Bottle integration will be enabled automatically when you initialize the Sentry SDK.

import sentry_sdk

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,
)

Verify

from bottle import Bottle, run

sentry_sdk.init(...)  # same as above

app = Bottle()

@app.route('/')
def hello():
    1 / 0
    return "Hello World!"

run(app, host='localhost', port=8000)

When you point your browser to http://localhost:8000/ a transaction in the Performance section of sentry.io will be created. Additionally, an error event will be sent to sentry.io and will be connected to the transaction.

It takes a couple of moments for the data to appear in sentry.io.

Behavior

• The Sentry Python SDK will install the Bottle integration for all of your apps. The integration hooks into base Bottle class.

• All exceptions leading to an Internal Server Error are reported.

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

Options

If you add BottleIntegration explicitly to your sentry_sdk.init() call you can set options for BottleIntegration to change its behavior:

import sentry_sdk
from sentry_sdk.integrations.bottle import BottleIntegration

sentry_sdk.init(
    # same as above
    integrations=[
        BottleIntegration(
            transaction_style="endpoint",
        ),
    ],
)

You can pass the following keyword arguments to BottleIntegration():

• transaction_style:

  Python

  Copied

  @app.route("/myurl/<foo>")
  def myendpoint():
      return "ok"
  

  In the above code, you would set the transaction to:

  • /myurl/<foo> if you set transaction_style="url".
  • myendpoint if you set transaction_style="endpoint"

  The default is "endpoint".

Supported Versions

• Bottle: 0.12.13+
• Python: 3.6+