mirror of
				https://github.com/XRPLF/clio.git
				synced 2025-11-04 11:55:51 +00:00 
			
		
		
		
	docs: Add log format description (#2461)
This commit is contained in:
		@@ -445,7 +445,23 @@ This document provides a list of all available Clio configuration properties in
 | 
			
		||||
- **Type**: string
 | 
			
		||||
- **Default value**: `%Y-%m-%d %H:%M:%S.%f %^%3!l:%n%$ - %v`
 | 
			
		||||
- **Constraints**: None
 | 
			
		||||
- **Description**: The format string for log messages using spdlog format patterns. Documentation can be found at: <https://github.com/gabime/spdlog/wiki/Custom-formatting>.
 | 
			
		||||
- **Description**: The format string for log messages using spdlog format patterns.
 | 
			
		||||
 | 
			
		||||
Each of the variables expands like so:
 | 
			
		||||
 | 
			
		||||
- `%Y-%m-%d %H:%M:%S.%f`: The full date and time of the log entry with microsecond precision
 | 
			
		||||
- `%^`: Start color range
 | 
			
		||||
- `%3!l`: The severity (aka log level) the entry was sent at stripped to 3 characters
 | 
			
		||||
- `%n`: The logger name (channel) that this log entry was sent to
 | 
			
		||||
- `%$`: End color range
 | 
			
		||||
- `%v`: The actual log message
 | 
			
		||||
 | 
			
		||||
Some additional variables that might be useful:
 | 
			
		||||
 | 
			
		||||
- `%@`: A partial path to the C++ file and the line number in the said file (`src/file/path:linenumber`)
 | 
			
		||||
- `%t`: The ID of the thread the log entry is written from
 | 
			
		||||
 | 
			
		||||
Documentation can be found at: <https://github.com/gabime/spdlog/wiki/Custom-formatting>.
 | 
			
		||||
 | 
			
		||||
### log.is_async
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user