Όταν έχετε στον αέρα την ιστοσελίδα σας θα πρέπει να έχετε πάντα απενεργοποιημένη την επιλογή DEBUG, ήτοι να είναι False. Αυτό θα κάνει τον server σας πιο γρήγορο και θα αποτρέψει τους κακόβουλους χρήστες να δουν λεπτομέρειες σχετικά με την εφαρμογή σας οι οποίες εμφανίζονται όταν προκύπτουν σφάλματα στη σελίδα.
However, running with DEBUG set to False means you’ll never see\nerrors generated by your site – everyone will instead see your public error\npages. You need to keep track of errors that occur in deployed sites, so Django\ncan be configured to create reports with details about those errors.
When DEBUG is False, Django will email the users listed in the\nADMINS setting whenever your code raises an unhandled exception and\nresults in an internal server error (strictly speaking, for any response with\nan HTTP status code of 500 or greater). This gives the administrators immediate\nnotification of any errors. The ADMINS will get a description of the\nerror, a complete Python traceback, and details about the HTTP request that\ncaused the error.
Από προεπιλογή, το Django θα στείλει email από τη διεύθυνση root@localhost. Ωστόσο, κάποιοι πάροχοι ηλεκτρονικού ταχυδρομείου θα απορρίψουν όλα τα emails από αυτή τη διεύθυνση. Για να χρησιμοποιήσετε μια διαφορετική διεύθυνση αποστολέα, αλλάξτε τη ρύθμιση SERVER_EMAIL.
Για να ενεργοποιήσετε αυτή τη συμπεριφορά, εισάγετε τις διευθύνσεις email των παραληπτών μέσα στη ρύθμιση ADMINS.
Το Django μπορεί, επίσης, να παραμετροποιηθεί για να στέλνει email όταν προκύπτουν σπασμένοι σύνδεσμοι (broken links – σφάλμα 404 «page not found»). Το Django στέλνει emails σχετικά με σφάλματα 404 όταν:
\nΗ ρύθμιση DEBUG είναι False και
Η ρύθμιση MIDDLEWARE περιέχει την django.middleware.common.BrokenLinkEmailsMiddleware.
If those conditions are met, Django will email the users listed in the\nMANAGERS setting whenever your code raises a 404 and the request has\na referer. It doesn’t bother to email for 404s that don’t have a referer –\nthose are usually people typing in broken URLs or broken web bots. It also\nignores 404s when the referer is equal to the requested URL, since this\nbehavior is from broken web bots too.
Μπορείτε να ρυθμίσετε το Django να σταματήσει την αναφορά συγκεκριμένων σφαλμάτων 404 πειράζοντας την ρύθμιση IGNORABLE_404_URLS. Αυτή είναι μια λίστα από regular expression objects. Για παράδειγμα:
import re\n\nIGNORABLE_404_URLS = [\n re.compile(r"\\.(php|cgi)$"),\n re.compile(r"^/phpmyadmin/"),\n]\nΣε αυτό το παράδειγμα, ένα σφάλμα 404 σε οποιοδήποτε URL που τελειώνει με .php ή .cgi δεν θα αναφερθεί. Ούτε, επίσης, οποιοδήποτε URL που ξεκινά με το /phpmyadmin/.
Το ακόλουθο παράδειγμα δείχνει πως να εξαιρέσετε μερικά συμβατικά URLs τα οποία οι browsers και οι crawlers ζητούν συχνά:
\nimport re\n\nIGNORABLE_404_URLS = [\n re.compile(r"^/apple-touch-icon.*\\.png$"),\n re.compile(r"^/favicon\\.ico$"),\n re.compile(r"^/robots\\.txt$"),\n]\n(Σημειώστε ότι αυτά είναι regular expressions, οπότε βάζουμε ένα backslash μπροστά από τους χαρακτήρες της τελείας για να τις κάνουμε escape.)
\nΑν θέλετε να αλλάξετε τη συμπεριφορά της middleware κλάσης django.middleware.common.BrokenLinkEmailsMiddleware (πχ να αγνοήσει τα requests που προέρχονται από τους web crawlers), θα πρέπει να την κάνετε subclass, να παρακάμψετε (override) τις μεθόδους της και να χρησιμοποιήσετε τη δική σας στη ρύθμιση MIDDLEWARE.
Οι αναφορές σφαλμάτων είναι πολύ χρήσιμες για την αποσφαλμάτωση, οπότε είναι γενικά χρήσιμο να καταγράφετε όσο το δυνατόν περισσότερη πληροφορία σχετικά με αυτά τα λάθη γίνεται. Για παράδειγμα, από προεπιλογή, το Django καταγράφει το πλήρες traceback για το exception που έγινε raised, κάθε τοπική μεταβλητή ενός traceback frame’ και τα attributes του HttpRequest.
Ωστόσο, μερικές φορές, μερικοί τύποι πληροφοριών μπορεί να είναι πολύ ευαίσθητοι και επομένως δεν πρέπει να καταγράφονται, για παράδειγμα το password ενός χρήστη ή ο αριθμός της πιστωτικής του κάρτας. Οπότε, εκτός από το φιλτράρισμα των ρυθμίσεων οι οποίες είναι ευαίσθητες, όπως περιγράφεται στο εγχειρίδιο του DEBUG, το Django προσφέρει ένα σετ από decorator συναρτήσεις για να σας βοηθήσει να ελέγξετε ποιες πληροφορίες θα πρέπει να μένουν εκτός σε αναφορές σφαλμάτων σε ένα παραγωγικό περιβάλλον (ήτοι η ρύθμιση DEBUG είναι False): η συνάρτηση sensitive_variables() και η sensitive_post_parameters().
Αν μια συνάρτηση (είτε ένα view είτε κάποιο συνηθισμένο callback) μέσα στον κώδικα σας χρησιμοποιεί τοπικές μεταβλητές ικανές για να κρατήσουν ευαίσθητα δεδομένα, μπορείτε να εμποδίσετε τις τιμές των μεταβλητών αυτών να συμπεριληφθούν στις αναφορές σφαλμάτων, χρησιμοποιώντας τον decorator sensitive_variables:
from django.views.decorators.debug import sensitive_variables\n\n\n@sensitive_variables("user", "pw", "cc")\ndef process_info(user):\n pw = user.pass_word\n cc = user.credit_card_number\n name = user.name\n ...\nIn the above example, the values for the user, pw and cc\nvariables will be hidden and replaced with stars (**********)\nin the error reports, whereas the value of the name variable will be\ndisclosed.
Αν θέλετε να κρύψετε όλες τις τοπικές μεταβλητές μια συνάρτησης από τις αναφορές σφαλμάτων, δεν έχετε παρά να μην δώσετε καμία παράμετρο στον decorator sensitive_variables:
@sensitive_variables()\ndef my_function(): ...\nΑν ένα από τα views σας, λαμβάνει ένα object τύπου HttpRequest το οποίο έχει ικανές να αποθηκεύουν ευαίσθητα δεδομένα παραμέτρους POST, μπορείτε να αποτρέψετε τις τιμές αυτών των παραμέτρων να καταγραφούν στις αναφορές σφαλμάτων χρησιμοποιώντας τον decorator sensitive_post_parameters:
from django.views.decorators.debug import sensitive_post_parameters\n\n\n@sensitive_post_parameters("pass_word", "credit_card_number")\ndef record_user_profile(request):\n UserProfile.create(\n user=request.user,\n password=request.POST["pass_word"],\n credit_card=request.POST["credit_card_number"],\n name=request.POST["name"],\n )\n ...\nIn the above example, the values for the pass_word and\ncredit_card_number POST parameters will be hidden and replaced with\nstars (**********) in the request’s representation inside the\nerror reports, whereas the value of the name parameter will be\ndisclosed.
Για να αποκρύψετε όλες τις POST παραμέτρους ενός request στις αναφορές σφαλμάτων, δεν έχετε παρά να μην περάσετε καμία παράμετρο στον decorator sensitive_post_parameters:
@sensitive_post_parameters()\ndef my_view(request): ...\nΓια συγκεκριμένα django.contrib.auth.views views (login, password_reset_confirm, password_change και add_view, user_change_password για το auth admin), όλες οι POST παράμετροι μένουν εκτός των αναφορών σφαλμάτων για να εμποδίσουν τυχόν διαρροές ευαίσθητων δεδομένων, όπως είναι τα passwords των χρηστών.
All sensitive_variables() and sensitive_post_parameters() do is,\nrespectively, annotate the decorated function with the names of sensitive\nvariables and annotate the HttpRequest object with the names of sensitive\nPOST parameters, so that this sensitive information can later be filtered out\nof reports when an error occurs. The actual filtering is done by Django’s\ndefault error reporter filter:\ndjango.views.debug.SafeExceptionReporterFilter. This filter uses the\ndecorators” annotations to replace the corresponding values with stars\n(**********) when the error reports are produced. If you wish to\noverride or customize this default behavior for your entire site, you need to\ndefine your own filter class and tell Django to use it via the\nDEFAULT_EXCEPTION_REPORTER_FILTER setting:
DEFAULT_EXCEPTION_REPORTER_FILTER = "path.to.your.CustomExceptionReporterFilter"\nΜπορείτε επίσης να ελέγξετε, σε πιο λεπτομερές επίπεδο, ποιο φίλτρο να χρησιμοποιηθεί μέσα σε κάθε view θέτοντας το attribute exception_reporter_filter του HttpRequest:
def my_view(request):\n if request.user.is_authenticated:\n request.exception_reporter_filter = CustomExceptionReporterFilter()\n ...\nYour custom filter class needs to inherit from\ndjango.views.debug.SafeExceptionReporterFilter and may override the\nfollowing attributes and methods:
The string value to replace sensitive value with. By default it\nreplaces the values of sensitive variables with stars\n(**********).
A compiled regular expression object used to match settings and\nrequest.META values considered as sensitive. By default equivalent\nto:
import re\n\nre.compile(r"API|TOKEN|KEY|SECRET|PASS|SIGNATURE|HTTP_COOKIE", flags=re.IGNORECASE)\nReturns True to activate the filtering in\nget_post_parameters() and get_traceback_frame_variables().\nBy default the filter is active if DEBUG is False. Note\nthat sensitive request.META values are always filtered along with\nsensitive setting values, as described in the DEBUG\ndocumentation.
Returns the filtered dictionary of POST parameters. Sensitive values\nare replaced with cleansed_substitute.
Returns the filtered dictionary of local variables for the given\ntraceback frame. Sensitive values are replaced with\ncleansed_substitute.
If you need to customize error reports beyond filtering you may specify a\ncustom error reporter class by defining the\nDEFAULT_EXCEPTION_REPORTER setting:
DEFAULT_EXCEPTION_REPORTER = "path.to.your.CustomExceptionReporter"\nThe exception reporter is responsible for compiling the exception report data,\nand formatting it as text or HTML appropriately. (The exception reporter uses\nDEFAULT_EXCEPTION_REPORTER_FILTER when preparing the exception\nreport data.)
Your custom reporter class needs to inherit from\ndjango.views.debug.ExceptionReporter.
Property that returns a pathlib.Path representing the absolute\nfilesystem path to a template for rendering the HTML representation of\nthe exception. Defaults to the Django provided template.
Property that returns a pathlib.Path representing the absolute\nfilesystem path to a template for rendering the plain-text\nrepresentation of the exception. Defaults to the Django provided\ntemplate.
Return a dictionary containing traceback information.
\nThis is the main extension point for customizing exception reports, for\nexample:
\nfrom django.views.debug import ExceptionReporter\n\n\nclass CustomExceptionReporter(ExceptionReporter):\n def get_traceback_data(self):\n data = super().get_traceback_data()\n # ... remove/add something here ...\n return data\nReturn HTML version of exception report.
\nUsed for HTML version of debug 500 HTTP error page.
\nReturn plain text version of exception report.
\nUsed for plain text version of debug 500 HTTP error page and email\nreports.
\nAs with the filter class, you may control which exception reporter class to use\nwithin any given view by setting the HttpRequest’s\nexception_reporter_class attribute:
def my_view(request):\n if request.user.is_authenticated:\n request.exception_reporter_class = CustomExceptionReporter()\n ...\n