[#util-log]
= xref:util.adoc[util]::log
:relfileprefix: ../
:mrdocs:

Application&hyphen;agnostic logging interface shared across Bitcoin Core&period;

== Types

[cols="1,4"]
|===
| Name| Description
| xref:util/log/Entry.adoc[`Entry`] 
| A single log message together with its metadata&period;
| xref:util/log/NoRateLimitTag.adoc[`NoRateLimitTag`] 
| Structure and constant for tagging not to rate limit&period;
|===


== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:util/log/Category.adoc[`Category`] 
| Opaque to util&colon;&colon;log&semi; interpreted by consumers (e&period;g&period;, BCLog&colon;&colon;LogFlags)&period;
|===


== Enums

[cols="1,4"]
|===
| Name| Description
| xref:util/log/Level.adoc[`Level`] 
| Severity level of a log entry&period;
|===


== Functions

[cols="1,4"]
|===
| Name| Description
| xref:util/log/Log.adoc[`Log`] 
| Send message to be logged&period; Applications using the logging library need to provide this&period;
| xref:util/log/LogPrintFormatInternal-08.adoc[`LogPrintFormatInternal`] 
| `LogPrintFormatInternal` overloads
| xref:util/log/LogPrintFormatInternal_.adoc[`LogPrintFormatInternal&lowbar;`] 
| Format a log message and forward it to util&colon;&colon;log&colon;&colon;Log&period;
| xref:util/log/ShouldDebugLog.adoc[`ShouldDebugLog`] 
| Return whether messages with specified category should be debug logged&period; Applications using the logging library need to provide this&period;
| xref:util/log/ShouldTraceLog.adoc[`ShouldTraceLog`] 
| Return whether messages with specified category should be trace logged&period; Applications using the logging library need to provide this&period;
|===


== Variables

[cols="1,4"]
|===
| Name| Description
| xref:util/log/NO_RATE_LIMIT.adoc[`NO&lowbar;RATE&lowbar;LIMIT`] 
| Tag value passed to logging macros to opt out of rate limiting&period;
|===



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