-
-
Notifications
You must be signed in to change notification settings - Fork 955
/
errors.py
115 lines (94 loc) · 3.83 KB
/
errors.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
#
# Copyright © 2012–2022 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
#
import logging
import sys
from json import JSONDecodeError
import sentry_sdk
from django.conf import settings
from django.utils.translation import get_language
from sentry_sdk.integrations.celery import CeleryIntegration
from sentry_sdk.integrations.django import DjangoIntegration
from sentry_sdk.integrations.logging import ignore_logger
from sentry_sdk.integrations.redis import RedisIntegration
import weblate.utils.version
ERROR_LOGGER = "weblate.errors"
LOGGER = logging.getLogger(ERROR_LOGGER)
try:
import rollbar
HAS_ROLLBAR = True
except ImportError:
HAS_ROLLBAR = False
def report_error(
level: str = "warning",
cause: str = "Handled exception",
skip_sentry: bool = False,
print_tb: bool = False,
extra_log: str = None,
):
"""Wrapper for error reporting.
This can be used for store exceptions in error reporting solutions as rollbar while
handling error gracefully and giving user cleaner message.
"""
if HAS_ROLLBAR and hasattr(settings, "ROLLBAR"):
rollbar.report_exc_info(level=level)
if not skip_sentry and settings.SENTRY_DSN:
with sentry_sdk.push_scope() as scope:
scope.set_tag("cause", cause)
scope.set_tag("user.locale", get_language())
scope.level = level
sentry_sdk.capture_exception()
log = getattr(LOGGER, level)
error = sys.exc_info()[1]
# Include JSON document if available. It might be missing
# when the error is raised from requests.
if isinstance(error, JSONDecodeError) and not extra_log and hasattr(error, "doc"):
extra_log = repr(error.doc)
log("%s: %s: %s", cause, error.__class__.__name__, error)
if extra_log:
log("%s: %s: %s", cause, error.__class__.__name__, extra_log)
if print_tb:
LOGGER.exception(cause)
def add_breadcrumb(category: str, message: str, level: str = "info", **data):
# Add breadcrumb only if settings are already loaded,
# we do not want to force loading settings early
if not settings.configured or not getattr(settings, "SENTRY_DSN", None):
return
sentry_sdk.add_breadcrumb(
category=category, message=message, level=level, data=data
)
def celery_base_data_hook(request, data):
data["framework"] = "celery"
def init_error_collection(celery=False):
if settings.SENTRY_DSN:
sentry_sdk.init(
dsn=settings.SENTRY_DSN,
integrations=[CeleryIntegration(), DjangoIntegration(), RedisIntegration()],
send_default_pii=True,
release=weblate.utils.version.GIT_REVISION
or weblate.utils.version.TAG_NAME,
environment=settings.SENTRY_ENVIRONMENT,
traces_sample_rate=settings.SENTRY_TRACES_SAMPLE_RATE,
**settings.SENTRY_EXTRA_ARGS,
)
# Ignore Weblate logging, those are reported using capture_exception
ignore_logger(ERROR_LOGGER)
if celery and HAS_ROLLBAR and hasattr(settings, "ROLLBAR"):
rollbar.init(**settings.ROLLBAR)
rollbar.BASE_DATA_HOOK = celery_base_data_hook
LOGGER.info("configured Rollbar error collection")