mirror of
https://github.com/HardySimpson/zlog
synced 2025-03-28 21:13:21 +00:00
Update gitignore file
Refactor README Change makefile as Makefile
This commit is contained in:
Tu Duong Quyet
deemar
parent
96a2aa2502
commit
ec179780d1
219
.gitignore
vendored
219
.gitignore
vendored
@ -1,59 +1,168 @@
|
||||
.*
|
||||
!.gitignore
|
||||
# Created by https://www.toptal.com/developers/gitignore/api/linux,windows,macos,cmake,c++,c
|
||||
# Edit at https://www.toptal.com/developers/gitignore?templates=linux,windows,macos,cmake,c++,c
|
||||
|
||||
### C ###
|
||||
# Prerequisites
|
||||
*.d
|
||||
|
||||
# Object files
|
||||
*.o
|
||||
*.lo
|
||||
*.la
|
||||
*.gcda
|
||||
*.gcno
|
||||
aclocal.m4
|
||||
autom4te.cache
|
||||
build
|
||||
compile
|
||||
config.guess
|
||||
config.h
|
||||
config.h.in
|
||||
config.h.in~
|
||||
config.log
|
||||
config.status
|
||||
config.sub
|
||||
configure
|
||||
depcomp
|
||||
.deps
|
||||
install-sh
|
||||
.libs
|
||||
libtool
|
||||
libzlog.so*
|
||||
libzlog.a*
|
||||
ltmain.sh
|
||||
Makefile
|
||||
Makefile.in
|
||||
missing
|
||||
stamp-h1
|
||||
tags
|
||||
TAGS
|
||||
zlog-chk-conf
|
||||
zlog-*.tar.gz
|
||||
zlog.pc
|
||||
callgrind*
|
||||
err.log
|
||||
test_*
|
||||
!test_*.c
|
||||
!test_*.conf
|
||||
!test_*.h
|
||||
doc/*.lyx~
|
||||
doc/*.pdf
|
||||
doc/obj.think
|
||||
doc/zlog.3
|
||||
doc/zlogtest.xls
|
||||
doc/*.haux
|
||||
doc/*.html
|
||||
doc/*.htoc
|
||||
doc/*.tex
|
||||
test/press*
|
||||
test/*.png
|
||||
cscope*
|
||||
release.h
|
||||
*.pyc
|
||||
*.ko
|
||||
*.obj
|
||||
*.elf
|
||||
|
||||
# Linker output
|
||||
*.ilk
|
||||
*.map
|
||||
*.exp
|
||||
|
||||
# Precompiled Headers
|
||||
*.gch
|
||||
*.pch
|
||||
|
||||
# Libraries
|
||||
*.lib
|
||||
*.a
|
||||
*.la
|
||||
*.lo
|
||||
|
||||
# Shared objects (inc. Windows DLLs)
|
||||
*.dll
|
||||
*.so
|
||||
*.so.*
|
||||
*.dylib
|
||||
|
||||
# Executables
|
||||
*.exe
|
||||
*.out
|
||||
*.app
|
||||
*.i*86
|
||||
*.x86_64
|
||||
*.hex
|
||||
|
||||
# Debug files
|
||||
*.dSYM/
|
||||
*.su
|
||||
*.idb
|
||||
*.pdb
|
||||
|
||||
# Kernel Module Compile Results
|
||||
*.mod*
|
||||
*.cmd
|
||||
.tmp_versions/
|
||||
modules.order
|
||||
Module.symvers
|
||||
Mkfile.old
|
||||
dkms.conf
|
||||
|
||||
### C++ ###
|
||||
# Prerequisites
|
||||
|
||||
# Compiled Object files
|
||||
*.slo
|
||||
|
||||
# Precompiled Headers
|
||||
|
||||
# Compiled Dynamic libraries
|
||||
|
||||
# Fortran module files
|
||||
*.mod
|
||||
*.smod
|
||||
|
||||
# Compiled Static libraries
|
||||
*.lai
|
||||
|
||||
# Executables
|
||||
|
||||
### CMake ###
|
||||
CMakeLists.txt.user
|
||||
CMakeCache.txt
|
||||
CMakeFiles
|
||||
CMakeScripts
|
||||
Testing
|
||||
Makefile
|
||||
cmake_install.cmake
|
||||
install_manifest.txt
|
||||
compile_commands.json
|
||||
CTestTestfile.cmake
|
||||
_deps
|
||||
|
||||
### CMake Patch ###
|
||||
# External projects
|
||||
*-prefix/
|
||||
|
||||
### Linux ###
|
||||
*~
|
||||
|
||||
# temporary files which can be created if a process still has a handle open of a deleted file
|
||||
.fuse_hidden*
|
||||
|
||||
# KDE directory preferences
|
||||
.directory
|
||||
|
||||
# Linux trash folder which might appear on any partition or disk
|
||||
.Trash-*
|
||||
|
||||
# .nfs files are created when an open file is removed but is still being accessed
|
||||
.nfs*
|
||||
|
||||
### macOS ###
|
||||
# General
|
||||
.DS_Store
|
||||
.AppleDouble
|
||||
.LSOverride
|
||||
|
||||
# Icon must end with two \r
|
||||
Icon
|
||||
|
||||
|
||||
# Thumbnails
|
||||
._*
|
||||
|
||||
# Files that might appear in the root of a volume
|
||||
.DocumentRevisions-V100
|
||||
.fseventsd
|
||||
.Spotlight-V100
|
||||
.TemporaryItems
|
||||
.Trashes
|
||||
.VolumeIcon.icns
|
||||
.com.apple.timemachine.donotpresent
|
||||
|
||||
# Directories potentially created on remote AFP share
|
||||
.AppleDB
|
||||
.AppleDesktop
|
||||
Network Trash Folder
|
||||
Temporary Items
|
||||
.apdisk
|
||||
|
||||
### macOS Patch ###
|
||||
# iCloud generated files
|
||||
*.icloud
|
||||
|
||||
### Windows ###
|
||||
# Windows thumbnail cache files
|
||||
Thumbs.db
|
||||
Thumbs.db:encryptable
|
||||
ehthumbs.db
|
||||
ehthumbs_vista.db
|
||||
|
||||
# Dump file
|
||||
*.stackdump
|
||||
|
||||
# Folder config file
|
||||
[Dd]esktop.ini
|
||||
|
||||
# Recycle Bin used on file shares
|
||||
$RECYCLE.BIN/
|
||||
|
||||
# Windows Installer files
|
||||
*.cab
|
||||
*.msi
|
||||
*.msix
|
||||
*.msm
|
||||
*.msp
|
||||
|
||||
# Windows shortcuts
|
||||
*.lnk
|
||||
|
||||
# End of https://www.toptal.com/developers/gitignore/api/linux,windows,macos,cmake,c++,c
|
||||
175
README.md
175
README.md
@ -1,121 +1,132 @@
|
||||
0. What is zlog?
|
||||
-------------
|
||||
# zlog
|
||||
|
||||
zlog is a reliable, high-performance, thread safe, flexible, clear-model, pure C logging library.
|
||||
|
||||
Actually, in the C world there was NO good logging library for applications like logback in java or log4cxx in c++. Using printf can work, but can not be redirected or reformatted easily. syslog is slow and is designed for system use.
|
||||
So I wrote zlog.
|
||||
It is faster, safer and more powerful than log4c. So it can be widely used.
|
||||
Actually, in the C world there was NO good logging library for applications like logback in java or log4cxx in c++. Using printf can work, but can not be redirected or reformatted easily. syslog is slow and is designed for system use.
|
||||
So I wrote zlog.
|
||||
It is faster, safer and more powerful than log4c. So it can be widely used.
|
||||
|
||||
1. Install
|
||||
-------------
|
||||
## 1. Install
|
||||
|
||||
Downloads: https://github.com/HardySimpson/zlog/releases
|
||||
Downloads: <https://github.com/HardySimpson/zlog/releases>
|
||||
|
||||
$ tar -zxvf zlog-latest-stable.tar.gz
|
||||
$ cd zlog-latest-stable/
|
||||
$ make
|
||||
$ sudo make install
|
||||
|
||||
or
|
||||
```bash
|
||||
tar -zxvf zlog-latest-stable.tar.gz
|
||||
cd zlog-latest-stable/
|
||||
make
|
||||
sudo make install
|
||||
```
|
||||
|
||||
$ make PREFIX=/usr/local/
|
||||
$ sudo make PREFIX=/usr/local/ install
|
||||
Or
|
||||
|
||||
```bash
|
||||
make PREFIX=/usr/local/
|
||||
sudo make PREFIX=/usr/local/ install
|
||||
```
|
||||
|
||||
PREFIX indicates the installation destination for zlog. After installation, refresh your dynamic linker to make sure your program can find zlog library.
|
||||
|
||||
$ sudo vi /etc/ld.so.conf
|
||||
/usr/local/lib
|
||||
$ sudo ldconfig
|
||||
```bash
|
||||
$ sudo vi /etc/ld.so.conf
|
||||
/usr/local/lib
|
||||
$ sudo ldconfig
|
||||
```
|
||||
|
||||
Before running a real program, make sure libzlog.so is in the directory where the system's dynamic lib loader can find it. The command metioned above are for linux. Other systems will need a similar set of actions.
|
||||
|
||||
|
||||
2. Introduce configure file
|
||||
-------------
|
||||
## 2. Configuration file
|
||||
|
||||
There are 3 important concepts in zlog: categories, formats and rules.
|
||||
|
||||
Categories specify different kinds of log entries. In the zlog source code, category is a (zlog_cateogory_t *) variable. In your program, different categories for the log entries will distinguish them from each other.
|
||||
Categories specify different kinds of log entries. In the zlog source code, category is a `zlog_cateogory_t *` variable. In your program, different categories for the log entries will distinguish them from each other.
|
||||
|
||||
Formats describe log patterns, such as: with or without time stamp, source file, source line.
|
||||
|
||||
Rules consist of category, level, output file (or other channel) and format. In brief, if the category string in a rule in the configuration file equals the name of a category variable in the source, then they match. Still there is complex match range of category. Rule decouples variable conditions. For example, log4j must specify a level for each logger(or inherit from father logger). That's not convenient when each grade of logger has its own level for output(child logger output at the level of debug, when father logger output at the level of error)
|
||||
|
||||
Now create a configuration file. The function zlog_init takes the files path as its only argument.
|
||||
$ cat /etc/zlog.conf
|
||||
|
||||
[formats]
|
||||
simple = "%m%n"
|
||||
[rules]
|
||||
my_cat.DEBUG >stdout; simple
|
||||
```bash
|
||||
$ cat /etc/zlog.conf
|
||||
|
||||
In the configuration file log messages in the category "my_cat" and a level of DEBUG or higher are output to standard output, with the format of simple(%m - usermessage %n - newline). If you want to direct out to a file and limit the files maximum size, use this configuration
|
||||
[formats]
|
||||
simple = "%m%n"
|
||||
[rules]
|
||||
my_cat.DEBUG >stdout; simple
|
||||
```
|
||||
|
||||
my_cat.DEBUG "/var/log/aa.log", 1M; simple
|
||||
In the configuration file log messages in the category `my_cat` and a level of DEBUG or higher are output to standard output, with the format of simple `%m - usermessage %n - newline`. If you want to direct out to a file and limit the files maximum size, use this configuration
|
||||
|
||||
3. Using zlog API in C source file
|
||||
-------------
|
||||
$ vi test_hello.c
|
||||
```config
|
||||
my_cat.DEBUG "/var/log/aa.log", 1M; simple
|
||||
```
|
||||
|
||||
#include <stdio.h>
|
||||
## 3. Using zlog API in C source file
|
||||
|
||||
#include "zlog.h"
|
||||
### 3.1 Sample code
|
||||
|
||||
int main(int argc, char** argv)
|
||||
{
|
||||
int rc;
|
||||
zlog_category_t *c;
|
||||
```bash
|
||||
$ vi test_hello.c
|
||||
|
||||
rc = zlog_init("/etc/zlog.conf");
|
||||
if (rc) {
|
||||
printf("init failed\n");
|
||||
return -1;
|
||||
}
|
||||
#include <stdio.h>
|
||||
|
||||
c = zlog_get_category("my_cat");
|
||||
if (!c) {
|
||||
printf("get cat fail\n");
|
||||
zlog_fini();
|
||||
return -2;
|
||||
}
|
||||
#include "zlog.h"
|
||||
|
||||
zlog_info(c, "hello, zlog");
|
||||
int main(int argc, char** argv)
|
||||
{
|
||||
int rc;
|
||||
zlog_category_t *c;
|
||||
|
||||
zlog_fini();
|
||||
rc = zlog_init("/etc/zlog.conf");
|
||||
if (rc) {
|
||||
printf("init failed\n");
|
||||
return -1;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
c = zlog_get_category("my_cat");
|
||||
if (!c) {
|
||||
printf("get cat fail\n");
|
||||
zlog_fini();
|
||||
return -2;
|
||||
}
|
||||
|
||||
4. Compile, and run it!
|
||||
-------------
|
||||
$ cc -c -o test_hello.o test_hello.c -I/usr/local/include
|
||||
$ cc -o test_hello test_hello.o -L/usr/local/lib -lzlog -lpthread
|
||||
$ ./test_hello
|
||||
hello, zlog
|
||||
zlog_info(c, "hello, zlog");
|
||||
|
||||
5. Advanced Usage
|
||||
-------------
|
||||
* syslog model, better than log4j model
|
||||
* log format customization
|
||||
* multiple output destinations including static file path, dynamic file path, stdout, stderr, syslog, user-defined output
|
||||
* runtime manually or automatically refresh configure(safely)
|
||||
* high-performance, 250'000 logs/second on my laptop, about 1000 times faster than syslog(3) with rsyslogd
|
||||
* user-defined log level
|
||||
* thread-safe and process-safe log file rotation
|
||||
* microsecond accuracy
|
||||
* dzlog, a default category log API for easy use
|
||||
* MDC, a log4j style key-value map
|
||||
* self debuggable, can output zlog's self debug&error log at runtime
|
||||
* No external dependencies, just based on a POSIX system and a C99 compliant vsnprintf.
|
||||
zlog_fini();
|
||||
|
||||
6. Links:
|
||||
-------------
|
||||
* Homepage: http://hardysimpson.github.io/zlog
|
||||
* Downloads: https://github.com/HardySimpson/zlog/releases
|
||||
* Author's Email: HardySimpson1984@gmail.com
|
||||
* auto tools version: https://github.com/bmanojlovic/zlog
|
||||
* cmake verion: https://github.com/lisongmin/zlog
|
||||
* windows version: https://github.com/lopsd07/WinZlog
|
||||
return 0;
|
||||
}
|
||||
```
|
||||
|
||||
### 3.2 Compile, and run it
|
||||
|
||||
```bash
|
||||
$ cc -c -o test_hello.o test_hello.c -I/usr/local/include
|
||||
$ cc -o test_hello test_hello.o -L/usr/local/lib -lzlog -lpthread
|
||||
$ ./test_hello
|
||||
hello, zlog
|
||||
```
|
||||
|
||||
## 4. Advanced Usage
|
||||
|
||||
* syslog model, better than log4j model
|
||||
* log format customization
|
||||
* multiple output destinations including static file path, dynamic file path, stdout, stderr, syslog, user-defined output
|
||||
* runtime manually or automatically refresh configure(safely)
|
||||
* high-performance, 250'000 logs/second on my laptop, about 1000 times faster than syslog(3) with rsyslogd
|
||||
* user-defined log level
|
||||
* thread-safe and process-safe log file rotation
|
||||
* microsecond accuracy
|
||||
* dzlog, a default category log API for easy use
|
||||
* MDC, a log4j style key-value map
|
||||
* self debuggable, can output zlog's self debug&error log at runtime
|
||||
* No external dependencies, just based on a POSIX system and a C99 compliant vsnprintf.
|
||||
|
||||
## 5. Reference
|
||||
|
||||
* Homepage: <http://hardysimpson.github.io/zlog>
|
||||
* Downloads: <https://github.com/HardySimpson/zlog/releases>
|
||||
* Author's Email: <HardySimpson1984@gmail.com>
|
||||
* Auto tools version: <https://github.com/bmanojlovic/zlog>
|
||||
* CMake verion: <https://github.com/lisongmin/zlog>
|
||||
* Windows version: <https://github.com/lopsd07/WinZlog>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user