BCLog Namespace Reference

Classes
class	Logger
class	LogRateLimiter
	Fixed window rate limiter for logging. More...
class	Timer
	RAII-style object that outputs timing information to logs. More...

Typedefs
using	CategoryMask = uint64_t
using	Level = util::log::Level
	Alias for compatibility. Prefer util::log::Level over BCLog::Level in new code. More...

Enumerations
enum	LogFlags : CategoryMask {   NONE = CategoryMask{0} , NET = (CategoryMask{1} << 0) , TOR = (CategoryMask{1} << 1) , MEMPOOL = (CategoryMask{1} << 2) ,   HTTP = (CategoryMask{1} << 3) , BENCH = (CategoryMask{1} << 4) , ZMQ = (CategoryMask{1} << 5) , WALLETDB = (CategoryMask{1} << 6) ,   RPC = (CategoryMask{1} << 7) , ESTIMATEFEE = (CategoryMask{1} << 8) , ADDRMAN = (CategoryMask{1} << 9) , SELECTCOINS = (CategoryMask{1} << 10) ,   REINDEX = (CategoryMask{1} << 11) , CMPCTBLOCK = (CategoryMask{1} << 12) , RAND = (CategoryMask{1} << 13) , PRUNE = (CategoryMask{1} << 14) ,   PROXY = (CategoryMask{1} << 15) , MEMPOOLREJ = (CategoryMask{1} << 16) , COINDB = (CategoryMask{1} << 17) , QT = (CategoryMask{1} << 18) ,   LEVELDB = (CategoryMask{1} << 19) , VALIDATION = (CategoryMask{1} << 20) , I2P = (CategoryMask{1} << 21) , IPC = (CategoryMask{1} << 22) ,   BLOCKSTORAGE = (CategoryMask{1} << 24) , TXRECONCILIATION = (CategoryMask{1} << 25) , SCAN = (CategoryMask{1} << 26) , TXPACKAGES = (CategoryMask{1} << 27) ,   KERNEL = (CategoryMask{1} << 28) , PRIVBROADCAST = (CategoryMask{1} << 29) , MINING = (CategoryMask{1} << 30) , ALL = ~NONE }

Functions
std::string	LogEscapeMessage (std::string_view str)
	Belts and suspenders: make sure outgoing log messages don't contain potentially suspicious characters, such as terminal control codes. More...

Variables
constexpr auto	DEFAULT_LOG_LEVEL {Level::Debug}
constexpr size_t	DEFAULT_MAX_LOG_BUFFER {1'000'000}
constexpr uint64_t	RATELIMIT_MAX_BYTES {1_MiB}
constexpr auto	RATELIMIT_WINDOW {1h}
constexpr bool	DEFAULT_LOGRATELIMIT {true}

Typedef Documentation

CategoryMask

using BCLog::CategoryMask = typedef uint64_t

Definition at line 12 of file categories.h.

Level

using BCLog::Level = typedef util::log::Level

Alias for compatibility. Prefer util::log::Level over BCLog::Level in new code.

Definition at line 115 of file log.h.

Enumeration Type Documentation

LogFlags

enum BCLog::LogFlags : CategoryMask

Enumerator
NONE
NET
TOR
MEMPOOL
HTTP
BENCH
ZMQ
WALLETDB
RPC
ESTIMATEFEE
ADDRMAN
SELECTCOINS
REINDEX
CMPCTBLOCK
RAND
PRUNE
PROXY
MEMPOOLREJ
COINDB
QT
LEVELDB
VALIDATION
I2P
IPC
BLOCKSTORAGE
TXRECONCILIATION
SCAN
TXPACKAGES
KERNEL
PRIVBROADCAST
MINING
ALL

Definition at line 14 of file categories.h.

Function Documentation

LogEscapeMessage()

std::string BCLog::LogEscapeMessage

(

std::string_view

str

)

Belts and suspenders: make sure outgoing log messages don't contain potentially suspicious characters, such as terminal control codes.

This escapes control characters, including newline ('
'), in C syntax, so untrusted data can't forge log lines. It escapes instead of removes them to still allow for troubleshooting issues where they accidentally end up in strings.

Definition at line 340 of file logging.cpp.

Here is the caller graph for this function:

Variable Documentation

DEFAULT_LOG_LEVEL

constexpr auto BCLog::DEFAULT_LOG_LEVEL {Level::Debug}

inlineconstexpr

Definition at line 64 of file logging.h.

DEFAULT_LOGRATELIMIT

constexpr bool BCLog::DEFAULT_LOGRATELIMIT {true}

inlineconstexpr

Definition at line 68 of file logging.h.

DEFAULT_MAX_LOG_BUFFER

constexpr size_t BCLog::DEFAULT_MAX_LOG_BUFFER {1'000'000}

inlineconstexpr

Definition at line 65 of file logging.h.

RATELIMIT_MAX_BYTES

constexpr uint64_t BCLog::RATELIMIT_MAX_BYTES {1_MiB}

inlineconstexpr

Definition at line 66 of file logging.h.

RATELIMIT_WINDOW

constexpr auto BCLog::RATELIMIT_WINDOW {1h}

inlineconstexpr

Definition at line 67 of file logging.h.