← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

sync with bzr.dev mainline

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# This program is free software; you can redistribute it and/or modify
2
 
# it under the terms of the GNU General Public License as published by
3
 
# the Free Software Foundation; either version 2 of the License, or
4
 
# (at your option) any later version.
5
 
 
6
 
# This program is distributed in the hope that it will be useful,
7
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
9
 
# GNU General Public License for more details.
10
 
 
11
 
# You should have received a copy of the GNU General Public License
12
 
# along with this program; if not, write to the Free Software
13
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
14
 
 
15
 
 
16
 
"""Messages and logging for bazaar-ng
17
 
 
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.
 
1
# Copyright (C) 2005, Canonical Ltd
 
2
 
 
3
"""Messages and logging for bazaar-ng.
 
4
 
 
5
Messages are supplied by callers as a string-formatting template, plus values
 
6
to be inserted into it.  The actual %-formatting is deferred to the log
 
7
library so that it doesn't need to be done for messages that won't be emitted.
 
8
 
 
9
Messages are classified by severity levels: critical, error, warning, info,
 
10
and debug.
 
11
 
 
12
They can be sent to two places: to stderr, and to ~/.bzr.log.  For purposes
 
13
such as running the test suite, they can also be redirected away from both of
 
14
those two places to another location.
 
15
 
 
16
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
 
17
This trace file is always in UTF-8, regardless of the user's default encoding,
 
18
so that we can always rely on writing any message.
 
19
 
 
20
Output to stderr depends on the mode chosen by the user.  By default, messages
 
21
of info and above are sent out, which results in progress messages such as the
 
22
list of files processed by add and commit.  In quiet mode, only warnings and
 
23
above are shown.  In debug mode, stderr gets debug messages too.
 
24
 
 
25
Errors that terminate an operation are generally passed back as exceptions;
 
26
others may be just emitted as messages.
 
27
 
 
28
Exceptions are reported in a brief form to stderr so as not to look scary.
 
29
BzrErrors are required to be able to format themselves into a properly
 
30
explanatory message.  This is not true for builtin excexceptions such as
 
31
KeyError, which typically just str to "0".  They're printed in a different
 
32
form.
27
33
"""
28
34
 
29
 
 
30
35
# TODO: in debug mode, stderr should get full tracebacks and also
31
36
# debug messages.  (Is this really needed?)
32
37
 
33
 
# TODO: When running the test suites, we should add an additional
34
 
# logger that sends messages into the test log file.
 
38
# FIXME: Unfortunately it turns out that python's logging module
 
39
# is quite expensive, even when the message is not printed by any handlers.
 
40
# We should perhaps change back to just simply doing it here.
35
41
 
36
42
 
37
43
import sys
38
44
import os
39
45
import logging
40
 
import traceback
 
46
 
 
47
import bzrlib
 
48
from bzrlib.errors import BzrError, BzrNewError
41
49
 
42
50
 
43
51
_file_handler = None
44
52
_stderr_handler = None
 
53
_stderr_quiet = False
 
54
_trace_file = None
 
55
_bzr_log_file = None
45
56
 
46
57
 
47
58
class QuietFormatter(logging.Formatter):
58
69
            s = 'bzr: ' + record.levelname + ': '
59
70
        else:
60
71
            s = ''
61
 
            
62
72
        s += record.getMessage()
63
 
 
64
 
        ##import textwrap
65
 
        ##s = textwrap.fill(s)
66
 
            
67
73
        if record.exc_info:
68
 
            # give just a summary of the exception, not the whole thing
69
 
            exinfo = traceback.extract_tb(record.exc_info[2])
70
 
            # the format of this string matches one of the REs
71
 
            s += '\n'
72
 
            s += ('  at %s line %d, in %s()\n' % exinfo[-1][:3])
73
 
            s += '  see ~/.bzr.log for debug information'
74
 
 
 
74
            s += '\n' + format_exception_short(record.exc_info)
75
75
        return s
76
76
        
77
 
 
78
 
 
79
 
 
80
 
################
81
77
# configure convenient aliases for output routines
82
78
 
83
79
_bzr_logger = logging.getLogger('bzr')
84
 
_bzr_logger.setLevel(logging.DEBUG) 
85
80
 
86
81
info = note = _bzr_logger.info
87
82
warning =   _bzr_logger.warning
88
83
log_error = _bzr_logger.error
89
84
error =     _bzr_logger.error
90
 
mutter =    _bzr_logger.debug
91
 
debug =     _bzr_logger.debug
92
 
 
93
 
 
94
 
 
95
 
 
96
 
# we do the rollover using this code, rather than the default from python
97
 
# logging, because we only want to rollover at program startup, not on each
98
 
# message.  maybe that's not a good enough reason.
 
85
 
 
86
 
 
87
def mutter(fmt, *args):
 
88
    if _trace_file is None:
 
89
        return
 
90
    if hasattr(_trace_file, 'closed') and _trace_file.closed:
 
91
        return
 
92
    if len(args) > 0:
 
93
        out = fmt % args
 
94
    else:
 
95
        out = fmt
 
96
    out += '\n'
 
97
    _trace_file.write(out)
 
98
debug = mutter
 
99
 
99
100
 
100
101
def _rollover_trace_maybe(trace_fname):
101
102
    import stat
104
105
        if size <= 4 << 20:
105
106
            return
106
107
        old_fname = trace_fname + '.old'
107
 
 
108
108
        from osutils import rename
109
109
        rename(trace_fname, old_fname)
110
 
 
111
110
    except OSError:
112
111
        return
113
112
 
114
113
 
115
 
 
116
114
def open_tracefile(tracefilename='~/.bzr.log'):
117
115
    # Messages are always written to here, so that we have some
118
116
    # information if something goes wrong.  In a future version this
119
117
    # file will be removed on successful completion.
120
 
    global _file_handler
 
118
    global _file_handler, _bzr_log_file
121
119
    import stat, codecs
122
120
 
123
121
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
124
122
    _rollover_trace_maybe(trace_fname)
125
 
 
126
 
    # buffering=1 means line buffered
127
123
    try:
128
 
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
129
 
 
130
 
        if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
 
124
        LINE_BUFFERED = 1
 
125
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
126
        _bzr_log_file = tf
 
127
        if tf.tell() == 0:
131
128
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
132
129
            tf.write("you can delete or truncate this file, or include sections in\n")
133
130
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
134
 
        
135
131
        _file_handler = logging.StreamHandler(tf)
136
132
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
137
133
        datefmt = r'%a %H:%M:%S'
138
134
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
139
135
        _file_handler.setLevel(logging.DEBUG)
140
136
        logging.getLogger('').addHandler(_file_handler)
141
 
 
142
137
    except IOError, e:
143
138
        warning("failed to open trace file: %s" % (e))
144
139
 
145
140
 
146
141
def log_startup(argv):
147
 
    import bzrlib
148
 
 
149
 
    debug('bzr %s invoked on python %s (%s)',
 
142
    debug('\n\nbzr %s invoked on python %s (%s)',
150
143
          bzrlib.__version__,
151
144
          '.'.join(map(str, sys.version_info)),
152
145
          sys.platform)
153
 
 
154
146
    debug('  arguments: %r', argv)
155
 
    debug('  working dir: %s', os.getcwdu())
 
147
    debug('  working dir: %r', os.getcwdu())
156
148
 
157
149
 
158
150
def log_exception(msg=None):
159
 
    """Log the last exception into the trace file.
 
151
    """Log the last exception to stderr and the trace file.
160
152
 
161
153
    The exception string representation is used as the error
162
154
    summary, unless msg is given.
163
155
    """
164
 
    command = ' '.join(repr(arg) for arg in sys.argv)
165
 
    prefix = "command: %s\npwd: %s\n" % (command, os.getcwd())
166
 
    if msg == None:
167
 
        ei = sys.exc_info()
168
 
        msg = str(ei[1])
169
 
    if msg and (msg[-1] == '\n'):
170
 
        msg = msg[:-1]
171
 
    ## msg = "(%s) %s" % (str(type(ei[1])), msg)
172
 
    _bzr_logger.exception(prefix + msg)
173
 
 
 
156
    if msg:
 
157
        error(msg)
 
158
    else:
 
159
        exc_str = format_exception_short(sys.exc_info())
 
160
        error(exc_str)
 
161
    log_exception_quietly()
 
162
 
 
163
 
 
164
def log_exception_quietly():
 
165
    """Log the last exception to the trace file only.
 
166
 
 
167
    Used for exceptions that occur internally and that may be 
 
168
    interesting to developers but not to users.  For example, 
 
169
    errors loading plugins.
 
170
    """
 
171
    import traceback
 
172
    debug(traceback.format_exc())
174
173
 
175
174
 
176
175
def enable_default_logging():
177
176
    """Configure default logging to stderr and .bzr.log"""
178
 
    global _stderr_handler, _file_handler
179
 
 
 
177
    # FIXME: if this is run twice, things get confused
 
178
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
180
179
    _stderr_handler = logging.StreamHandler()
181
180
    _stderr_handler.setFormatter(QuietFormatter())
182
 
 
 
181
    logging.getLogger('').addHandler(_stderr_handler)
 
182
    _stderr_handler.setLevel(logging.INFO)
183
183
    if not _file_handler:
184
184
        open_tracefile()
185
 
 
186
 
    if os.environ.get('BZR_DEBUG'):
187
 
        level = logging.DEBUG
 
185
    _trace_file = _bzr_log_file
 
186
    if _file_handler:
 
187
        _file_handler.setLevel(logging.DEBUG)
 
188
    _bzr_logger.setLevel(logging.DEBUG) 
 
189
 
 
190
 
 
191
 
 
192
def be_quiet(quiet=True):
 
193
    global _stderr_handler, _stderr_quiet
 
194
    
 
195
    _stderr_quiet = quiet
 
196
    if quiet:
 
197
        _stderr_handler.setLevel(logging.WARNING)
188
198
    else:
189
 
        level = logging.INFO
190
 
 
191
 
    _stderr_handler.setLevel(logging.INFO)
192
 
    _file_handler.setLevel(level)
193
 
 
194
 
    logging.getLogger('').addHandler(_stderr_handler)
 
199
        _stderr_handler.setLevel(logging.INFO)
 
200
 
 
201
 
 
202
def is_quiet():
 
203
    global _stderr_quiet
 
204
    return _stderr_quiet
195
205
 
196
206
 
197
207
def disable_default_logging():
205
215
    l.removeHandler(_stderr_handler)
206
216
    if _file_handler:
207
217
        l.removeHandler(_file_handler)
 
218
    _trace_file = None
 
219
 
 
220
 
 
221
def enable_test_log(to_file):
 
222
    """Redirect logging to a temporary file for a test"""
 
223
    disable_default_logging()
 
224
    global _test_log_hdlr, _trace_file
 
225
    hdlr = logging.StreamHandler(to_file)
 
226
    hdlr.setLevel(logging.DEBUG)
 
227
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
 
228
    _bzr_logger.addHandler(hdlr)
 
229
    _bzr_logger.setLevel(logging.DEBUG)
 
230
    _test_log_hdlr = hdlr
 
231
    _trace_file = to_file
 
232
 
 
233
 
 
234
def disable_test_log():
 
235
    _bzr_logger.removeHandler(_test_log_hdlr)
 
236
    _trace_file = None
 
237
    enable_default_logging()
 
238
 
 
239
 
 
240
def format_exception_short(exc_info):
 
241
    """Make a short string form of an exception.
 
242
 
 
243
    This is used for display to stderr.  It specially handles exception
 
244
    classes without useful string methods.
 
245
 
 
246
    The result has no trailing newline.
 
247
 
 
248
    exc_info - typically an exception from sys.exc_info()
 
249
    """
 
250
    exc_type, exc_object, exc_tb = exc_info
 
251
    try:
 
252
        if exc_type is None:
 
253
            return '(no exception)'
 
254
        if isinstance(exc_object, (BzrError, BzrNewError)):
 
255
            return str(exc_object)
 
256
        else:
 
257
            import traceback
 
258
            tb = traceback.extract_tb(exc_tb)
 
259
            msg = '%s: %s' % (exc_type, exc_object)
 
260
            if msg[-1] == '\n':
 
261
                msg = msg[:-1]
 
262
            if tb:
 
263
                msg += '\n  at %s line %d\n  in %s' % (tb[-1][:3])
 
264
            return msg
 
265
    except Exception, formatting_exc:
 
266
        # XXX: is this really better than just letting it run up?
 
267
        return '(error formatting exception of type %s: %s)' \
 
268
                % (exc_type, formatting_exc)