mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 05:53:43 +00:00
error_notify: Remove custom email error reporting handler.
Restore the default django.utils.log.AdminEmailHandler when
ERROR_REPORTING is enabled. Those with more sophisticated needs can
turn it off and use Sentry or a Sentry-compatible system.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
(cherry picked from commit b285813beb)
This commit is contained in:
Anders Kaseorg
committed by
Tim Abbott
Tim Abbott
parent
290b54a82d
commit
a8675741a0
@@ -1,21 +1,7 @@
|
||||
# System documented in https://zulip.readthedocs.io/en/latest/subsystems/logging.html
|
||||
import logging
|
||||
import os
|
||||
import platform
|
||||
import subprocess
|
||||
import traceback
|
||||
from typing import Any, Dict, Optional, Protocol, runtime_checkable
|
||||
from urllib.parse import SplitResult
|
||||
|
||||
from django.conf import settings
|
||||
from django.http import HttpRequest
|
||||
from django.utils.translation import override as override_language
|
||||
from django.views.debug import get_exception_reporter_filter
|
||||
from sentry_sdk import capture_exception
|
||||
|
||||
from version import ZULIP_VERSION
|
||||
from zerver.lib.logging_util import find_log_caller_module
|
||||
from zerver.lib.queue import queue_json_publish
|
||||
from typing import Optional
|
||||
|
||||
|
||||
def try_git_describe() -> Optional[str]:
|
||||
@@ -28,139 +14,3 @@ def try_git_describe() -> Optional[str]:
|
||||
).strip()
|
||||
except (FileNotFoundError, subprocess.CalledProcessError): # nocoverage
|
||||
return None
|
||||
|
||||
|
||||
def add_request_metadata(report: Dict[str, Any], request: HttpRequest) -> None:
|
||||
report["has_request"] = True
|
||||
|
||||
report["path"] = request.path
|
||||
report["method"] = request.method
|
||||
report["remote_addr"] = request.META.get("REMOTE_ADDR", None)
|
||||
report["query_string"] = request.META.get("QUERY_STRING", None)
|
||||
report["server_name"] = request.META.get("SERVER_NAME", None)
|
||||
try:
|
||||
from django.contrib.auth.models import AnonymousUser
|
||||
|
||||
user_profile = request.user
|
||||
if isinstance(user_profile, AnonymousUser):
|
||||
user_full_name = None
|
||||
user_email = None
|
||||
user_role = None
|
||||
else:
|
||||
user_full_name = user_profile.full_name
|
||||
user_email = user_profile.email
|
||||
with override_language(settings.LANGUAGE_CODE):
|
||||
# str() to force the lazy-translation to apply now,
|
||||
# since it won't serialize into the worker queue.
|
||||
user_role = str(user_profile.get_role_name())
|
||||
except Exception:
|
||||
# Unexpected exceptions here should be handled gracefully
|
||||
traceback.print_exc()
|
||||
user_full_name = None
|
||||
user_email = None
|
||||
user_role = None
|
||||
|
||||
report["user"] = {
|
||||
"user_email": user_email,
|
||||
"user_full_name": user_full_name,
|
||||
"user_role": user_role,
|
||||
}
|
||||
|
||||
exception_filter = get_exception_reporter_filter(request)
|
||||
try:
|
||||
report["data"] = (
|
||||
exception_filter.get_post_parameters(request)
|
||||
if request.method == "POST"
|
||||
else request.GET
|
||||
)
|
||||
except Exception:
|
||||
# exception_filter.get_post_parameters will throw
|
||||
# RequestDataTooBig if there's a really big file uploaded
|
||||
report["data"] = {}
|
||||
|
||||
try:
|
||||
report["host"] = SplitResult("", request.get_host(), "", "", "").hostname
|
||||
except Exception:
|
||||
# request.get_host() will throw a DisallowedHost
|
||||
# exception if the host is invalid
|
||||
report["host"] = platform.node()
|
||||
|
||||
|
||||
@runtime_checkable
|
||||
class HasRequest(Protocol):
|
||||
request: HttpRequest
|
||||
|
||||
|
||||
class AdminNotifyHandler(logging.Handler):
|
||||
"""An logging handler that sends the log/exception to the queue to be
|
||||
turned into an email and/or a Zulip message for the server admins.
|
||||
"""
|
||||
|
||||
# adapted in part from django/utils/log.py
|
||||
|
||||
def __init__(self) -> None:
|
||||
logging.Handler.__init__(self)
|
||||
|
||||
def emit(self, record: logging.LogRecord) -> None:
|
||||
report: Dict[str, Any] = {}
|
||||
|
||||
try:
|
||||
report["node"] = platform.node()
|
||||
report["host"] = platform.node()
|
||||
|
||||
report["deployment_data"] = dict(
|
||||
git=try_git_describe(),
|
||||
ZULIP_VERSION=ZULIP_VERSION,
|
||||
)
|
||||
|
||||
if record.exc_info:
|
||||
stack_trace = "".join(traceback.format_exception(*record.exc_info))
|
||||
message = str(record.exc_info[1])
|
||||
else:
|
||||
stack_trace = "No stack trace available"
|
||||
message = record.getMessage()
|
||||
if "\n" in message:
|
||||
# Some exception code paths in queue processors
|
||||
# seem to result in super-long messages
|
||||
stack_trace = message
|
||||
message = message.split("\n")[0]
|
||||
report["stack_trace"] = stack_trace
|
||||
report["message"] = message
|
||||
|
||||
report["logger_name"] = record.name
|
||||
report["log_module"] = find_log_caller_module(record)
|
||||
report["log_lineno"] = record.lineno
|
||||
|
||||
if isinstance(record, HasRequest):
|
||||
add_request_metadata(report, record.request)
|
||||
|
||||
except Exception:
|
||||
report["message"] = "Exception in preparing exception report!"
|
||||
logging.warning(report["message"], exc_info=True)
|
||||
report["stack_trace"] = "See /var/log/zulip/errors.log"
|
||||
capture_exception()
|
||||
|
||||
if settings.DEBUG_ERROR_REPORTING: # nocoverage
|
||||
logging.warning("Reporting an error to admins...")
|
||||
logging.warning(
|
||||
"Reporting an error to admins: %s %s %s %s %s",
|
||||
record.levelname,
|
||||
report["logger_name"],
|
||||
report["log_module"],
|
||||
report["message"],
|
||||
report["stack_trace"],
|
||||
)
|
||||
|
||||
try:
|
||||
queue_json_publish(
|
||||
"error_reports",
|
||||
dict(
|
||||
type="server",
|
||||
report=report,
|
||||
),
|
||||
)
|
||||
except Exception:
|
||||
# If this breaks, complain loudly but don't pass the traceback up the stream
|
||||
# However, we *don't* want to use logging.exception since that could trigger a loop.
|
||||
logging.warning("Reporting an exception triggered an exception!", exc_info=True)
|
||||
capture_exception()
|
||||
|
||||
Reference in New Issue
Block a user