[#BCLog]
= BCLog
:mrdocs:

Bitcoin Core logging facilities: log categories and their bit flags.

== Types

[cols="1,4"]
|===
| Name| Description
| xref:BCLog/LogRateLimiter.adoc[`LogRateLimiter`] 
| Fixed window rate limiter for logging.
| xref:BCLog/Logger.adoc[`Logger`] 
| Central logger that formats entries and writes them to the console, a file and callbacks.
| xref:BCLog/Timer.adoc[`Timer`] 
| RAII‐style object that outputs timing information to logs.
|===


== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BCLog/CategoryMask.adoc[`CategoryMask`] 
| Bit mask holding a set of BCLog::LogFlags log categories.
| xref:BCLog/Level.adoc[`Level`] 
| Alias for compatibility. Prefer util::log::Level over BCLog::Level in new code.
|===


== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BCLog/LogFlags.adoc[`LogFlags`] 
| Debug logging categories, each a distinct bit in a CategoryMask.
|===


== Variables

[cols="1,4"]
|===
| Name| Description
| xref:BCLog/DEFAULT_LOGRATELIMIT.adoc[`DEFAULT_LOGRATELIMIT`] 
| Default for whether log rate limiting is enabled.
| xref:BCLog/DEFAULT_LOG_LEVEL.adoc[`DEFAULT_LOG_LEVEL`] 
| Default global log severity level.
| xref:BCLog/DEFAULT_MAX_LOG_BUFFER.adoc[`DEFAULT_MAX_LOG_BUFFER`] 
| buffer up to 1MB of log data prior to StartLogging
| xref:BCLog/RATELIMIT_MAX_BYTES.adoc[`RATELIMIT_MAX_BYTES`] 
| maximum number of bytes per source location that can be logged within the rate‐limit window
| xref:BCLog/RATELIMIT_WINDOW.adoc[`RATELIMIT_WINDOW`] 
| time window after which log ratelimit stats are reset
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#