Error Reporting

Sentry

Enabling Error Reporting

NetBox supports native integration with Sentry for automatic error reporting. To enable this functionality, set SENTRY_ENABLED to True and define your unique data source name (DSN) in configuration.py.

SENTRY_ENABLED = True
SENTRY_DSN = "https://examplePublicKey@o0.ingest.sentry.io/0"

Setting SENTRY_ENABLED to False will disable the Sentry integration.

Assigning Tags

You can optionally attach one or more arbitrary tags to the outgoing error reports if desired by setting the SENTRY_TAGS parameter:

SENTRY_TAGS = {
    "custom.foo": "123",
    "custom.bar": "abc",
}

Reserved tag prefixes

Avoid using any tag names which begin with netbox., as this prefix is reserved by the NetBox application.

Testing

Once the configuration has been saved, restart the NetBox service.

To test Sentry operation, try generating a 404 (page not found) error by navigating to an invalid URL, such as https://netbox/404-error-testing. (Be sure that debug mode has been disabled.) After receiving a 404 response from the NetBox server, you should see the issue appear shortly in Sentry.