TeaSpeak/spdlog
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Gabi Melman 2018-07-17 15:13:31 +03:00 committed by GitHub
parent 51c851ce3d
commit 58f244a003
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -77,6 +77,8 @@ async... Elapsed: 0.449768 2,223,369/sec
``` ```
## Usage ## Usage
#### Terminal logging
```c++ ```c++
#include "spdlog/spdlog.h" #include "spdlog/spdlog.h"
#include "spdlog/sinks/stdout_color_sinks.h" #include "spdlog/sinks/stdout_color_sinks.h"
@ -115,7 +117,8 @@ void stdout_example()
SPDLOG_DEBUG(console, "Enabled only #ifdef SPDLOG_DEBUG_ON.. {} ,{}", 1, 3.23); SPDLOG_DEBUG(console, "Enabled only #ifdef SPDLOG_DEBUG_ON.. {} ,{}", 1, 3.23);
} }
``` ```
#### Basic file logger
#### Simple file logger
```c++ ```c++
#include "spdlog/sinks/basic_file_sink.h" #include "spdlog/sinks/basic_file_sink.h"
void basic_logfile_example() void basic_logfile_example()
@ -132,7 +135,8 @@ void basic_logfile_example()
} }
} }
``` ```
#### Rotating example
#### Rotating files
```c++ ```c++
#include "spdlog/sinks/rotating_file_sink.h" #include "spdlog/sinks/rotating_file_sink.h"
void rotating_example() void rotating_example()
@ -141,7 +145,7 @@ void rotating_example()
auto rotating_logger = spdlog::rotating_logger_mt("some_logger_name", "logs/rotating.txt", 1048576 * 5, 3); auto rotating_logger = spdlog::rotating_logger_mt("some_logger_name", "logs/rotating.txt", 1048576 * 5, 3);
} }
``` ```
#### Daily file example #### Daily files
```c++ ```c++
#include "spdlog/sinks/daily_file_sink.h" #include "spdlog/sinks/daily_file_sink.h"
@ -152,9 +156,9 @@ void daily_example()
} }
``` ```
#### Asynchronous example
```c++
#### Asynchronous logging
```c++
#include "spdlog/async.h" #include "spdlog/async.h"
void async_example() void async_example()
{ {
@ -171,7 +175,8 @@ void async_example()
} }
``` ```
#### Multi sink
#### Multi sink with different formatting per target
```c++ ```c++
// create logger with 2 targets with different log levels and formats. // create logger with 2 targets with different log levels and formats.
@ -191,7 +196,8 @@ void multi_sink_example()
logger.info("this message should not appear in the console, only in the file"); logger.info("this message should not appear in the console, only in the file");
} }
``` ```
#### User defined types logging
#### User defined types
```c++ ```c++
// user defined types logging by implementing operator<< // user defined types logging by implementing operator<<
#include "spdlog/fmt/ostr.h" // must be included #include "spdlog/fmt/ostr.h" // must be included
@ -211,6 +217,7 @@ void user_defined_example()
} }
``` ```
#### Custom error handler #### Custom error handler
```c++ ```c++
void err_handler_example() void err_handler_example()
@ -221,7 +228,8 @@ void err_handler_example()
} }
``` ```
#### syslog example
#### syslog
```c++ ```c++
#include "spdlog/sinks/syslog_sink.h" #include "spdlog/sinks/syslog_sink.h"
void syslog_example() void syslog_example()