پرش به محتویات

گزارش باگ‌ها به Sentry

یک exception پیش‌بینی‌نشده با یک 500 عمومی جواب داده می‌شود، روی logger drf_parcel با traceback لاگ می‌شود - و به reporter پروژه داده می‌شود:

DRF_PARCEL = {'REPORTER': 'config.reporting.report'}
# config/reporting.py
import sentry_sdk


def report(exc, context):
    sentry_sdk.capture_exception(exc)

context همان context خود DRF است - view و request. reporter با هر 5xx صدا زده می‌شود: یک باگ، و یک 5xx که عمداً raise شده هم - یک ServiceUnavailableError، یک APIException با وضعیت 500 - چون از کار افتادن سرور در هر دو حالت ارزش شنیدن دارد. یک 4xx هرگز گزارش نمی‌شود: یک 404، یک شماره‌ی تلفن اشتباه یا یک DomainError از کار افتادن سرور نیست. reporterی که خراب باشد فقط یک خط لاگ هزینه دارد، نه پاسخ را.

یک 5xx عمدی پیامی را می‌گوید که با آن raise شده، پس آن پیام هرگز نباید متن یک exception باشد: raise ServiceUnavailableError()، نه raise ServiceUnavailableError(str(error)).

یکپارچگی لاگ Sentry - یکی یا دیگری

Django هرگز exception را نمی‌بیند: کتابخانه 500 را جواب داده. ولی کتابخانه آن را در سطح ERROR با traceback لاگ می‌کند، و یکپارچگی لاگ Sentry - که به‌طور پیش‌فرض روشن است - همان خط را به یک event تبدیل می‌کند. از آن استفاده کنید، یا از REPORTER، نه هر دو: با هر دو، هر باگ دو بار گزارش می‌شود. REPORTER برای ابزاری است که لاگ را نمی‌خواند، یا برای وقتی که می‌خواهید جزئیات درخواست را خودتان اضافه کنید.

DEBUG

در DEBUG = True به جای جواب، exception بالا می‌رود تا صفحه‌ی خطای Django traceback را نشان بدهد. برای دیدن قالب در محیط توسعه:

DRF_PARCEL = {'RAISE_UNHANDLED_IN_DEBUG': False}