READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server440 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

7,846 bytes · SHA-256 18433f9234a6c534… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2017-present The Bitcoin Core developers
3# Distributed under the MIT software license, see the accompanying
4# file COPYING or http://www.opensource.org/licenses/mit-license.php.
5"""Combine logs from multiple bitcoin nodes as well as the test_framework log.
6
7This streams the combined log output to stdout. Use combine_logs.py > outputfile
8to write to an outputfile.
9
10If no argument is provided, the most recent test directory will be used."""
11
12import argparse
13from collections import defaultdict, namedtuple
14import heapq
15import itertools
16import os
17import pathlib
18import re
19import sys
20import tempfile
21
22# N.B.: don't import any local modules here - this script must remain executable
23# without the parent module installed.
24
25# Should match same symbol in `test_framework.test_framework`.
26TMPDIR_PREFIX = "bitcoin_func_test_"
27
28# Matches on the date format at the start of the log event
29TIMESTAMP_PATTERN = re.compile(r"^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{6})?Z")
30
31LogEvent = namedtuple('LogEvent', ['timestamp', 'source', 'event'])
32
33def main():
34    """Main function. Parses args, reads the log files and renders them as text or html."""
35    parser = argparse.ArgumentParser(
36        description=__doc__, formatter_class=argparse.RawTextHelpFormatter)
37    parser.add_argument(
38        'testdir', nargs='?', default='',
39        help=('temporary test directory to combine logs from. '
40              'Defaults to the most recent'))
41    parser.add_argument('-c', '--color', dest='color', action='store_true', help='outputs the combined log with events colored by source (requires posix terminal colors. Use less -r for viewing)')
42    parser.add_argument('--html', dest='html', action='store_true', help='outputs the combined log as html. Requires jinja2. pip install jinja2')
43    args = parser.parse_args()
44
45    if args.html and args.color:
46        print("Only one out of --color or --html should be specified")
47        sys.exit(1)
48
49    testdir = args.testdir or find_latest_test_dir()
50
51    if not testdir:
52        print("No test directories found")
53        sys.exit(1)
54
55    if not args.testdir:
56        print("Opening latest test directory: {}".format(testdir), file=sys.stderr)
57
58    colors = defaultdict(lambda: '')
59    if args.color:
60        colors["test"] = "\033[0;36m"  # CYAN
61        colors["node0"] = "\033[0;34m"  # BLUE
62        colors["node1"] = "\033[0;32m"  # GREEN
63        colors["node2"] = "\033[0;31m"  # RED
64        colors["node3"] = "\033[0;33m"  # YELLOW
65        colors["reset"] = "\033[0m"  # Reset font color
66
67    log_events = read_logs(testdir)
68
69    if args.html:
70        print_logs_html(log_events)
71    else:
72        print_logs_plain(log_events, colors)
73        print_node_warnings(testdir, colors)
74
75
76def read_logs(tmp_dir):
77    """Reads log files.
78
79    Delegates to generator function get_log_events() to provide individual log events
80    for each of the input log files."""
81
82    # Find out what the folder is called that holds node 0's debug.log file
83    debug_logs = list(pathlib.Path(tmp_dir).glob('node0/**/debug.log'))
84    match len(debug_logs):
85        case 0:
86            chain = 'regtest'  # fallback to regtest
87        case 1:
88            chain = re.search(r'node0/(.+?)/debug\.log$', debug_logs[0].as_posix()).group(1)
89        case _:
90            raise RuntimeError('Max one debug.log is supported, found several:\n\t' +
91                               '\n\t'.join(map(str, debug_logs)))
92
93    files = [("test", "%s/test_framework.log" % tmp_dir)]
94    for i in itertools.count():
95        logfile = "{}/node{}/{}/debug.log".format(tmp_dir, i, chain)
96        if not os.path.isfile(logfile):
97            break
98        files.append(("node%d" % i, logfile))
99
100    return heapq.merge(*[get_log_events(source, f) for source, f in files])
101
102
103def print_node_warnings(tmp_dir, colors):
104    """Print nodes' errors and warnings"""
105
106    warnings = []
107    for stream in ['stdout', 'stderr']:
108        for i in itertools.count():
109            folder = "{}/node{}/{}".format(tmp_dir, i, stream)
110            if not os.path.isdir(folder):
111                break
112            for (_, _, fns) in os.walk(folder):
113                for fn in fns:
114                    warning = pathlib.Path('{}/{}'.format(folder, fn)).read_text().strip()
115                    if warning:
116                        warnings.append(("node{} {}".format(i, stream), warning))
117
118    print()
119    for w in warnings:
120        print("{} {} {} {}".format(colors[w[0].split()[0]], w[0], w[1], colors["reset"]))
121
122
123def find_latest_test_dir():
124    """Returns the latest tmpfile test directory prefix."""
125    tmpdir = tempfile.gettempdir()
126
127    def join_tmp(basename):
128        return os.path.join(tmpdir, basename)
129
130    def is_valid_test_tmpdir(basename):
131        fullpath = join_tmp(basename)
132        return (
133            os.path.isdir(fullpath)
134            and basename.startswith(TMPDIR_PREFIX)
135            and os.access(fullpath, os.R_OK)
136        )
137
138    testdir_paths = [
139        join_tmp(name) for name in os.listdir(tmpdir) if is_valid_test_tmpdir(name)
140    ]
141
142    return max(testdir_paths, key=os.path.getmtime) if testdir_paths else None
143
144
145def get_log_events(source, logfile):
146    """Generator function that returns individual log events.
147
148    Log events may be split over multiple lines. We use the timestamp
149    regex match as the marker for a new log event."""
150    try:
151        with open(logfile, 'r') as infile:
152            event = ''
153            timestamp = ''
154            for line in infile:
155                # skip blank lines
156                if line == '\n':
157                    continue
158                # if this line has a timestamp, it's the start of a new log event.
159                time_match = TIMESTAMP_PATTERN.match(line)
160                if time_match:
161                    if event:
162                        yield LogEvent(timestamp=timestamp, source=source, event=event.rstrip())
163                    timestamp = time_match.group()
164                    if time_match.group(1) is None:
165                        # timestamp does not have microseconds. Add zeroes.
166                        timestamp_micro = timestamp.replace("Z", ".000000Z")
167                        line = line.replace(timestamp, timestamp_micro)
168                        timestamp = timestamp_micro
169                    event = line
170                # if it doesn't have a timestamp, it's a continuation line of the previous log.
171                else:
172                    # Add the line. Prefix with space equivalent to the source + timestamp so log lines are aligned
173                    event += "                                   " + line
174            # Flush the final event
175            yield LogEvent(timestamp=timestamp, source=source, event=event.rstrip())
176    except FileNotFoundError:
177        print("File %s could not be opened. Continuing without it." % logfile, file=sys.stderr)
178
179
180def print_logs_plain(log_events, colors):
181    """Renders the iterator of log events into text."""
182    for event in log_events:
183        lines = event.event.splitlines()
184        print("{0} {1: <5} {2} {3}".format(colors[event.source.rstrip()], event.source, lines[0], colors["reset"]))
185        if len(lines) > 1:
186            for line in lines[1:]:
187                print("{0}{1}{2}".format(colors[event.source.rstrip()], line, colors["reset"]))
188
189
190def print_logs_html(log_events):
191    """Renders the iterator of log events into html."""
192    try:
193        import jinja2 #type:ignore
194    except ImportError:
195        print("jinja2 not found. Try `pip install jinja2`")
196        sys.exit(1)
197    print(jinja2.Environment(loader=jinja2.FileSystemLoader('./'))
198                    .get_template('combined_log_template.html')
199                    .render(title="Combined Logs from testcase", log_events=[event._asdict() for event in log_events]))
200
201
202if __name__ == '__main__':
203    main()
204

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/init.cpp

src/crypto/sha256.cpp

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/util/chaintype.cpp

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/net_permissions.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/rpc/util.h

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/util/rbf.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/any.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

src/clientversion.cpp

src/common/signmessage.cpp

src/compat/assumptions.h

src/compat/byteswap.h

src/deploymentinfo.cpp

src/deploymentinfo.h

src/deploymentstatus.cpp

src/deploymentstatus.h

src/dummywallet.cpp

src/external_signer.h

src/init/bitcoin-gui.cpp

src/init/bitcoin-node.cpp

src/init/bitcoin-qt.cpp

src/init/bitcoin-wallet.cpp

src/init/bitcoind.cpp

src/init/common.h

src/interfaces/init.h

src/interfaces/ipc.h

src/key_io.h

src/logging/categories.h

src/logging/timer.h

src/mapport.h

src/musig.h

src/net_permissions.h

src/netgroup.h

src/netmessagemaker.h

src/node/chainstatemanager_args.cpp

src/node/connection_types.h

src/node/context.h

src/node/interface_ui.h

src/node/mempool_args.cpp

src/node/mining_args.cpp

src/node/minisketchwrapper.cpp

src/node/txreconciliation.h

src/policy/fees/estimator_args.cpp

src/policy/fees/estimator_args.h

src/policy/fees/estimator_man.cpp

src/policy/fees/estimator_man.h

src/policy/packages.h

src/policy/rbf.h

src/policy/truc_policy.h

src/pow.h

src/primitives/block.cpp

src/randomenv.h

src/rest.h

src/script/keyorigin.h

src/script/parsing.cpp

src/script/parsing.h

src/script/script_error.h

src/script/sigcache.cpp

src/script/sigcache.h

src/script/solver.h

src/script/verify_flags.h

src/semaphore_grant.h

src/signet.h

src/span.h

src/support/allocators/secure.h

src/support/allocators/zeroafterfree.h

src/util/tokenpipe.cpp

src/util/translation.h

src/util/vector.h

src/versionbits.h

src/versionbits_impl.h

src/wallet/external_signer_scriptpubkeyman.h

src/wallet/fees.h

src/wallet/load.h

src/wallet/receive.h

src/wallet/rpc/wallet.h

src/wallet/types.h

src/walletinitinterface.h

src/zmq/zmqabstractnotifier.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.