History

Andrew Chow 7281fac2e0 Merge bitcoin/bitcoin#25614 : Severity-based logging, step 2 `9580480570` Update debug logging section in the developer notes (Jon Atack) `1abaa31aa3` Update -debug and -debugexclude help docs for severity level logging (Jon Atack) `45f9282162` Create BCLog::Level::Trace log severity level (Jon Atack) `2a8712db4f` Unit test coverage for -loglevel configuration option (klementtan) `eb7bee5f84` Create -loglevel configuration option (klementtan) `98a1f9c687` Unit test coverage for log severity levels (klementtan) `9c7507bf76` Create BCLog::Logger::LogLevelsString() helper function (klementtan) `8fe3457dbb` Update LogAcceptCategory() and unit tests with log severity levels (klementtan) `c2797cfc60` Add BCLog::Logger::SetLogLevel()/SetCategoryLogLevel() for string inputs (klementtan) `f6c0cc0350` Add BCLog::Logger::m_category_log_levels data member and getter/setter (Jon Atack) `2978b387bf` Add BCLog::Logger::m_log_level data member and getter/setter (Jon Atack) `f1379aeca9` Simplify BCLog::Level enum class and LogLevelToStr() function (Jon Atack) Pull request description: This is an updated version of https://github.com/bitcoin/bitcoin/pull/25287 and the next steps in parent PR #25203 implementing, with Klement Tan, user-configurable, per-category severity log levels based on an idea by John Newbery and refined in GitHub discussions by Wladimir Van der Laan and Marco Falke. - simplify the `BCLog::Level` enum class and the `LogLevelToStr()` function and add documentation - update the logging logic to filter logs by log level both globally and per-category - add a hidden `-loglevel` help-debug config option to allow testing setting the global or per-category severity level on startup for logging categories enabled with the `-debug` configuration option or the logging RPC (Klement Tan) - add a `trace` log severity level selectable by the user; the plan is for the current debug messages to become trace, LogPrint ones to become debug, and LogPrintf ones to become info, warning, or error ``` $ ./src/bitcoind -help-debug \| grep -A10 loglevel -loglevel=<level>\|<category>:<level> Set the global or per-category severity level for logging categories enabled with the -debug configuration option or the logging RPC: info, debug, trace (default=info); warning and error levels are always logged. If <category>:<level> is supplied, the setting will override the global one and may be specified multiple times to set multiple category-specific levels. <category> can be: addrman, bench, blockstorage, cmpctblock, coindb, estimatefee, http, i2p, ipc, leveldb, libevent, lock, mempool, mempoolrej, net, proxy, prune, qt, rand, reindex, rpc, selectcoins, tor, util, validation, walletdb, zmq. ``` See the individual commit messages for details. ACKs for top commit: jonatack: One final push per `git range-diff `a5d5569` ce3c4c9 9580480` (should be trivial to re-ACK) to ensure this pull changes no default behavior in any way for users or the tests/CI in order to be completely v24 compatible, to update the unit test setup in general, and to update the debug logging section in the developer notes. klementtan: reACK `9580480570` 1440000bytes: reACK `9580480570` vasild: ACK `9580480570` dunxen: reACK `9580480` brunoerg: reACK `9580480570` Tree-SHA512: 476a638e0581f40b5d058a9992691722e8b546471ec85e07cbc990798d1197fbffbd02e1b3d081b4978404e07a428378cdc8e159c0004b81f58be7fb01b7cba0		2 years ago
..
design	…
man	…
policy	[doc] remove non-signaling mentions of BIP125	2 years ago
release-notes	doc: Add a release note about the "restore wallet" menu item	2 years ago
.gitignore	…
Doxyfile.in	…
JSON-RPC-interface.md	…
README.md	Merge bitcoin/bitcoin#24352 : Add doc/design/libraries.md	2 years ago
README_doxygen.md	…
README_windows.txt	…
REST-interface.md	doc: add reference to `getrawmempool` RPC in `/mempool/contents` REST doc	3 years ago
assets-attribution.md	…
benchmarking.md	…
bips.md	…
bitcoin-conf.md	Security config warning	2 years ago
bitcoin_logo_doxygen.png	…
build-android.md	…
build-freebsd.md	doc: mention that BDB is for the legacy wallet in build-freebsd.md	3 years ago
build-netbsd.md	doc: update for NetBSD 9.2, add GUI Build Instructions	2 years ago
build-openbsd.md	doc: Fix command in "OpenBSD Build Guide"	2 years ago
build-osx.md	…
build-unix.md	doc: remove note on arm cross-compilation from build-unix.md	2 years ago
build-windows.md	…
cjdns.md	Add and improve informational links in doc/cjdns.md	3 years ago
dependencies.md	build: Bump Qt to 5.15.5 in depends	2 years ago
descriptors.md	doc: add `{import,list}descriptors` to list of descriptor RPCs	2 years ago
developer-notes.md	Update debug logging section in the developer notes	2 years ago
dnsseed-policy.md	…
external-signer.md	…
files.md	…
fuzzing.md	…
guix.md	…
i2p.md	doc: document I2P transient addresses usage in doc/i2p.md	2 years ago
init.md	…
managing-wallets.md	doc: Release notes and other docs for migration	2 years ago
multisig-tutorial.md	…
p2p-bad-ports.md	…
productivity.md	doc: add distcc to productivity notes	2 years ago
psbt.md	…
reduce-memory.md	…
reduce-traffic.md	…
release-notes-15936.md	Add release notes about unified bitcoin-qt and bitcoind persistent settings	2 years ago
release-notes-19602.md	doc: Release notes and other docs for migration	2 years ago
release-notes-24098.md	Add release notes	3 years ago
release-notes-24118.md	Add sendall RPC née sweep	3 years ago
release-notes-24148.md	Release notes for Miniscript support in P2WSH descriptors	2 years ago
release-notes-24198.md	…
release-notes-24494.md	[doc] release notes for random change target	3 years ago
release-notes-25355.md	doc: add release notes about the I2P transient addresses	2 years ago
release-notes-25504.md	doc: add releases notes for 25504 (listsinceblock updates)	2 years ago
release-notes-25610.md	doc: Release notes for default RBF	2 years ago
release-notes-empty-template.md	…
release-notes.md	Address comments remaining from #25353	2 years ago
release-process.md	Merge bitcoin/bitcoin#24424 : doc: release process chainparams updates	2 years ago
shared-libraries.md	…
tor.md	…
tracing.md	doc: document coin selection tracepoints	3 years ago
translation_process.md	…
translation_strings_policy.md	…
zmq.md	Update zmq.md: Fix parameter in hwm example block	2 years ago

README.md

Bitcoin Core

Setup

Bitcoin Core is the original Bitcoin client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Bitcoin transactions, which requires a few hundred gigabytes of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.

To download Bitcoin Core, visit bitcoincore.org.

Running

The following are some helpful notes on how to run Bitcoin Core on your native platform.

Unix

Unpack the files into a directory and run:

bin/bitcoin-qt (GUI) or
bin/bitcoind (headless)

Windows

Unpack the files into a directory, and then run bitcoin-qt.exe.

macOS

Drag Bitcoin Core to your applications folder, and then run Bitcoin Core.

Need Help?

See the documentation at the Bitcoin Wiki for help and more information.
Ask for help on Bitcoin StackExchange.
Ask for help on #bitcoin on Libera Chat. If you don't have an IRC client, you can use web.libera.chat.
Ask for help on the BitcoinTalk forums, in the Technical Support board.

Building

The following are developer notes on how to build Bitcoin Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.

Development

The Bitcoin repo's root README contains relevant information on the development process and automated testing.

Resources

Discuss on the BitcoinTalk forums, in the Development & Technical Discussion board.
Discuss project-specific development on #bitcoin-core-dev on Libera Chat. If you don't have an IRC client, you can use web.libera.chat.

Miscellaneous

License

Distributed under the MIT software license.