« back to all changes in this revision
Viewing changes to bzrlib/trace.py
- browse files at revision 1092.1.18
- compare with another revision
- compare with revision 1092.1.18
- download diff
- download tarball
- view history from revision 1092.1.18
- Committer: Robert Collins
- Date: 2005-08-24 06:53:07 UTC
- mto: (974.1.50) (1185.1.10) (1092.3.1)
- mto: This revision was merged to the branch mainline in revision 1139.
- Revision ID: robertc@robertcollins.net-20050824065307-bca8ae89734a53f8
merge from mpool
- files added:
- bzrlib/fetch.py
- files modified:
- HACKING
added
removed
bzrlib/trace.py
13
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
14
14
15
15
16
17
# TODO: Could probably replace this with something based on Python logging
18
# module.
19
20
21
22
23
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
24
__author__ = "Martin Pool <mbp@canonical.com>"
25
26
27
16
"""Messages and logging for bazaar-ng
28
17
29
Nothing is actually logged unless you call bzrlib.open_tracefile().
18
Messages are sent out through the Python logging library.
19
20
They can be sent to two places: to stderr, and to ~/.bzr.log.
21
22
~/.bzr.log gets all messages, and tracebacks of all uncaught
23
exceptions.
24
25
Normally stderr only gets messages of level INFO and higher, and gets
26
only a summary of exceptions, not the traceback.
30
27
"""
31
28
32
29
33
import sys, os
34
35
######################################################################
36
# messages and logging
37
38
global _tracefile, _starttime
39
_tracefile = None
40
41
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
42
_starttime = None
43
44
# If false, notes also go to stdout; should replace this with --silent
45
# at some point.
46
silent = False
47
48
49
# fix this if we ever fork within python
50
_mypid = os.getpid()
51
_logprefix = '[%d] ' % _mypid
52
53
54
def _write_trace(msg):
55
if 0:
56
if _tracefile:
57
_tracefile.write(_logprefix + msg + '\n')
58
59
60
def warning(msg):
61
sys.stderr.write('bzr: warning: ' + msg + '\n')
62
_write_trace('warning: ' + msg)
63
64
65
mutter = _write_trace
66
67
68
def note(msg):
69
b = '* ' + str(msg) + '\n'
70
if not silent:
71
sys.stderr.write(b)
72
_write_trace('note: ' + msg)
73
74
75
def log_error(msg):
76
sys.stderr.write(msg + '\n')
77
_write_trace(msg)
78
30
# TODO: in debug mode, stderr should get full tracebacks and also
31
# debug messages. (Is this really needed?)
32
33
# TODO: When running the test suites, we should add an additional
34
# logger that sends messages into the test log file.
35
36
37
import sys
38
import os
39
import logging
40
import traceback
41
42
43
_file_handler = None
44
45
46
class QuietFormatter(logging.Formatter):
47
"""Formatter that supresses the details of errors.
48
49
This is used by default on stderr so as not to scare the user.
50
"""
51
# At first I tried overriding formatException to suppress the
52
# exception details, but that has global effect: no loggers
53
# can get the exception details is we suppress them here.
54
55
def format(self, record):
56
s = 'bzr: '
57
if record.levelno >= logging.WARNING:
58
s += record.levelname + ': '
59
60
s += record.getMessage()
61
62
if record.exc_info:
63
# give just a summary of the exception, not the whole thing
64
exinfo = traceback.extract_tb(record.exc_info[2])
65
# the format of this string matches one of the REs
66
s += '\n'
67
s += (' at %s line %d, in %s()\n' % exinfo[-1][:3])
68
s += ' see ~/.bzr.log for debug information'
69
70
return s
71
72
################
73
# configure default handler to stderr
74
75
_stderr_handler = logging.StreamHandler()
76
_stderr_handler.setFormatter(QuietFormatter())
77
78
if os.environ.get('BZR_DEBUG'):
79
_stderr_handler.setLevel(logging.DEBUG)
80
else:
81
_stderr_handler.setLevel(logging.INFO)
82
83
logging.getLogger('').addHandler(_stderr_handler)
84
85
86
87
################
88
# configure convenient aliases for output routines
89
90
_bzr_logger = logging.getLogger('bzr')
91
_bzr_logger.setLevel(logging.DEBUG)
92
93
note = _bzr_logger.info
94
warning = _bzr_logger.warning
95
log_error = _bzr_logger.error
96
error = _bzr_logger.error
97
mutter = _bzr_logger.debug
98
debug = _bzr_logger.debug
99
100
101
102
103
# we do the rollover using this code, rather than the default from python
104
# logging, because we only want to rollover at program startup, not on each
105
# message. maybe that's not a good enough reason.
79
106
80
107
def _rollover_trace_maybe(trace_fname):
81
108
import stat
105
132
# Messages are always written to here, so that we have some
106
133
# information if something goes wrong. In a future version this
107
134
# file will be removed on successful completion.
108
global _starttime, _tracefile
135
global _file_handler
109
136
import stat, codecs
110
137
111
_starttime = os.times()[4]
112
113
138
trace_fname = os.path.join(os.path.expanduser(tracefilename))
114
139
_rollover_trace_maybe(trace_fname)
115
140
116
141
# buffering=1 means line buffered
117
142
try:
118
_tracefile = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
119
t = _tracefile
143
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
120
144
121
if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
122
t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
123
t.write("you can delete or truncate this file, or include sections in\n")
124
t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
145
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
146
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
147
tf.write("you can delete or truncate this file, or include sections in\n")
148
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
149
150
_file_handler = logging.StreamHandler(tf)
151
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
152
datefmt = r'%a %H:%M:%S'
153
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
154
_file_handler.setLevel(logging.DEBUG)
155
logging.getLogger('').addHandler(_file_handler)
125
156
126
157
import bzrlib
127
_write_trace('bzr %s invoked on python %s (%s)'
128
% (bzrlib.__version__,
129
'.'.join(map(str, sys.version_info)),
130
sys.platform))
158
159
debug('bzr %s invoked on python %s (%s)'
160
% (bzrlib.__version__,
161
'.'.join(map(str, sys.version_info)),
162
sys.platform))
131
163
132
_write_trace(' arguments: %r' % argv)
133
_write_trace(' working dir: ' + os.getcwdu())
164
debug(' arguments: %r' % argv)
165
debug(' working dir: ' + os.getcwdu())
134
166
except IOError, e:
135
167
warning("failed to open trace file: %s" % (e))
136
168
137
def close_trace():
138
times = os.times()
139
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
140
% (times[:4] + ((times[4] - _starttime),)))
141
142
143
144
def log_exception():
145
"""Log the last exception into the trace file."""
146
import cgitb
147
s = cgitb.text(sys.exc_info())
148
for l in s.split('\n'):
149
_write_trace(l)
169
170
171
def log_exception(msg=None):
172
"""Log the last exception into the trace file.
173
174
The exception string representation is used as the error
175
summary, unless msg is given.
176
"""
177
if msg == None:
178
ei = sys.exc_info()
179
s = str(ei[1])
180
if s[-1] == '\n':
181
s = s[:-1]
182
msg = s
150
183
151
184
_bzr_logger.exception(msg)
Loggerhead is a web-based interface for Breezy
Version: 2.0.1