UPGRADING.md

Upgrade guide

Migrating from 2.x to 3.x

A few configuration properties were deprecated in the transition from 2.x to 3.x, but should be relatively easy to upgrade.

Endpoint configuration

Previously, use_ssl was used in combination with get_endpoint() and endpoint to determine the correct URL receive error reports. use_ssl and Configuration.get_endpoint() have been deprecated in favor of including the protocol in the endpoint configuration option.

Replace:

# old way
config = Configuration()
config.use_ssl = True
config.endpoint = 'my.example.com'

With:

config = Configuration()
config.endpoint = 'https://my.example.com'

Using different API keys with log handlers

The api_key constructor argument has been deprecated in favor of using a client to set the correct API key.

Replace:

# old way
handler = BugsnagHandler(api_key='some key')

With:

client = Client(api_key='some key')
handler = client.log_handler()