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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
# Copyright 2019-2020 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see <http://www.gnu.org/licenses/>.
import sys
from datetime import datetime
from vyos import debug
from vyos.logger import syslog
from vyos.version import get_full_version_data
def enable(log=True):
if log:
_intercepting_logger()
_intercepting_exceptions()
_noteworthy = []
def noteworthy(msg):
"""
noteworthy can be use to take note things which we may not want to
report to the user may but be worth including in bug report
if something goes wrong later on
"""
_noteworthy.append(msg)
# emulate a file object
class _IO(object):
def __init__(self, std, log):
self.std = std
self.log = log
def write(self, message):
self.std.write(message)
for line in message.split('\n'):
s = line.rstrip()
if s:
self.log(s)
def flush(self):
self.std.flush()
def close(self):
pass
# The function which will be used to report information
# to users when an exception is unhandled
def bug_report(dtype, value, trace):
from traceback import format_exception
sys.stdout.flush()
sys.stderr.flush()
information = get_full_version_data()
trace = '\n'.join(format_exception(dtype, value, trace)).replace('\n\n','\n')
note = ''
if _noteworthy:
note = 'noteworthy:\n'
note += '\n'.join(_noteworthy)
information.update({
'date': datetime.now().strftime('%Y-%m-%d %H:%M:%S'),
'trace': trace,
'instructions': INSTRUCTIONS,
'note': note,
})
sys.stdout.write(INTRO.format(**information))
sys.stdout.flush()
sys.stderr.write(FAULT.format(**information))
sys.stderr.flush()
# define an exception handler to be run when an exception
# reach the end of __main__ and was not intercepted
def _intercepter(dtype, value, trace):
bug_report(dtype, value, trace)
if debug.enabled('developer'):
import pdb
pdb.pm()
def _intercepting_logger(_singleton=[False]):
skip = _singleton.pop()
_singleton.append(True)
if skip:
return
# log to syslog any message sent to stderr
sys.stderr = _IO(sys.stderr, syslog.critical)
# lists as default arguments in function is normally dangerous
# as they will keep any modification performed, unless this is
# what you want to do (in that case to only run the code once)
def _intercepting_exceptions(_singleton=[False]):
skip = _singleton.pop()
_singleton.append(True)
if skip:
return
# install the handler to replace the default behaviour
# which just prints the exception trace on screen
sys.excepthook = _intercepter
# Messages to print
# if the key before the value has not time, syslog takes that as the source of the message
FAULT = """\
Report Time: {date}
Image Version: VyOS {version}
Release Train: {release_train}
Built by: {built_by}
Built on: {built_on}
Build UUID: {build_uuid}
Build Commit ID: {build_git}
Architecture: {system_arch}
Boot via: {boot_via}
System type: {system_type}
Hardware vendor: {hardware_vendor}
Hardware model: {hardware_model}
Hardware S/N: {hardware_serial}
Hardware UUID: {hardware_uuid}
{trace}
{note}
"""
INTRO = """\
VyOS had an issue completing a command.
We are sorry that you encountered a problem while using VyOS.
There are a few things you can do to help us (and yourself):
{instructions}
When reporting problems, please include as much information as possible:
- do not obfuscate any data (feel free to contact us privately if your
business policy requires it)
- and include all the information presented below
"""
INSTRUCTIONS = """\
- Contact us using the online help desk if you have a subscription:
https://support.vyos.io/
- Make sure you are running the latest version of VyOS available at:
https://vyos.net/get/
- Consult the community forum to see how to handle this issue:
https://forum.vyos.io
- Join us on Slack where our users exchange help and advice:
https://vyos.slack.com
""".strip()
|
