https://github.com/ayaankhan98/xlogger
xlogger is a simple header only logging provider for C++ applications. Using xlogger no need to worry about anything just copy the header file in your project include directory and start using it. xlogger provides facility for logging variables as well as l-values.
https://github.com/ayaankhan98/xlogger
console cpp file-logger library log logger logging logging-library makefile open-source
Last synced: about 1 year ago
JSON representation
xlogger is a simple header only logging provider for C++ applications. Using xlogger no need to worry about anything just copy the header file in your project include directory and start using it. xlogger provides facility for logging variables as well as l-values.
- Host: GitHub
- URL: https://github.com/ayaankhan98/xlogger
- Owner: ayaankhan98
- License: mit
- Created: 2021-12-28T04:37:40.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-05T18:24:57.000Z (over 4 years ago)
- Last Synced: 2025-02-06T03:40:00.051Z (over 1 year ago)
- Topics: console, cpp, file-logger, library, log, logger, logging, logging-library, makefile, open-source
- Language: C++
- Homepage:
- Size: 101 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xlogger
xlogger is a simple header only logging provider for C++ applications. Using
xlogger no need to worry about anything just copy the header file in your
project `include` directory and start using it. xlogger provides facility for
logging variables as well as l-values.
### Requirement
- C++17 or above
### Features
- [x] console based logging support with different log levels and colors
- [x] single file based logging support
- [x] thread safe logging
- [ ] multi file based logging
### Usage
- copy `xlogger.hpp` file and paste it into your project `include` directory.
- #### Available Logging Macros
- `INFO_X_LOG()`
- `DEBUG_X_LOG()`
- `WARN_X_LOG()`
- `CRITICAL_X_LOG()`
- `ERROR_X_LOG()`
- `FATAL_X_LOG()`
- #### Logging in Console
Console logger is enabled by default. Need not to do anything just initiate
the xlogger context and start using it. And at the end don't forget to
destroy xlogger context.
Code example:
```C++
#include
#include
#include
std::unordered_map fetch_from_server() {
std::unordered_map response;
response["username"] = "foo bar";
response["email"] = "foo@example.com";
response["dob"] = "10-10-1999";
return response;
}
int main() {
/// Initiate a xlogger context
xlogger::init_xlogger();
INFO_X_LOG("Welcome to xlogger");
const double PI = 3.145;
INFO_X_LOG("Value of PI = ", PI);
auto response = fetch_from_server();
DEBUG_X_LOG("Response from server: ", response);
/// Destroy the xlogger context before you exit
xlogger::destroy_xlogger();
return 0;
}
```
- #### Using a File logger
File logger can be used to preserve the logs on local disk.
code example:
```C++
#include
int main() {
/// pass the filepath of file in which you wish to preserve the logs.
xlogger::init_xlogger("log_0_file.xlog");
/// Log some stuff as usuall
INFO_X_LOG("Loggin information");
/// Destroy xlogger context
xlogger::destroy_xlogger();
}
```
if you wish to just use xlogger as file logger, you can disable console based
logging
```C++
xlogger::init_xlogger("log_0_file.xlog")->set_type_console(false);
```
- #### Using `xlogger` in Multithreading environment
xlogger provide thread safe logging. File logs and console logs are in sync.
code example:
```C++
#include
#include
void function1() {
for (int i = 0; i < 50; i++) {
INFO_X_LOG("Thread 1: i = ", i);
}
}
void function2() {
for (int i = 50; i < 100; i++) {
WARN_X_LOG("Thread 2: i = ", i);
}
}
int main() {
xlogger::init_xlogger("log_0_file.xlog");
std::thread t1(function1);
std::thread t2(function2);
for(int i = 100; i < 150; i++) {
ERROR_X_LOG("Thread Main: i = ", i);
}
t1.join();
t2.join();
xlogger::destroy_xlogger();
return 0;
}
```