← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Ian Clatworthy
  • Date: 2009-09-09 11:43:10 UTC
  • mto: (4634.37.2 prepare-2.0)
  • mto: This revision was merged to the branch mainline in revision 4689.
  • Revision ID: ian.clatworthy@canonical.com-20090909114310-glw7tv76i5gnx9pt
put rules back in Makefile supporting plain-style docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Messages and logging for bazaar-ng.
18
18
 
49
49
# FIXME: Unfortunately it turns out that python's logging module
50
50
# is quite expensive, even when the message is not printed by any handlers.
51
51
# We should perhaps change back to just simply doing it here.
 
52
#
 
53
# On the other hand, as of 1.2 we generally only call the mutter() statement
 
54
# if (according to debug_flags) we actually intend to write it.  So the
 
55
# increased cost of logging.py is not so bad, and we could standardize on
 
56
# that.
52
57
 
 
58
import codecs
 
59
import logging
53
60
import os
54
61
import sys
55
62
import re
 
63
import time
56
64
 
57
65
from bzrlib.lazy_import import lazy_import
58
66
lazy_import(globals(), """
59
67
from cStringIO import StringIO
60
68
import errno
61
 
import logging
 
69
import locale
62
70
import traceback
63
71
""")
64
72
 
65
73
import bzrlib
66
74
 
67
75
lazy_import(globals(), """
68
 
from bzrlib import debug
 
76
from bzrlib import (
 
77
    debug,
 
78
    errors,
 
79
    osutils,
 
80
    plugin,
 
81
    symbol_versioning,
 
82
    )
69
83
""")
70
84
 
71
 
_file_handler = None
72
 
_stderr_handler = None
73
 
_stderr_quiet = False
 
85
 
 
86
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
 
87
# is quiet; >0 is verbose.
 
88
_verbosity_level = 0
 
89
 
 
90
# File-like object where mutter/debug output is currently sent.  Can be
 
91
# changed by _push_log_file etc.  This is directly manipulated by some
 
92
# external code; maybe there should be functions to do that more precisely
 
93
# than push/pop_log_file.
74
94
_trace_file = None
75
 
_trace_depth = 0
76
 
_bzr_log_file = None
 
95
 
 
96
# Absolute path for ~/.bzr.log.  Not changed even if the log/trace output is
 
97
# redirected elsewhere.  Used to show the location in --version.
77
98
_bzr_log_filename = None
78
99
 
79
 
 
80
 
# configure convenient aliases for output routines
81
 
 
 
100
# The time the first message was written to the trace file, so that we can
 
101
# show relative times since startup.
 
102
_bzr_log_start_time = bzrlib._start_time
 
103
 
 
104
 
 
105
# held in a global for quick reference
82
106
_bzr_logger = logging.getLogger('bzr')
83
107
 
 
108
 
84
109
def note(*args, **kwargs):
85
110
    # FIXME note always emits utf-8, regardless of the terminal encoding
 
111
    #
 
112
    # FIXME: clearing the ui and then going through the abstract logging
 
113
    # framework is whack; we should probably have a logging Handler that
 
114
    # deals with terminal output if needed.
86
115
    import bzrlib.ui
87
116
    bzrlib.ui.ui_factory.clear_term()
88
117
    _bzr_logger.info(*args, **kwargs)
89
118
 
 
119
 
90
120
def warning(*args, **kwargs):
91
121
    import bzrlib.ui
92
122
    bzrlib.ui.ui_factory.clear_term()
93
123
    _bzr_logger.warning(*args, **kwargs)
94
124
 
 
125
 
 
126
# configure convenient aliases for output routines
 
127
#
 
128
# TODO: deprecate them, have one name for each.
95
129
info = note
96
130
log_error = _bzr_logger.error
97
131
error =     _bzr_logger.error
98
132
 
99
133
 
 
134
_last_mutter_flush_time = None
 
135
 
100
136
def mutter(fmt, *args):
 
137
    global _last_mutter_flush_time
101
138
    if _trace_file is None:
102
139
        return
103
140
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
118
155
        out = fmt % tuple(real_args)
119
156
    else:
120
157
        out = fmt
121
 
    out += '\n'
 
158
    now = time.time()
 
159
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
 
160
    out = timestamp + out + '\n'
122
161
    _trace_file.write(out)
123
 
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
124
 
    #_trace_file.flush()
 
162
    # We flush if we haven't flushed for a few seconds. We don't want to flush
 
163
    # on every mutter, but when a command takes a while, it can be nice to see
 
164
    # updates in the debug log.
 
165
    if (_last_mutter_flush_time is None
 
166
        or (now - _last_mutter_flush_time) > 2.0):
 
167
        flush = getattr(_trace_file, 'flush', None)
 
168
        if flush is not None:
 
169
            flush()
 
170
        _last_mutter_flush_time = now
125
171
 
126
172
 
127
173
def mutter_callsite(stacklevel, fmt, *args):
133
179
    :param args: A list of substitution variables.
134
180
    """
135
181
    outf = StringIO()
136
 
    traceback.print_stack(limit=stacklevel + 1, file=outf)
 
182
    if stacklevel is None:
 
183
        limit = None
 
184
    else:
 
185
        limit = stacklevel + 1
 
186
    traceback.print_stack(limit=limit, file=outf)
137
187
    formatted_lines = outf.getvalue().splitlines()
138
188
    formatted_stack = '\n'.join(formatted_lines[:-2])
139
189
    mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
146
196
        if size <= 4 << 20:
147
197
            return
148
198
        old_fname = trace_fname + '.old'
149
 
        from osutils import rename
150
 
        rename(trace_fname, old_fname)
 
199
        osutils.rename(trace_fname, old_fname)
151
200
    except OSError:
152
201
        return
153
202
 
154
203
 
155
 
def open_tracefile(tracefilename=None):
156
 
    # Messages are always written to here, so that we have some
157
 
    # information if something goes wrong.  In a future version this
158
 
    # file will be removed on successful completion.
159
 
    global _file_handler, _bzr_log_file, _bzr_log_filename
160
 
    import codecs
161
 
 
162
 
    if tracefilename is None:
 
204
def _get_bzr_log_filename():
 
205
    bzr_log = os.environ.get('BZR_LOG')
 
206
    if bzr_log:
 
207
        return bzr_log
 
208
    home = os.environ.get('BZR_HOME')
 
209
    if home is None:
163
210
        if sys.platform == 'win32':
164
211
            from bzrlib import win32utils
165
212
            home = win32utils.get_home_location()
166
213
        else:
167
214
            home = os.path.expanduser('~')
168
 
        _bzr_log_filename = os.path.join(home, '.bzr.log')
169
 
    else:
170
 
        _bzr_log_filename = tracefilename
171
 
 
172
 
    _bzr_log_filename = os.path.expanduser(_bzr_log_filename)
 
215
    return os.path.join(home, '.bzr.log')
 
216
 
 
217
 
 
218
def _open_bzr_log():
 
219
    """Open the .bzr.log trace file.
 
220
 
 
221
    If the log is more than a particular length, the old file is renamed to
 
222
    .bzr.log.old and a new file is started.  Otherwise, we append to the
 
223
    existing file.
 
224
 
 
225
    This sets the global _bzr_log_filename.
 
226
    """
 
227
    global _bzr_log_filename
 
228
    _bzr_log_filename = _get_bzr_log_filename()
173
229
    _rollover_trace_maybe(_bzr_log_filename)
174
230
    try:
175
 
        LINE_BUFFERED = 1
176
 
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
177
 
        tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
178
 
        _bzr_log_file = tf
179
 
        # tf.tell() on windows always return 0 until some writing done
180
 
        tf.write('\n')
181
 
        if tf.tell() <= 2:
182
 
            tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
183
 
            tf.write("you can delete or truncate this file, or include sections in\n")
184
 
            tf.write("bug reports to bazaar@lists.canonical.com\n\n")
185
 
        _file_handler = logging.StreamHandler(tf)
186
 
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
187
 
        datefmt = r'%a %H:%M:%S'
188
 
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
189
 
        _file_handler.setLevel(logging.DEBUG)
190
 
        logging.getLogger('').addHandler(_file_handler)
 
231
        bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
 
232
        # bzr_log_file.tell() on windows always return 0 until some writing done
 
233
        bzr_log_file.write('\n')
 
234
        if bzr_log_file.tell() <= 2:
 
235
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
 
236
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
 
237
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
 
238
        return bzr_log_file
191
239
    except IOError, e:
192
240
        warning("failed to open trace file: %s" % (e))
 
241
    # TODO: What should happen if we fail to open the trace file?  Maybe the
 
242
    # objects should be pointed at /dev/null or the equivalent?  Currently
 
243
    # returns None which will cause failures later.
 
244
    return None
 
245
 
 
246
 
 
247
def enable_default_logging():
 
248
    """Configure default logging: messages to stderr and debug to .bzr.log
 
249
 
 
250
    This should only be called once per process.
 
251
 
 
252
    Non-command-line programs embedding bzrlib do not need to call this.  They
 
253
    can instead either pass a file to _push_log_file, or act directly on
 
254
    logging.getLogger("bzr").
 
255
 
 
256
    Output can be redirected away by calling _push_log_file.
 
257
    """
 
258
    # Do this before we open the log file, so we prevent
 
259
    # get_terminal_encoding() from mutter()ing multiple times
 
260
    term_encoding = osutils.get_terminal_encoding()
 
261
    start_time = osutils.format_local_date(_bzr_log_start_time,
 
262
                                           timezone='local')
 
263
    # create encoded wrapper around stderr
 
264
    bzr_log_file = _open_bzr_log()
 
265
    if bzr_log_file is not None:
 
266
        bzr_log_file.write(start_time.encode('utf-8') + '\n')
 
267
    push_log_file(bzr_log_file,
 
268
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
 
269
        r'%Y-%m-%d %H:%M:%S')
 
270
    # after hooking output into bzr_log, we also need to attach a stderr
 
271
    # handler, writing only at level info and with encoding
 
272
    writer_factory = codecs.getwriter(term_encoding)
 
273
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
 
274
    stderr_handler = logging.StreamHandler(encoded_stderr)
 
275
    stderr_handler.setLevel(logging.INFO)
 
276
    logging.getLogger('bzr').addHandler(stderr_handler)
 
277
 
 
278
 
 
279
def push_log_file(to_file, log_format=None, date_format=None):
 
280
    """Intercept log and trace messages and send them to a file.
 
281
 
 
282
    :param to_file: A file-like object to which messages will be sent.
 
283
 
 
284
    :returns: A memento that should be passed to _pop_log_file to restore the
 
285
    previously active logging.
 
286
    """
 
287
    global _trace_file
 
288
    # make a new handler
 
289
    new_handler = logging.StreamHandler(to_file)
 
290
    new_handler.setLevel(logging.DEBUG)
 
291
    if log_format is None:
 
292
        log_format = '%(levelname)8s  %(message)s'
 
293
    new_handler.setFormatter(logging.Formatter(log_format, date_format))
 
294
    # save and remove any existing log handlers
 
295
    bzr_logger = logging.getLogger('bzr')
 
296
    old_handlers = bzr_logger.handlers[:]
 
297
    del bzr_logger.handlers[:]
 
298
    # set that as the default logger
 
299
    bzr_logger.addHandler(new_handler)
 
300
    bzr_logger.setLevel(logging.DEBUG)
 
301
    # TODO: check if any changes are needed to the root logger
 
302
    #
 
303
    # TODO: also probably need to save and restore the level on bzr_logger.
 
304
    # but maybe we can avoid setting the logger level altogether, and just set
 
305
    # the level on the handler?
 
306
    #
 
307
    # save the old trace file
 
308
    old_trace_file = _trace_file
 
309
    # send traces to the new one
 
310
    _trace_file = to_file
 
311
    result = new_handler, _trace_file
 
312
    return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
 
313
 
 
314
 
 
315
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
 
316
    """Undo changes to logging/tracing done by _push_log_file.
 
317
 
 
318
    This flushes, but does not close the trace file.
 
319
 
 
320
    Takes the memento returned from _push_log_file."""
 
321
    global _trace_file
 
322
    _trace_file = old_trace_file
 
323
    bzr_logger = logging.getLogger('bzr')
 
324
    bzr_logger.removeHandler(new_handler)
 
325
    # must be closed, otherwise logging will try to close it atexit, and the
 
326
    # file will likely already be closed underneath.
 
327
    new_handler.close()
 
328
    bzr_logger.handlers = old_handlers
 
329
    new_trace_file.flush()
193
330
 
194
331
 
195
332
def log_exception_quietly():
196
333
    """Log the last exception to the trace file only.
197
334
 
198
 
    Used for exceptions that occur internally and that may be 
199
 
    interesting to developers but not to users.  For example, 
 
335
    Used for exceptions that occur internally and that may be
 
336
    interesting to developers but not to users.  For example,
200
337
    errors loading plugins.
201
338
    """
202
 
    import traceback
203
339
    mutter(traceback.format_exc())
204
340
 
205
341
 
206
 
def enable_default_logging():
207
 
    """Configure default logging to stderr and .bzr.log"""
208
 
    # FIXME: if this is run twice, things get confused
209
 
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
210
 
    _stderr_handler = logging.StreamHandler()
211
 
    logging.getLogger('').addHandler(_stderr_handler)
212
 
    _stderr_handler.setLevel(logging.INFO)
213
 
    if not _file_handler:
214
 
        open_tracefile()
215
 
    _trace_file = _bzr_log_file
216
 
    if _file_handler:
217
 
        _file_handler.setLevel(logging.DEBUG)
218
 
    _bzr_logger.setLevel(logging.DEBUG)
 
342
def set_verbosity_level(level):
 
343
    """Set the verbosity level.
 
344
 
 
345
    :param level: -ve for quiet, 0 for normal, +ve for verbose
 
346
    """
 
347
    global _verbosity_level
 
348
    _verbosity_level = level
 
349
    _update_logging_level(level < 0)
 
350
 
 
351
 
 
352
def get_verbosity_level():
 
353
    """Get the verbosity level.
 
354
 
 
355
    See set_verbosity_level() for values.
 
356
    """
 
357
    return _verbosity_level
219
358
 
220
359
 
221
360
def be_quiet(quiet=True):
222
 
    global _stderr_handler, _stderr_quiet
223
 
    
224
 
    _stderr_quiet = quiet
225
 
    if quiet:
226
 
        _stderr_handler.setLevel(logging.WARNING)
227
 
    else:
228
 
        _stderr_handler.setLevel(logging.INFO)
 
361
    # Perhaps this could be deprecated now ...
 
362
    if quiet:
 
363
        set_verbosity_level(-1)
 
364
    else:
 
365
        set_verbosity_level(0)
 
366
 
 
367
 
 
368
def _update_logging_level(quiet=True):
 
369
    """Hide INFO messages if quiet."""
 
370
    if quiet:
 
371
        _bzr_logger.setLevel(logging.WARNING)
 
372
    else:
 
373
        _bzr_logger.setLevel(logging.INFO)
229
374
 
230
375
 
231
376
def is_quiet():
232
 
    global _stderr_quiet
233
 
    return _stderr_quiet
234
 
 
235
 
 
236
 
def disable_default_logging():
237
 
    """Turn off default log handlers.
238
 
 
239
 
    This is intended to be used by the test framework, which doesn't
240
 
    want leakage from the code-under-test into the main logs.
241
 
    """
242
 
 
243
 
    l = logging.getLogger('')
244
 
    l.removeHandler(_stderr_handler)
245
 
    if _file_handler:
246
 
        l.removeHandler(_file_handler)
247
 
    _trace_file = None
248
 
 
249
 
 
250
 
def enable_test_log(to_file):
251
 
    """Redirect logging to a temporary file for a test
252
 
    
253
 
    returns an opaque reference that should be passed to disable_test_log
254
 
    after the test completes.
255
 
    """
256
 
    disable_default_logging()
257
 
    global _trace_file
258
 
    global _trace_depth
259
 
    hdlr = logging.StreamHandler(to_file)
260
 
    hdlr.setLevel(logging.DEBUG)
261
 
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
262
 
    _bzr_logger.addHandler(hdlr)
263
 
    _bzr_logger.setLevel(logging.DEBUG)
264
 
    result = hdlr, _trace_file, _trace_depth
265
 
    _trace_file = to_file
266
 
    _trace_depth += 1
267
 
    return result
268
 
 
269
 
 
270
 
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
271
 
    _bzr_logger.removeHandler(test_log_hdlr)
272
 
    test_log_hdlr.close()
273
 
    global _trace_file
274
 
    global _trace_depth
275
 
    _trace_file = old_trace_file
276
 
    _trace_depth = old_trace_depth
277
 
    if not _trace_depth:
278
 
        enable_default_logging()
 
377
    """Is the verbosity level negative?"""
 
378
    return _verbosity_level < 0
 
379
 
 
380
 
 
381
def is_verbose():
 
382
    """Is the verbosity level positive?"""
 
383
    return _verbosity_level > 0
 
384
 
 
385
 
 
386
def debug_memory(message='', short=True):
 
387
    """Write out a memory dump."""
 
388
    if sys.platform == 'win32':
 
389
        from bzrlib import win32utils
 
390
        win32utils.debug_memory_win32api(message=message, short=short)
 
391
    else:
 
392
        _debug_memory_proc(message=message, short=short)
 
393
 
 
394
 
 
395
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
 
396
 
 
397
def _debug_memory_proc(message='', short=True):
 
398
    try:
 
399
        status_file = file('/proc/%s/status' % os.getpid(), 'rb')
 
400
    except IOError:
 
401
        return
 
402
    try:
 
403
        status = status_file.read()
 
404
    finally:
 
405
        status_file.close()
 
406
    if message:
 
407
        note(message)
 
408
    for line in status.splitlines():
 
409
        if not short:
 
410
            note(line)
 
411
        else:
 
412
            for field in _short_fields:
 
413
                if line.startswith(field):
 
414
                    note(line)
 
415
                    break
279
416
 
280
417
 
281
418
def report_exception(exc_info, err_file):
 
419
    """Report an exception to err_file (typically stderr) and to .bzr.log.
 
420
 
 
421
    This will show either a full traceback or a short message as appropriate.
 
422
 
 
423
    :return: The appropriate exit code for this error.
 
424
    """
282
425
    exc_type, exc_object, exc_tb = exc_info
283
426
    # Log the full traceback to ~/.bzr.log
284
427
    log_exception_quietly()
285
428
    if (isinstance(exc_object, IOError)
286
429
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
287
 
        print >>err_file, "bzr: broken pipe"
 
430
        err_file.write("bzr: broken pipe\n")
 
431
        return errors.EXIT_ERROR
288
432
    elif isinstance(exc_object, KeyboardInterrupt):
289
 
        print >>err_file, "bzr: interrupted"
 
433
        err_file.write("bzr: interrupted\n")
 
434
        return errors.EXIT_ERROR
 
435
    elif isinstance(exc_object, MemoryError):
 
436
        err_file.write("bzr: out of memory\n")
 
437
        return errors.EXIT_ERROR
 
438
    elif isinstance(exc_object, ImportError) \
 
439
        and str(exc_object).startswith("No module named "):
 
440
        report_user_error(exc_info, err_file,
 
441
            'You may need to install this Python library separately.')
 
442
        return errors.EXIT_ERROR
290
443
    elif not getattr(exc_object, 'internal_error', True):
291
444
        report_user_error(exc_info, err_file)
 
445
        return errors.EXIT_ERROR
292
446
    elif isinstance(exc_object, (OSError, IOError)):
293
447
        # Might be nice to catch all of these and show them as something more
294
448
        # specific, but there are too many cases at the moment.
295
449
        report_user_error(exc_info, err_file)
 
450
        return errors.EXIT_ERROR
296
451
    else:
297
452
        report_bug(exc_info, err_file)
 
453
        return errors.EXIT_INTERNAL_ERROR
 
454
 
 
455
 
 
456
def print_exception(exc_info, err_file):
 
457
    exc_type, exc_object, exc_tb = exc_info
 
458
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
 
459
        exc_type.__module__, exc_type.__name__, exc_object))
 
460
    err_file.write('\n')
 
461
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
298
462
 
299
463
 
300
464
# TODO: Should these be specially encoding the output?
301
 
def report_user_error(exc_info, err_file):
 
465
def report_user_error(exc_info, err_file, advice=None):
302
466
    """Report to err_file an error that's not an internal error.
303
467
 
304
468
    These don't get a traceback unless -Derror was given.
 
469
 
 
470
    :param exc_info: 3-tuple from sys.exc_info()
 
471
    :param advice: Extra advice to the user to be printed following the
 
472
        exception.
305
473
    """
306
474
    if 'error' in debug.debug_flags:
307
 
        report_bug(exc_info, err_file)
 
475
        print_exception(exc_info, err_file)
308
476
        return
309
 
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
 
477
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
 
478
    if advice:
 
479
        err_file.write("%s\n" % (advice,))
310
480
 
311
481
 
312
482
def report_bug(exc_info, err_file):
313
483
    """Report an exception that probably indicates a bug in bzr"""
314
 
    import traceback
315
 
    exc_type, exc_object, exc_tb = exc_info
316
 
    print >>err_file, "bzr: ERROR: %s.%s: %s" % (
317
 
        exc_type.__module__, exc_type.__name__, exc_object)
318
 
    print >>err_file
319
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
320
 
    print >>err_file
321
 
    print >>err_file, 'bzr %s on python %s (%s)' % \
322
 
                       (bzrlib.__version__,
323
 
                        '.'.join(map(str, sys.version_info)),
324
 
                        sys.platform)
325
 
    print >>err_file, 'arguments: %r' % sys.argv
326
 
    print >>err_file
327
 
    print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"
 
484
    from bzrlib.crash import report_bug
 
485
    report_bug(exc_info, err_file)