/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Jelmer Vernooij
  • Date: 2005-10-19 09:34:39 UTC
  • mfrom: (1185.16.78)
  • mto: (1185.16.102)
  • mto: This revision was merged to the branch mainline in revision 1488.
  • Revision ID: jelmer@samba.org-20051019093439-e1d8e3508d1ba46b
Merge from Martin

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.
 
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
# FIXME: Unfortunately it turns out that python's logging module
 
37
# is quite expensive, even when the message is not printed by any handlers.
 
38
# We should perhaps change back to just simply doing it here.
 
39
 
 
40
 
 
41
import sys
 
42
import os
 
43
import logging
 
44
import traceback
 
45
 
 
46
 
 
47
_file_handler = None
 
48
_stderr_handler = None
 
49
 
 
50
 
 
51
class QuietFormatter(logging.Formatter):
 
52
    """Formatter that supresses the details of errors.
 
53
 
 
54
    This is used by default on stderr so as not to scare the user.
 
55
    """
 
56
    # At first I tried overriding formatException to suppress the
 
57
    # exception details, but that has global effect: no loggers
 
58
    # can get the exception details is we suppress them here.
 
59
 
 
60
    def format(self, record):
 
61
        if record.levelno >= logging.WARNING:
 
62
            s = 'bzr: ' + record.levelname + ': '
 
63
        else:
 
64
            s = ''
 
65
            
 
66
        s += record.getMessage()
 
67
 
 
68
        ##import textwrap
 
69
        ##s = textwrap.fill(s)
 
70
            
 
71
        if record.exc_info:
 
72
            # give just a summary of the exception, not the whole thing
 
73
            exinfo = traceback.extract_tb(record.exc_info[2])
 
74
            # the format of this string matches one of the REs
 
75
            s += '\n'
 
76
            s += ('  at %s line %d, in %s()\n' % exinfo[-1][:3])
 
77
            s += '  see ~/.bzr.log for debug information'
 
78
 
 
79
        return s
 
80
        
 
81
 
 
82
 
 
83
 
 
84
################
 
85
# configure convenient aliases for output routines
 
86
 
 
87
_bzr_logger = logging.getLogger('bzr')
 
88
_bzr_logger.setLevel(logging.DEBUG) 
 
89
 
 
90
info = note = _bzr_logger.info
 
91
warning =   _bzr_logger.warning
 
92
log_error = _bzr_logger.error
 
93
error =     _bzr_logger.error
 
94
mutter =    _bzr_logger.debug
 
95
debug =     _bzr_logger.debug
 
96
 
 
97
 
 
98
 
 
99
 
 
100
# we do the rollover using this code, rather than the default from python
 
101
# logging, because we only want to rollover at program startup, not on each
 
102
# message.  maybe that's not a good enough reason.
 
103
 
 
104
def _rollover_trace_maybe(trace_fname):
 
105
    import stat
 
106
    try:
 
107
        size = os.stat(trace_fname)[stat.ST_SIZE]
 
108
        if size <= 4 << 20:
 
109
            return
 
110
        old_fname = trace_fname + '.old'
 
111
 
 
112
        from osutils import rename
 
113
        rename(trace_fname, old_fname)
 
114
 
 
115
    except OSError:
 
116
        return
 
117
 
 
118
 
 
119
 
 
120
def open_tracefile(tracefilename='~/.bzr.log'):
 
121
    # Messages are always written to here, so that we have some
 
122
    # information if something goes wrong.  In a future version this
 
123
    # file will be removed on successful completion.
 
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: %r', 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
    cmd_repr = ' '.join(repr(arg) for arg in sys.argv)
 
169
    cmd_info = '\n  command: %s\n  pwd: %s' \
 
170
        % (cmd_repr, os.getcwd())
 
171
    if msg == None:
 
172
        ei = sys.exc_info()
 
173
        msg = str(ei[1])
 
174
    if msg and (msg[-1] == '\n'):
 
175
        msg = msg[:-1]
 
176
    ## msg = "(%s) %s" % (str(type(ei[1])), msg)
 
177
    _bzr_logger.exception(msg + cmd_info)
 
178
 
 
179
 
 
180
 
 
181
def enable_default_logging():
 
182
    """Configure default logging to stderr and .bzr.log"""
 
183
    global _stderr_handler, _file_handler
 
184
 
 
185
    _stderr_handler = logging.StreamHandler()
 
186
    _stderr_handler.setFormatter(QuietFormatter())
 
187
 
 
188
    if not _file_handler:
 
189
        open_tracefile()
 
190
 
 
191
    if os.environ.get('BZR_DEBUG'):
 
192
        level = logging.DEBUG
 
193
    else:
 
194
        level = logging.INFO
 
195
 
 
196
    _stderr_handler.setLevel(logging.INFO)
 
197
    _file_handler.setLevel(level)
 
198
 
 
199
    logging.getLogger('').addHandler(_stderr_handler)
 
200
 
 
201
 
 
202
def disable_default_logging():
 
203
    """Turn off default log handlers.
 
204
 
 
205
    This is intended to be used by the test framework, which doesn't
 
206
    want leakage from the code-under-test into the main logs.
 
207
    """
 
208
 
 
209
    l = logging.getLogger('')
 
210
    l.removeHandler(_stderr_handler)
 
211
    if _file_handler:
 
212
        l.removeHandler(_file_handler)