generic-library/g3log
1
0
Fork 0
mirror of https://github.com/KjellKod/g3log.git synced 2025-01-06 00:31:12 +01:00
Code Issues Projects Releases Wiki Activity

fixing up. introduction

Browse Source
This commit is contained in:
kjell@kjell-win7.hsd1.co.comcast.net. 2014-01-17 07:34:53 +01:00
parent cc554ff2cc
commit 342c8aefff
1 changed files with 10 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.markdown
View File

@ -1,4 +1,4 @@
# G3Log (text below is in progress) # G3log : Asynchronous logger with Dynamic Sinks
## EXAMPLE USAGE ## EXAMPLE USAGE
#### Optional to use either streaming or printf-like syntax #### Optional to use either streaming or printf-like syntax
@ -10,7 +10,6 @@ LOGF(WARNING, "Printf-style syntax is also %s", "available");
#### Conditional logging #### Conditional logging
int less = 1; int more = 2 int less = 1; int more = 2
LOG_IF(INFO, (less<more)) <<"If [true], then this text will be logged"; LOG_IF(INFO, (less<more)) <<"If [true], then this text will be logged";
@ -20,7 +19,6 @@ LOGF(WARNING, "Printf-style syntax is also %s", "available");
#### Design-by-Contract #### Design-by-Contract
*CHECK(false)* will trigger a "fatal" message. It will be logged, and then the *CHECK(false)* will trigger a "fatal" message. It will be logged, and then the
application will exit. application will exit.
@ -32,17 +30,15 @@ CHECK(less > more) << "CHECK(false) triggers a FATAL message");
## What G3Log is: ## What G3Log is:
* ***G3log*** is the acting name for the third version of g2log and it stands for ***g2log with dynamic sinks*** * ***G3log*** is the acting name for the third version of g2log and it stands for **g2log with dynamic sinks**
* G3log is an asynchronous, "crash-safe" logger. You can read more about it's use here [[g2log version]]( * G3log is an asynchronous, "crash-safe" logger. You can read more about it here [[g2log version]](
http://www.codeproject.com/Articles/288827/g2log-An-efficient-asynchronous-logger-using-Cplus) http://www.codeproject.com/Articles/288827/g2log-An-efficient-asynchronous-logger-using-Cplus)
## Benefits you get when using G3log ## ## Benefits you get when using G3log ##
1. Easy to use, clean syntax and blazingly fast logger. 1. Easy to use, clean syntax and blazingly fast logger.
2. All the slow log I/O disk access is done in a background thread. This ensures that the 2. All the slow log I/O disk access is done in a background thread. This ensures that the LOG caller can immediately continue with other tasks and do not have to wait for the LOG call to fínish.
other parts of the software can immediately continue with their work after making a
log entry.
3. G3log provides logging, Design-by-Contract [#CHECK], and flush of log to file at 3. G3log provides logging, Design-by-Contract [#CHECK], and flush of log to file at
shutdown. Buffered logs will be written to the sink before the application shuts down. shutdown. Buffered logs will be written to the sink before the application shuts down.
@ -64,17 +60,18 @@ The code is given for free as public domain. This gives the option to change, us
and do whatever with it, no strings attached. and do whatever with it, no strings attached.
9. Three versions of g2log exist. 9. Three versions of g2log exist.
* This version: g3log : which is made to faciliate easy adding of custom log receivers. * This version: *g3log* : which is made to faciliate easy adding of custom log receivers.
* [g2log-dev](https://bitbucket.org/KjellKod/g2log-dev): Acting as feature try-out and playground. * [g2log-dev](https://bitbucket.org/KjellKod/g2log-dev): Acting as feature try-out and playground.
* [g2log](https://bitbucket.org/KjellKod/g2log): The original. Simple, easy to modify and with the most OS support. Clients use g2log on environments such as OSX/Clang, Ubuntu, CentOS, Windows/mingw, Windows/Visual Studio. * *[g2log](https://bitbucket.org/KjellKod/g2log)*: The original. Simple, easy to modify and with the most OS support. Clients use g2log on environments such as OSX/Clang, Ubuntu, CentOS, Windows/mingw, Windows/Visual Studio.
# TO WRITE # G3log with sinks
* Example of how to use G2log [Sinks](http://en.wikipedia.org/wiki/Sink_(computing)) are receivers of LOG calls. G3log comes with a default sink (the same as G2log uses) that can be used to save log to file. A sink can be of *any* class type without restrictions as long as it can either recive a LOG message as a **std::string** *or* a **g2::LogMessageMover**. The **std::string** comes pre-formatted while the **g2::LogMessageMover** contains the raw data for custom handling in your own sink.
* Sinks easy to follow examples
# BUILDING g2log: # BUILDING g2log: