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.

5,434 bytes · SHA-256 0ced67f28ef0d3c1… · 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"""Test debug logging."""
6
7import os
8
9from test_framework.test_framework import BitcoinTestFramework
10from test_framework.p2p import P2PInterface
11from test_framework.test_node import ErrorMatch
12
13
14class LoggingTest(BitcoinTestFramework):
15    def set_test_params(self):
16        self.num_nodes = 1
17        self.setup_clean_chain = True
18
19    def relative_log_path(self, name):
20        return os.path.join(self.nodes[0].chain_path, name)
21
22    def run_test(self):
23        # test default log file name
24        default_log_path = self.relative_log_path("debug.log")
25        assert os.path.isfile(default_log_path)
26
27        # test alternative log file name in datadir
28        self.restart_node(0, ["-debuglogfile=foo.log"])
29        assert os.path.isfile(self.relative_log_path("foo.log"))
30
31        # test alternative log file name outside datadir
32        tempname = os.path.join(self.options.tmpdir, "foo.log")
33        self.restart_node(0, [f"-debuglogfile={tempname}"])
34        assert os.path.isfile(tempname)
35
36        # check that invalid log (relative) will cause error
37        invdir = self.relative_log_path("foo")
38        invalidname = os.path.join("foo", "foo.log")
39        self.stop_node(0)
40        exp_stderr = "Error: Could not open debug log file "
41        self.nodes[0].assert_start_raises_init_error([f"-debuglogfile={invalidname}"], exp_stderr, match=ErrorMatch.PARTIAL_REGEX)
42        assert not os.path.isfile(os.path.join(invdir, "foo.log"))
43
44        # check that invalid log (relative) works after path exists
45        self.stop_node(0)
46        os.mkdir(invdir)
47        self.start_node(0, [f"-debuglogfile={invalidname}"])
48        assert os.path.isfile(os.path.join(invdir, "foo.log"))
49
50        # check that invalid log (absolute) will cause error
51        self.stop_node(0)
52        invdir = os.path.join(self.options.tmpdir, "foo")
53        invalidname = os.path.join(invdir, "foo.log")
54        self.nodes[0].assert_start_raises_init_error([f"-debuglogfile={invalidname}"], exp_stderr, match=ErrorMatch.PARTIAL_REGEX)
55        assert not os.path.isfile(os.path.join(invdir, "foo.log"))
56
57        # check that invalid log (absolute) works after path exists
58        self.stop_node(0)
59        os.mkdir(invdir)
60        self.start_node(0, [f"-debuglogfile={invalidname}"])
61        assert os.path.isfile(os.path.join(invdir, "foo.log"))
62
63        # check that -nodebuglogfile disables logging
64        self.stop_node(0)
65        os.unlink(default_log_path)
66        assert not os.path.isfile(default_log_path)
67        self.start_node(0, ["-nodebuglogfile"])
68        assert not os.path.isfile(default_log_path)
69
70        # just sanity check no crash here
71        self.restart_node(0, [f"-debuglogfile={os.devnull}"])
72
73        self.log.info("Test -debug and -debugexclude raise when invalid values are passed")
74        self.stop_node(0)
75        self.nodes[0].assert_start_raises_init_error(
76            extra_args=["-debug=abc"],
77            expected_msg="Error: Unsupported logging category -debug=abc.",
78            match=ErrorMatch.FULL_REGEX,
79        )
80        self.nodes[0].assert_start_raises_init_error(
81            extra_args=["-debugexclude=abc"],
82            expected_msg="Error: Unsupported logging category -debugexclude=abc.",
83            match=ErrorMatch.FULL_REGEX,
84        )
85
86        self.log.info("Test -loglevel raises when invalid values are passed")
87        self.nodes[0].assert_start_raises_init_error(
88            extra_args=["-loglevel=abc"],
89            expected_msg="Error: Unsupported global logging level -loglevel=abc. Valid values: info, debug, trace.",
90            match=ErrorMatch.FULL_REGEX,
91        )
92        self.nodes[0].assert_start_raises_init_error(
93            extra_args=["-loglevel=net:abc"],
94            expected_msg="Error: Unsupported category-specific logging level -loglevel=net:abc.",
95            match=ErrorMatch.PARTIAL_REGEX,
96        )
97        self.nodes[0].assert_start_raises_init_error(
98            extra_args=["-loglevel=net:info:abc"],
99            expected_msg="Error: Unsupported category-specific logging level -loglevel=net:info:abc.",
100            match=ErrorMatch.PARTIAL_REGEX,
101        )
102
103        self.log.info("Test that -nodebug,-debug=0,-debug=none clear previously specified debug options")
104        disable_debug_options = [
105            '-debug=0',
106            '-debug=none',
107            '-nodebug'
108        ]
109
110        for disable_debug_opt in disable_debug_options:
111            # Every category before disable_debug_opt will be ignored, including the invalid 'abc'
112            self.restart_node(0, ['-debug=http', '-debug=abc', disable_debug_opt, '-debug=rpc', '-debug=net'])
113            logging = self.nodes[0].logging()
114            assert not logging['http']
115            assert 'abc' not in logging
116            assert logging['rpc']
117            assert logging['net']
118
119        self.log.info("Test -logips formatting in net logs")
120        self.restart_node(0, ['-debug=net', '-logips=1'])
121        with self.nodes[0].assert_debug_log(["peer=0, peeraddr="]):
122            p2p = self.nodes[0].add_p2p_connection(P2PInterface())
123            p2p.wait_for_verack()
124            self.nodes[0].disconnect_p2ps()
125
126if __name__ == '__main__':
127    LoggingTest(__file__).main()
128

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.