diff options
Diffstat (limited to 'docs/howto/error-reporting.txt')
| -rw-r--r-- | docs/howto/error-reporting.txt | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/docs/howto/error-reporting.txt b/docs/howto/error-reporting.txt index 17ba14c35c..7670c3cac9 100644 --- a/docs/howto/error-reporting.txt +++ b/docs/howto/error-reporting.txt @@ -4,8 +4,8 @@ How to manage error reporting When you're running a public site you should always turn off the :setting:`DEBUG` setting. That will make your server run much faster, and will -also prevent malicious users from seeing details of your application that can be -revealed by the error pages. +also prevent malicious users from seeing details of your application that can +be revealed by the error pages. However, running with :setting:`DEBUG` set to ``False`` means you'll never see errors generated by your site -- everyone will instead see your public error @@ -87,11 +87,11 @@ regular expression objects. For example:: re.compile(r"^/phpmyadmin/"), ] -In this example, a 404 to any URL ending with ``.php`` or ``.cgi`` will *not* be -reported. Neither will any URL starting with ``/phpmyadmin/``. +In this example, a 404 to any URL ending with ``.php`` or ``.cgi`` will *not* +be reported. Neither will any URL starting with ``/phpmyadmin/``. -The following example shows how to exclude some conventional URLs that browsers and -crawlers often request:: +The following example shows how to exclude some conventional URLs that browsers +and crawlers often request:: import re @@ -220,7 +220,8 @@ filtered out of error reports in a production environment (that is, where disclosed. To systematically hide all POST parameters of a request in error reports, - do not provide any argument to the ``sensitive_post_parameters`` decorator:: + do not provide any argument to the ``sensitive_post_parameters`` + decorator:: @sensitive_post_parameters() def my_view(request): ... @@ -379,5 +380,5 @@ within any given view by setting the ``HttpRequest``’s You can also set up custom error reporting by writing a custom piece of :ref:`exception middleware <exception-middleware>`. If you do write custom - error handling, it's a good idea to emulate Django's built-in error handling - and only report/log errors if :setting:`DEBUG` is ``False``. + error handling, it's a good idea to emulate Django's built-in error + handling and only report/log errors if :setting:`DEBUG` is ``False``. |