60 lines
1.7 KiB
Python
60 lines
1.7 KiB
Python
|
"""
|
||
|
|
Example intercepting uncaught exceptions using Sanic's error handler framework.
|
||
|
|
|
||
|
|
This may be useful for developers wishing to use Sentry, Airbrake, etc.
|
||
|
|
or a custom system to log and monitor unexpected errors in production.
|
||
|
|
|
||
|
|
First we create our own class inheriting from Handler in sanic.exceptions,
|
||
|
|
and pass in an instance of it when we create our Sanic instance. Inside this
|
||
|
|
class' default handler, we can do anything including sending exceptions to
|
||
|
|
an external service.
|
||
|
|
"""
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
"""
|
||
|
|
Imports and code relevant for our CustomHandler class
|
||
|
|
(Ordinarily this would be in a separate file)
|
||
|
|
"""
|
||
|
|
from sanic.response import text
|
||
|
|
from sanic.exceptions import Handler, SanicException
|
||
|
|
|
||
|
|
class CustomHandler(Handler):
|
||
|
|
def default(self, request, exception):
|
||
|
|
# Here, we have access to the exception object
|
||
|
|
# and can do anything with it (log, send to external service, etc)
|
||
|
|
|
||
|
|
# Some exceptions are trivial and built into Sanic (404s, etc)
|
||
|
|
if not issubclass(type(exception), SanicException):
|
||
|
|
print(exception)
|
||
|
|
|
||
|
|
# Then, we must finish handling the exception by
|
||
|
|
# returning our response to the client
|
||
|
|
return text("An error occured", status=500)
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
"""
|
||
|
|
This is an ordinary Sanic server, with the exception that we set the
|
||
|
|
server's error_handler to an instance of our CustomHandler
|
||
|
|
"""
|
||
|
|
|
||
|
|
from sanic import Sanic
|
||
|
|
from sanic.response import json
|
||
|
|
|
||
|
|
app = Sanic(__name__)
|
||
|
|
|
||
|
|
handler = CustomHandler(sanic=app)
|
||
|
|
app.error_handler = handler
|
||
|
|
|
||
|
|
@app.route("/")
|
||
|
|
async def test(request):
|
||
|
|
# Here, something occurs which causes an unexpected exception
|
||
|
|
# This exception will flow to our custom handler.
|
||
|
|
x = 1 / 0
|
||
|
|
return json({"test": True})
|
||
|
|
|
||
|
|
|
||
|
|
app.run(host="0.0.0.0", port=8000)
|