1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Messages and logging.
19
Messages are supplied by callers as a string-formatting template, plus values
20
to be inserted into it. The actual %-formatting is deferred to the log
21
library so that it doesn't need to be done for messages that won't be emitted.
23
Messages are classified by severity levels: critical, error, warning, info,
26
They can be sent to two places: to stderr, and to ~/.brz.log. For purposes
27
such as running the test suite, they can also be redirected away from both of
28
those two places to another location.
30
~/.brz.log gets all messages, and full tracebacks for uncaught exceptions.
31
This trace file is always in UTF-8, regardless of the user's default encoding,
32
so that we can always rely on writing any message.
34
Output to stderr depends on the mode chosen by the user. By default, messages
35
of info and above are sent out, which results in progress messages such as the
36
list of files processed by add and commit. In debug mode, stderr gets debug messages too.
38
Errors that terminate an operation are generally passed back as exceptions;
39
others may be just emitted as messages.
41
Exceptions are reported in a brief form to stderr so as not to look scary.
42
BzrErrors are required to be able to format themselves into a properly
43
explanatory message. This is not true for builtin exceptions such as
44
KeyError, which typically just str to "0". They're printed in a different
48
from __future__ import absolute_import
50
# FIXME: Unfortunately it turns out that python's logging module
51
# is quite expensive, even when the message is not printed by any handlers.
52
# We should perhaps change back to just simply doing it here.
54
# On the other hand, as of 1.2 we generally only call the mutter() statement
55
# if (according to debug_flags) we actually intend to write it. So the
56
# increased cost of logging.py is not so bad, and we could standardize on
65
from .lazy_import import lazy_import
66
lazy_import(globals(), """
74
lazy_import(globals(), """
91
# global verbosity for breezy; controls the log level for stderr; 0=normal; <0
92
# is quiet; >0 is verbose.
95
# File-like object where mutter/debug output is currently sent. Can be
96
# changed by _push_log_file etc. This is directly manipulated by some
97
# external code; maybe there should be functions to do that more precisely
98
# than push/pop_log_file.
101
# Absolute path for ~/.brz.log. Not changed even if the log/trace output is
102
# redirected elsewhere. Used to show the location in --version.
103
_brz_log_filename = None
105
# The time the first message was written to the trace file, so that we can
106
# show relative times since startup.
107
_brz_log_start_time = breezy._start_time
110
# held in a global for quick reference
111
_brz_logger = logging.getLogger('brz')
114
def note(*args, **kwargs):
115
"""Output a note to the user.
117
Takes the same parameters as logging.info.
121
# FIXME: clearing the ui and then going through the abstract logging
122
# framework is whack; we should probably have a logging Handler that
123
# deals with terminal output if needed.
124
ui.ui_factory.clear_term()
125
_brz_logger.info(*args, **kwargs)
128
def warning(*args, **kwargs):
129
ui.ui_factory.clear_term()
130
_brz_logger.warning(*args, **kwargs)
133
def show_error(*args, **kwargs):
134
"""Show an error message to the user.
136
Don't use this for exceptions, use report_exception instead.
138
_brz_logger.error(*args, **kwargs)
142
"""Compat class for displaying bytes on Python 2."""
145
return 'b' + str.__repr__(self)
147
def __unicode__(self):
148
return self.decode('ascii', 'replace')
151
def mutter(fmt, *args):
152
if _trace_file is None:
154
# XXX: Don't check this every time; instead anyone who closes the file
155
# ought to deregister it. We can tolerate None.
156
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
159
# Let format strings be specified as ascii bytes to help Python 2
160
if isinstance(fmt, bytes):
161
fmt = fmt.decode('ascii', 'replace')
166
_Bytes(arg) if isinstance(arg, bytes) else arg for arg in args)
171
out = '%0.3f %s\n' % (now - _brz_log_start_time, out)
172
_trace_file.write(out.encode('utf-8'))
173
# there's no explicit flushing; the file is typically line buffered.
176
def mutter_callsite(stacklevel, fmt, *args):
177
"""Perform a mutter of fmt and args, logging the call trace.
179
:param stacklevel: The number of frames to show. None will show all
181
:param fmt: The format string to pass to mutter.
182
:param args: A list of substitution variables.
185
if stacklevel is None:
188
limit = stacklevel + 1
189
traceback.print_stack(limit=limit, file=outf)
190
formatted_lines = outf.getvalue().splitlines()
191
formatted_stack = '\n'.join(formatted_lines[:-2])
192
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
195
def _rollover_trace_maybe(trace_fname):
198
size = os.stat(trace_fname)[stat.ST_SIZE]
201
old_fname = trace_fname + '.old'
202
osutils.rename(trace_fname, old_fname)
207
def _get_brz_log_filename():
208
brz_log = osutils.path_from_environ('BRZ_LOG')
211
home = osutils.path_from_environ('BRZ_HOME')
213
# GZ 2012-02-01: Logging to the home dir is bad, but XDG is unclear
214
# over what would be better. On windows, bug 240550
215
# suggests LOCALAPPDATA be used instead.
216
home = osutils._get_home_dir()
217
return os.path.join(home, '.brz.log')
221
"""Open the .brz.log trace file.
223
If the log is more than a particular length, the old file is renamed to
224
.brz.log.old and a new file is started. Otherwise, we append to the
227
This sets the global _brz_log_filename.
229
global _brz_log_filename
231
def _open_or_create_log_file(filename):
232
"""Open existing log file, or create with ownership and permissions
234
It inherits the ownership and permissions (masked by umask) from
235
the containing directory to cope better with being run under sudo
236
with $HOME still set to the user's homedir.
238
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
241
fd = os.open(filename, flags)
244
if e.errno != errno.ENOENT:
247
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0o666)
249
if e.errno != errno.EEXIST:
252
osutils.copy_ownership_from_path(filename)
254
return os.fdopen(fd, 'ab', 0) # unbuffered
257
_brz_log_filename = _get_brz_log_filename()
258
_rollover_trace_maybe(_brz_log_filename)
260
brz_log_file = _open_or_create_log_file(_brz_log_filename)
261
brz_log_file.write(b'\n')
262
if brz_log_file.tell() <= 2:
263
brz_log_file.write(b"this is a debug log for diagnosing/reporting problems in brz\n")
264
brz_log_file.write(b"you can delete or truncate this file, or include sections in\n")
265
brz_log_file.write(b"bug reports to https://bugs.launchpad.net/brz/+filebug\n\n")
269
except EnvironmentError as e:
270
# If we are failing to open the log, then most likely logging has not
271
# been set up yet. So we just write to stderr rather than using
272
# 'warning()'. If we using warning(), users get the unhelpful 'no
273
# handlers registered for "brz"' when something goes wrong on the
274
# server. (bug #503886)
275
sys.stderr.write("failed to open trace file: %s\n" % (e,))
276
# TODO: What should happen if we fail to open the trace file? Maybe the
277
# objects should be pointed at /dev/null or the equivalent? Currently
278
# returns None which will cause failures later.
282
def enable_default_logging():
283
"""Configure default logging: messages to stderr and debug to .brz.log
285
This should only be called once per process.
287
Non-command-line programs embedding breezy do not need to call this. They
288
can instead either pass a file to _push_log_file, or act directly on
289
logging.getLogger("brz").
291
Output can be redirected away by calling _push_log_file.
293
:return: A memento from push_log_file for restoring the log state.
295
start_time = osutils.format_local_date(_brz_log_start_time,
297
brz_log_file = _open_brz_log()
298
if brz_log_file is not None:
299
brz_log_file.write(start_time.encode('utf-8') + b'\n')
300
memento = push_log_file(brz_log_file,
301
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
302
r'%Y-%m-%d %H:%M:%S')
303
# after hooking output into brz_log, we also need to attach a stderr
304
# handler, writing only at level info and with encoding
305
if sys.version_info[0] == 2:
306
stderr_handler = EncodedStreamHandler(sys.stderr,
307
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
309
stderr_handler = logging.StreamHandler(stream=sys.stderr)
310
logging.getLogger('brz').addHandler(stderr_handler)
314
def push_log_file(to_file, log_format=None, date_format=None):
315
"""Intercept log and trace messages and send them to a file.
317
:param to_file: A file-like object to which messages will be sent.
319
:returns: A memento that should be passed to _pop_log_file to restore the
320
previously active logging.
324
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
325
if log_format is None:
326
log_format = '%(levelname)8s %(message)s'
327
new_handler.setFormatter(logging.Formatter(log_format, date_format))
328
# save and remove any existing log handlers
329
brz_logger = logging.getLogger('brz')
330
old_handlers = brz_logger.handlers[:]
331
del brz_logger.handlers[:]
332
# set that as the default logger
333
brz_logger.addHandler(new_handler)
334
brz_logger.setLevel(logging.DEBUG)
335
# TODO: check if any changes are needed to the root logger
337
# TODO: also probably need to save and restore the level on brz_logger.
338
# but maybe we can avoid setting the logger level altogether, and just set
339
# the level on the handler?
341
# save the old trace file
342
old_trace_file = _trace_file
343
# send traces to the new one
344
_trace_file = to_file
345
result = new_handler, _trace_file
346
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
349
def pop_log_file(entry):
350
"""Undo changes to logging/tracing done by _push_log_file.
352
This flushes, but does not close the trace file (so that anything that was
355
Takes the memento returned from _push_log_file."""
356
(magic, old_handlers, new_handler, old_trace_file, new_trace_file) = entry
358
_trace_file = old_trace_file
359
brz_logger = logging.getLogger('brz')
360
brz_logger.removeHandler(new_handler)
361
# must be closed, otherwise logging will try to close it at exit, and the
362
# file will likely already be closed underneath.
364
brz_logger.handlers = old_handlers
365
if new_trace_file is not None:
366
new_trace_file.flush()
369
def log_exception_quietly():
370
"""Log the last exception to the trace file only.
372
Used for exceptions that occur internally and that may be
373
interesting to developers but not to users. For example,
374
errors loading plugins.
376
mutter(traceback.format_exc())
379
def set_verbosity_level(level):
380
"""Set the verbosity level.
382
:param level: -ve for quiet, 0 for normal, +ve for verbose
384
global _verbosity_level
385
_verbosity_level = level
386
_update_logging_level(level < 0)
387
ui.ui_factory.be_quiet(level < 0)
390
def get_verbosity_level():
391
"""Get the verbosity level.
393
See set_verbosity_level() for values.
395
return _verbosity_level
398
def be_quiet(quiet=True):
400
set_verbosity_level(-1)
402
set_verbosity_level(0)
405
def _update_logging_level(quiet=True):
406
"""Hide INFO messages if quiet."""
408
_brz_logger.setLevel(logging.WARNING)
410
_brz_logger.setLevel(logging.INFO)
414
"""Is the verbosity level negative?"""
415
return _verbosity_level < 0
419
"""Is the verbosity level positive?"""
420
return _verbosity_level > 0
423
def debug_memory(message='', short=True):
424
"""Write out a memory dump."""
425
if sys.platform == 'win32':
426
from breezy import win32utils
427
win32utils.debug_memory_win32api(message=message, short=short)
429
_debug_memory_proc(message=message, short=short)
432
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
434
def _debug_memory_proc(message='', short=True):
436
status_file = open('/proc/%s/status' % os.getpid(), 'rb')
440
status = status_file.read()
445
for line in status.splitlines():
449
for field in _short_fields:
450
if line.startswith(field):
454
def _dump_memory_usage(err_file):
457
fd, name = tempfile.mkstemp(prefix="brz_memdump", suffix=".json")
458
dump_file = os.fdopen(fd, 'w')
459
from meliae import scanner
460
scanner.dump_gc_objects(dump_file)
461
err_file.write("Memory dumped to %s\n" % name)
463
err_file.write("Dumping memory requires meliae module.\n")
464
log_exception_quietly()
466
err_file.write("Exception while dumping memory.\n")
467
log_exception_quietly()
469
if dump_file is not None:
475
def _qualified_exception_name(eclass, unqualified_breezy_errors=False):
476
"""Give name of error class including module for non-builtin exceptions
478
If `unqualified_breezy_errors` is True, errors specific to breezy will
479
also omit the module prefix.
481
class_name = eclass.__name__
482
module_name = eclass.__module__
483
if module_name in ("builtins", "exceptions", "__main__") or (
484
unqualified_breezy_errors and module_name == "breezy.errors"):
486
return "%s.%s" % (module_name, class_name)
489
def report_exception(exc_info, err_file):
490
"""Report an exception to err_file (typically stderr) and to .brz.log.
492
This will show either a full traceback or a short message as appropriate.
494
:return: The appropriate exit code for this error.
496
# Log the full traceback to ~/.brz.log
497
log_exception_quietly()
498
if 'error' in debug.debug_flags:
499
print_exception(exc_info, err_file)
500
return errors.EXIT_ERROR
501
exc_type, exc_object, exc_tb = exc_info
502
if isinstance(exc_object, KeyboardInterrupt):
503
err_file.write("brz: interrupted\n")
504
return errors.EXIT_ERROR
505
elif isinstance(exc_object, MemoryError):
506
err_file.write("brz: out of memory\n")
507
if 'mem_dump' in debug.debug_flags:
508
_dump_memory_usage(err_file)
510
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
511
return errors.EXIT_ERROR
512
elif isinstance(exc_object, ImportError) \
513
and str(exc_object).startswith("No module named "):
514
report_user_error(exc_info, err_file,
515
'You may need to install this Python library separately.')
516
return errors.EXIT_ERROR
517
elif not getattr(exc_object, 'internal_error', True):
518
report_user_error(exc_info, err_file)
519
return errors.EXIT_ERROR
520
elif osutils.is_environment_error(exc_object):
521
if getattr(exc_object, 'errno', None) == errno.EPIPE:
522
err_file.write("brz: broken pipe\n")
523
return errors.EXIT_ERROR
524
# Might be nice to catch all of these and show them as something more
525
# specific, but there are too many cases at the moment.
526
report_user_error(exc_info, err_file)
527
return errors.EXIT_ERROR
529
report_bug(exc_info, err_file)
530
return errors.EXIT_INTERNAL_ERROR
533
def print_exception(exc_info, err_file):
534
exc_type, exc_object, exc_tb = exc_info
535
err_file.write("brz: ERROR: %s: %s\n" % (
536
_qualified_exception_name(exc_type), exc_object))
538
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
541
# TODO: Should these be specially encoding the output?
542
def report_user_error(exc_info, err_file, advice=None):
543
"""Report to err_file an error that's not an internal error.
545
These don't get a traceback unless -Derror was given.
547
:param exc_info: 3-tuple from sys.exc_info()
548
:param advice: Extra advice to the user to be printed following the
551
err_file.write(("brz: ERROR: %s\n" % (str(exc_info[1]),)))
553
err_file.write(("%s\n" % advice))
556
def report_bug(exc_info, err_file):
557
"""Report an exception that probably indicates a bug in brz"""
558
from breezy.crash import report_bug
559
report_bug(exc_info, err_file)
562
def _flush_stdout_stderr():
563
# called from the breezy library finalizer returned by breezy.initialize()
567
except ValueError as e:
568
# On Windows, I get ValueError calling stdout.flush() on a closed
573
if e.errno in [errno.EINVAL, errno.EPIPE]:
580
# called from the breezy library finalizer returned by breezy.initialize()
586
class EncodedStreamHandler(logging.Handler):
587
"""Robustly write logging events to a stream using the specified encoding
589
Messages are expected to be formatted to unicode, but UTF-8 byte strings
590
are also accepted. An error during formatting or a str message in another
591
encoding will be quitely noted as an error in the Bazaar log file.
593
The stream is not closed so sys.stdout or sys.stderr may be passed.
596
def __init__(self, stream, encoding=None, errors='strict', level=0):
597
logging.Handler.__init__(self, level)
600
encoding = getattr(stream, "encoding", "ascii")
601
self.encoding = encoding
605
flush = getattr(self.stream, "flush", None)
606
if flush is not None:
609
def emit(self, record):
611
if not isinstance(record.msg, text_type):
612
msg = record.msg.decode("utf-8")
615
line = self.format(record)
616
if not isinstance(line, text_type):
617
line = line.decode("utf-8")
618
self.stream.write(line.encode(self.encoding, self.errors) + b"\n")
620
log_exception_quietly()
621
# Try saving the details that would have been logged in some form
622
msg = args = "<Unformattable>"
624
msg = repr(record.msg)
625
args = repr(record.args)
628
# Using mutter() bypasses the logging module and writes directly
629
# to the file so there's no danger of getting into a loop here.
630
mutter("Logging record unformattable: %s %% %s", msg, args)
633
class Config(object):
634
"""Configuration of message tracing in breezy.
636
This implements the context manager protocol and should manage any global
637
variables still used. The default config used is DefaultConfig, but
638
embedded uses of breezy may wish to use a custom manager.
642
return self # This is bound to the 'as' clause in a with statement.
644
def __exit__(self, exc_type, exc_val, exc_tb):
645
return False # propogate exceptions.
648
class DefaultConfig(Config):
649
"""A default configuration for tracing of messages in breezy.
651
This implements the context manager protocol.
655
self._original_filename = _brz_log_filename
656
self._original_state = enable_default_logging()
657
return self # This is bound to the 'as' clause in a with statement.
659
def __exit__(self, exc_type, exc_val, exc_tb):
660
pop_log_file(self._original_state)
661
global _brz_log_filename
662
_brz_log_filename = self._original_filename
663
return False # propogate exceptions.
added
removed
breezy/trace.py
