paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-05 06:23:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

error_notify: Add some idea of the deployed code version.

Browse Source 
Tested in dev with the help of our handy /emails/ display.
This commit is contained in:
Greg Price
2017-08-25 16:21:04 -07:00
committed by Tim Abbott
parent 4b5c52fc99
commit 41ecdd8d83
1 changed files with 16 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
zerver/lib/error_notify.py
View File

@@ -1,6 +1,7 @@
# System documented in https://zulip.readthedocs.io/en/latest/subsystems/logging.html # System documented in https://zulip.readthedocs.io/en/latest/subsystems/logging.html
import logging import logging
import os
from collections import defaultdict from collections import defaultdict
from django.conf import settings from django.conf import settings
@@ -12,6 +13,7 @@ from typing import Any, Dict, Text
from zerver.models import get_system_bot from zerver.models import get_system_bot
from zerver.lib.actions import internal_send_message from zerver.lib.actions import internal_send_message
from zerver.lib.response import json_success, json_error from zerver.lib.response import json_success, json_error
from version import ZULIP_VERSION
def format_subject(subject): def format_subject(subject):
# type: (str) -> str # type: (str) -> str
@@ -30,6 +32,14 @@ def user_info_str(report):
user_info += " on %s deployment" % (report['deployment'],) user_info += " on %s deployment" % (report['deployment'],)
return user_info return user_info
def deployment_repr() -> str:
deployment = 'Deployed code:\n'
deployment += '- ZULIP_VERSION: %s\n' % (ZULIP_VERSION,)
version_path = os.path.join(os.path.dirname(__file__), '../../version')
if os.path.exists(version_path):
deployment += '- version: %s\n' % (open(version_path).read().strip(),)
return deployment
def notify_browser_error(report): def notify_browser_error(report):
# type: (Dict[str, Any]) -> None # type: (Dict[str, Any]) -> None
report = defaultdict(lambda: None, report) report = defaultdict(lambda: None, report)
@@ -87,6 +97,7 @@ def zulip_server_error(report):
stack_trace = report['stack_trace'] or "No stack trace available" stack_trace = report['stack_trace'] or "No stack trace available"
user_info = user_info_str(report) user_info = user_info_str(report)
deployment = deployment_repr()
request_repr = ( request_repr = (
"Request info:\n~~~~\n" "Request info:\n~~~~\n"
@@ -100,14 +111,15 @@ def zulip_server_error(report):
realm = get_system_bot(settings.ERROR_BOT).realm realm = get_system_bot(settings.ERROR_BOT).realm
internal_send_message(realm, settings.ERROR_BOT, internal_send_message(realm, settings.ERROR_BOT,
"stream", "errors", format_subject(subject), "stream", "errors", format_subject(subject),
"Error generated by %s\n\n~~~~ pytb\n%s\n\n~~~~\n%s" % ( "Error generated by %s\n\n~~~~ pytb\n%s\n\n~~~~\n%s\n%s"
user_info, stack_trace, request_repr)) % (user_info, stack_trace, deployment, request_repr))
def email_server_error(report): def email_server_error(report):
# type: (Dict[str, Any]) -> None # type: (Dict[str, Any]) -> None
subject = '%(node)s: %(message)s' % (report) subject = '%(node)s: %(message)s' % (report)
user_info = user_info_str(report) user_info = user_info_str(report)
deployment = deployment_repr()
request_repr = ( request_repr = (
"Request info:\n" "Request info:\n"
@@ -117,8 +129,8 @@ def email_server_error(report):
for field in ["REMOTE_ADDR", "QUERY_STRING", "SERVER_NAME"]: for field in ["REMOTE_ADDR", "QUERY_STRING", "SERVER_NAME"]:
request_repr += "- %s: \"%s\"\n" % (field, report.get(field.lower())) request_repr += "- %s: \"%s\"\n" % (field, report.get(field.lower()))
message = "Error generated by %s\n\n%s\n\n%s" % (user_info, report['stack_trace'], message = ("Error generated by %s\n\n%s\n\n%s\n\n%s"
request_repr) % (user_info, report['stack_trace'], deployment, request_repr))
mail_admins(format_subject(subject), message, fail_silently=True) mail_admins(format_subject(subject), message, fail_silently=True)