Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Noisy exceptions - force logging of all exceptions #2262

Merged
merged 15 commits into from Oct 27, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions sanic/__main__.py
Expand Up @@ -96,6 +96,12 @@ def main():
help="number of worker processes [default 1]\n ",
)
parser.add_argument("-d", "--debug", dest="debug", action="store_true")
parser.add_argument(
"-ne",
prryplatypus marked this conversation as resolved.
Show resolved Hide resolved
"--noisy-exceptions",
dest="noisy_exceptions",
action="store_true",
)
parser.add_argument(
"-r",
"--reload",
Expand Down Expand Up @@ -149,6 +155,7 @@ def main():
f"Module is not a Sanic app, it is a {app_type_name}. "
f"Perhaps you meant {args.module}.app?"
)

if args.cert is not None or args.key is not None:
ssl: Optional[Dict[str, Any]] = {
"cert": args.cert,
Expand All @@ -165,6 +172,7 @@ def main():
"debug": args.debug,
"access_log": args.access_log,
"ssl": ssl,
"noisy_exceptions": args.noisy_exceptions,
}
if args.auto_reload:
kwargs["auto_reload"] = True
Expand Down
10 changes: 9 additions & 1 deletion sanic/app.py
Expand Up @@ -120,6 +120,7 @@ class Sanic(BaseSanic, metaclass=TouchUpMeta):
"name",
"named_request_middleware",
"named_response_middleware",
"noisy_exceptions",
"reload_dirs",
"request_class",
"request_middleware",
Expand Down Expand Up @@ -187,6 +188,7 @@ def __init__(
self.listeners: Dict[str, List[ListenerType]] = defaultdict(list)
self.named_request_middleware: Dict[str, Deque[MiddlewareType]] = {}
self.named_response_middleware: Dict[str, Deque[MiddlewareType]] = {}
self.noisy_exceptions = False
self.reload_dirs: Set[Path] = set()
self.request_class = request_class
self.request_middleware: Deque[MiddlewareType] = deque()
Expand Down Expand Up @@ -890,7 +892,7 @@ async def _websocket_handler(
try:
await fut
except Exception as e:
self.error_handler.log(request, e)
self.error_handler.log(request, e, self.noisy_exceptions)
except (CancelledError, ConnectionClosed):
cancelled = True
finally:
Expand Down Expand Up @@ -954,6 +956,7 @@ def run(
unix: Optional[str] = None,
loop: None = None,
reload_dir: Optional[Union[List[str], str]] = None,
noisy_exceptions: bool = False,
) -> None:
"""
Run the HTTP Server and listen until keyboard interrupt or term
Expand Down Expand Up @@ -1036,6 +1039,7 @@ def run(
backlog=backlog,
register_sys_signals=register_sys_signals,
auto_reload=auto_reload,
noisy_exceptions=noisy_exceptions,
)

try:
Expand Down Expand Up @@ -1082,6 +1086,7 @@ async def create_server(
unix: Optional[str] = None,
return_asyncio_server: bool = False,
asyncio_server_kwargs: Dict[str, Any] = None,
noisy_exceptions: bool = False,
) -> Optional[AsyncioServer]:
"""
Asynchronous version of :func:`run`.
Expand Down Expand Up @@ -1144,6 +1149,7 @@ async def create_server(
protocol=protocol,
backlog=backlog,
run_async=return_asyncio_server,
noisy_exceptions=noisy_exceptions,
)

main_start = server_settings.pop("main_start", None)
Expand Down Expand Up @@ -1256,6 +1262,7 @@ def _helper(
register_sys_signals=True,
run_async=False,
auto_reload=False,
noisy_exceptions=False,
):
"""Helper function used by `run` and `create_server`."""

Expand All @@ -1276,6 +1283,7 @@ def _helper(
)

self.error_handler.debug = debug
self.error_handler.noisy = noisy_exceptions
self.debug = debug

server_settings = {
Expand Down
7 changes: 4 additions & 3 deletions sanic/handlers.py
Expand Up @@ -34,6 +34,7 @@ def __init__(
Tuple[Type[BaseException], Optional[str]], Optional[RouteHandler]
] = {}
self.debug = False
self.noisy = False
self.fallback = fallback
self.base = base

Expand Down Expand Up @@ -180,7 +181,7 @@ def default(self, request, exception):
:class:`Exception`
:return:
"""
self.log(request, exception)
self.log(request, exception, self.noisy)
return exception_response(
request,
exception,
Expand All @@ -190,9 +191,9 @@ def default(self, request, exception):
)

@staticmethod
def log(request, exception):
def log(request, exception, noisy=False):
quiet = getattr(exception, "quiet", False)
if quiet is False:
if quiet is False or noisy is True:
ahopkins marked this conversation as resolved.
Show resolved Hide resolved
try:
url = repr(request.url)
except AttributeError:
Expand Down