~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Aaron Bentley
  • Date: 2005-09-29 04:59:47 UTC
  • mto: (1393.1.21) (1185.14.1)
  • mto: This revision was merged to the branch mainline in revision 1396.
  • Revision ID: aaron.bentley@utoronto.ca-20050929045947-ff08a7f6578f9657
Conflict handling where OTHER is deleted

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
3
 
 
4
1
# This program is free software; you can redistribute it and/or modify
5
2
# it under the terms of the GNU General Public License as published by
6
3
# the Free Software Foundation; either version 2 of the License, or
16
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
14
 
18
15
 
19
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
20
 
__author__ = "Martin Pool <mbp@canonical.com>"
21
 
 
22
 
 
23
 
import sys, os, time, socket, stat, codecs
24
 
import bzrlib
25
 
 
26
 
######################################################################
27
 
# messages and logging
28
 
 
29
 
## TODO: If --verbose is given then write to both stderr and
30
 
## _tracefile; perhaps replace _tracefile with a tee thing.
31
 
 
32
 
global _tracefile, _starttime
33
 
_tracefile = None
34
 
 
35
 
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
36
 
_starttime = None
37
 
 
38
 
# If false, notes also go to stdout; should replace this with --silent
39
 
# at some point.
40
 
silent = False
41
 
 
42
 
 
43
 
# TODO: Somehow tie this to the --verbose option?
44
 
verbose = False
45
 
 
46
 
 
47
 
def warning(msg):
48
 
    b = 'bzr: warning: ' + msg + '\n'
49
 
    sys.stderr.write(b)
50
 
    _tracefile.write(b)
51
 
    #_tracefile.flush()
52
 
 
53
 
def mutter(msg):
54
 
    _tracefile.write(msg)
55
 
    _tracefile.write('\n')
56
 
    # _tracefile.flush()
57
 
    if verbose:
58
 
        sys.stderr.write('- ' + msg + '\n')
59
 
 
60
 
 
61
 
def note(msg):
62
 
    b = '* ' + str(msg) + '\n'
63
 
    if not silent:
64
 
        sys.stderr.write(b)
65
 
    _tracefile.write(b)
66
 
    # _tracefile.flush()
67
 
 
68
 
 
69
 
def log_error(msg):
70
 
    sys.stderr.write(msg)
71
 
    _tracefile.write(msg)
72
 
    # _tracefile.flush()
73
 
 
74
 
 
75
 
 
76
 
def create_tracefile(argv):
77
 
    # TODO: Also show contents of /etc/lsb-release, if it can be parsed.
78
 
    #       Perhaps that should eventually go into the platform library?
79
 
    # TODO: If the file doesn't exist, add a note describing it.
80
 
 
 
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.
 
27
"""
 
28
 
 
29
 
 
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
_stderr_handler = None
 
45
 
 
46
 
 
47
class QuietFormatter(logging.Formatter):
 
48
    """Formatter that supresses the details of errors.
 
49
 
 
50
    This is used by default on stderr so as not to scare the user.
 
51
    """
 
52
    # At first I tried overriding formatException to suppress the
 
53
    # exception details, but that has global effect: no loggers
 
54
    # can get the exception details is we suppress them here.
 
55
 
 
56
    def format(self, record):
 
57
        s = 'bzr: '
 
58
        if record.levelno >= logging.WARNING:
 
59
            s += record.levelname + ': '
 
60
            
 
61
        s += record.getMessage() 
 
62
            
 
63
        if record.exc_info:
 
64
            # give just a summary of the exception, not the whole thing
 
65
            exinfo = traceback.extract_tb(record.exc_info[2])
 
66
            # the format of this string matches one of the REs
 
67
            s += '\n'
 
68
            s += ('  at %s line %d, in %s()\n' % exinfo[-1][:3])
 
69
            s += '  see ~/.bzr.log for debug information'
 
70
 
 
71
        return s
 
72
        
 
73
 
 
74
 
 
75
 
 
76
################
 
77
# configure convenient aliases for output routines
 
78
 
 
79
_bzr_logger = logging.getLogger('bzr')
 
80
_bzr_logger.setLevel(logging.DEBUG) 
 
81
 
 
82
info = note = _bzr_logger.info
 
83
warning =   _bzr_logger.warning
 
84
log_error = _bzr_logger.error
 
85
error =     _bzr_logger.error
 
86
mutter =    _bzr_logger.debug
 
87
debug =     _bzr_logger.debug
 
88
 
 
89
 
 
90
 
 
91
 
 
92
# we do the rollover using this code, rather than the default from python
 
93
# logging, because we only want to rollover at program startup, not on each
 
94
# message.  maybe that's not a good enough reason.
 
95
 
 
96
def _rollover_trace_maybe(trace_fname):
 
97
    import stat
 
98
    try:
 
99
        size = os.stat(trace_fname)[stat.ST_SIZE]
 
100
        if size <= 4 << 20:
 
101
            return
 
102
        old_fname = trace_fname + '.old'
 
103
 
 
104
        try:
 
105
            # must remove before rename on windows
 
106
            os.remove(old_fname)
 
107
        except OSError:
 
108
            pass
 
109
 
 
110
        try:
 
111
            # might fail if in use on windows
 
112
            os.rename(trace_fname, old_fname)
 
113
        except OSError:
 
114
            pass
 
115
    except OSError:
 
116
        return
 
117
 
 
118
 
 
119
 
 
120
def open_tracefile(tracefilename='~/.bzr.log'):
81
121
    # Messages are always written to here, so that we have some
82
122
    # information if something goes wrong.  In a future version this
83
123
    # file will be removed on successful completion.
84
 
    global _starttime, _tracefile
85
 
 
86
 
    _starttime = os.times()[4]
87
 
 
88
 
    # XXX: Is HOME always set on Windows?
89
 
    trace_fname = os.path.join(os.environ['HOME'], '.bzr.log')
90
 
    _tracefile = codecs.open(trace_fname, 'at', 'utf8')
91
 
    t = _tracefile
92
 
 
93
 
    if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
94
 
        t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
95
 
        t.write("you can delete or truncate this file, or include sections in\n")
96
 
        t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
97
 
 
98
 
    # TODO: If we failed to create the file, perhaps give a warning
99
 
    # but don't abort; send things to /dev/null instead?
100
 
 
101
 
    
102
 
    t.write('-' * 60 + '\n')
103
 
    t.write('bzr invoked at %s\n' % bzrlib.osutils.format_date(time.time()))
104
 
    t.write('  version: %s\n' % bzrlib.__version__)
105
 
    t.write('  by %s on %s\n' % (bzrlib.osutils.username(), socket.getfqdn()))
106
 
    t.write('  arguments: %r\n' % argv)
107
 
    t.write('  working dir: %s\n' % os.getcwdu())
108
 
 
109
 
    t.write('  platform: %s\n' % sys.platform)
110
 
    t.write('  python: %s\n' % (sys.version_info,))
111
 
 
112
 
    import atexit
113
 
    atexit.register(_close_trace)
114
 
 
115
 
 
116
 
def _close_trace():
117
 
    times = os.times()
118
 
    mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
119
 
           % (times[:4] + ((times[4] - _starttime),)))
120
 
 
121
 
 
122
 
 
 
124
    global _file_handler
 
125
    import stat, codecs
 
126
 
 
127
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
 
128
    _rollover_trace_maybe(trace_fname)
 
129
 
 
130
    # buffering=1 means line buffered
 
131
    try:
 
132
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
 
133
 
 
134
        if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
 
135
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
 
136
            tf.write("you can delete or truncate this file, or include sections in\n")
 
137
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
 
138
        
 
139
        _file_handler = logging.StreamHandler(tf)
 
140
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
 
141
        datefmt = r'%a %H:%M:%S'
 
142
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
 
143
        _file_handler.setLevel(logging.DEBUG)
 
144
        logging.getLogger('').addHandler(_file_handler)
 
145
 
 
146
    except IOError, e:
 
147
        warning("failed to open trace file: %s" % (e))
 
148
 
 
149
 
 
150
def log_startup(argv):
 
151
    import bzrlib
 
152
 
 
153
    debug('bzr %s invoked on python %s (%s)',
 
154
          bzrlib.__version__,
 
155
          '.'.join(map(str, sys.version_info)),
 
156
          sys.platform)
 
157
 
 
158
    debug('  arguments: %r', argv)
 
159
    debug('  working dir: %s', os.getcwdu())
 
160
 
 
161
 
 
162
def log_exception(msg=None):
 
163
    """Log the last exception into the trace file.
 
164
 
 
165
    The exception string representation is used as the error
 
166
    summary, unless msg is given.
 
167
    """
 
168
    if msg == None:
 
169
        ei = sys.exc_info()
 
170
        msg = str(ei[1])
 
171
 
 
172
    if msg and (msg[-1] == '\n'):
 
173
        msg = msg[:-1]
 
174
        
 
175
    _bzr_logger.exception(msg)
 
176
 
 
177
 
 
178
 
 
179
def enable_default_logging():
 
180
    """Configure default logging to stderr and .bzr.log"""
 
181
    global _stderr_handler, _file_handler
 
182
 
 
183
    _stderr_handler = logging.StreamHandler()
 
184
    _stderr_handler.setFormatter(QuietFormatter())
 
185
 
 
186
    if not _file_handler:
 
187
        open_tracefile()
 
188
 
 
189
    if os.environ.get('BZR_DEBUG'):
 
190
        level = logging.DEBUG
 
191
    else:
 
192
        level = logging.INFO
 
193
 
 
194
    _stderr_handler.setLevel(logging.INFO)
 
195
    _file_handler.setLevel(level)
 
196
 
 
197
    logging.getLogger('').addHandler(_stderr_handler)
 
198
 
 
199
 
 
200
def disable_default_logging():
 
201
    """Turn off default log handlers.
 
202
 
 
203
    This is intended to be used by the test framework, which doesn't
 
204
    want leakage from the code-under-test into the main logs.
 
205
    """
 
206
 
 
207
    l = logging.getLogger('')
 
208
    l.removeHandler(_stderr_handler)
 
209
    if _file_handler:
 
210
        l.removeHandler(_file_handler)