Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/2004seraph/cyanlogger
A C++17 logging library
https://github.com/2004seraph/cyanlogger
library logging toy-project
Last synced: about 1 month ago
JSON representation
A C++17 logging library
- Host: GitHub
- URL: https://github.com/2004seraph/cyanlogger
- Owner: 2004seraph
- License: mpl-2.0
- Created: 2022-08-17T06:49:35.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-12T18:27:27.000Z (10 months ago)
- Last Synced: 2024-04-21T11:48:10.701Z (9 months ago)
- Topics: library, logging, toy-project
- Language: C++
- Homepage:
- Size: 1.22 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CyanLogger
This is a C++17 single-header logging library made for my personal use, but you can use it if you want! It helps me to standardise my console messages which results in a much cleaner console output.
## How to use
Include the header and instantiate a logger class. The main method will be `Logger::Output`, it can take these arguments:
- (string) An error type to indicate the level of severity of the message
- (string) A program module path, for example if your renderer fails to extract a texture from the texture atlas, you would output an error with this module path: "MYENGINE::RENDERER::TEXTURECROP"
- Finally, the error message itself
```cpp
#include "CyanLogger.hpp"
#include
int main(int argc, char* argv[]) {
cyan::Logger log;
log.Output(cyan::Logger::INFO, "main", "Hello world");
log.Output("This program is useless!");
try {
//will cause an exception
int x = std::any_cast(std::any("apple"));
} catch (...) {
log.Output(cyan::Errors::INFO, "main::stupidexample", "Inevitable error");
}
return 0;
}
```
This will output:
```shell
11:29:34 [Info]: {main} - Hello world
11:29:34 [Info]: {Anonymous} - This program is useless!
11:29:34 [Info]: {main::stupidexample} - Inevitable error
```
### Customizing the output format
The message output format can be changed by supplying a schema string to either the logger constructor or with the `Logger::SetSchema` method:
The schema placeholders are:
- %t = Current time (hh::mm::ss), The logging class makes its method public so that you may also get a time string for your own uses: `Logger::GetTimeString()`
- %y = Error type
- %m = Module path
- %o = The message itself
You can omit placeholders if you want as well.
```cpp
log.SetSchema("{%t}--%y===%o - End log");
```
This will change the output of the previous program to:
```shell
{11:37:29}--Info===Hello world - End log
{11:37:29}--Info===This program is useless! - End log
{11:37:29}--Info===Inevitable error - End log
```
### Dumping history to file
All logger output messages are recorded in an std::list and this can be dumped to a file with the `Logger::SaveToFile` method:
```cpp
log.SaveToFile("log.txt");
//You can also give a path
log.SaveToFile("debug/log.txt");
```
You can clear the message history with `Logger::ClearMessageHistory()`.
You can also get the list of strings for yourself with `Logger::GetMessageHistory()`.
### Provided error types class
As seen in the provious examples, the class provides some const strings of error types for my convienince, while these are probably sufficient for most situations, you can always not include them by defining `cyanLog_NODEFAULTERRORS` before including `CyanLogger.hpp`.
```cpp
#define cyanLog_NODEFAULTERRORS
#include "CyanLogger.hpp"
int main(int argc, char* argv[]) {
cyan::Logger log;
//you may use your own system/convention of error types here.
log.Output("Output", "main", "Hello world");
}
```
## Building
This library uses CMake, you can use cmake-gui to build it like any other library, there are no special settings.