简单shell日志框架simpleLog4sh

2015-08-26

simpleLog4sh是我从之前写的shell脚本里提取的shell日志工具类。简单改进以后，形成极为简单的shell日志框架。目前发布在GitHub上： https://github.com/maoshuai/simpleLog4sh

简介

simpleLog4sh是一个极为简单的shell日志框架，甚至不应该叫日志框架。
与其他shell日志框架不同，它仅仅是一个：

只有几十行的纯shell脚本，没有任何依赖。

但通过简单的封装，这个小shell可以提供诸如：

logInfo，logDebug等多级别日志输出
日志记录带有时间戳和日志级别
将日志输出到指定文件
日志文件按日期进行归档
抛出异常

simpleLog4sh不期望做到像Apache日志框架一样复杂，仅仅在您写toy小程序的时候，能帮助你实现最简单的日志功能，而不必总是echo。

您通过下面的语句，：

logInfo hello, world  
logDebug "hello, world" # 推荐将所有的内容用双引号包围  

输出内容举例如下：

2015-08-26 20:12:21 [test.sh] (INFO) hello, world  
2015-08-26 20:12:21 [test.sh] (DEBUG) hello, world  

使用方法举例

导入simpleLog4sh

在您的shell开头导入即可，可以参考/test/test.sh的中的用法：

. ../src/simplelog4sh.sh

logXXX语句

simpleLog4sh提供了四个日志级别的方法，他们分别是

logDebug
logInfo
logWarn
logError

用法很简单，所有的参数都会被当做日志内容记录，比如：

logInfo hello, world  
logDebug "hello, world" # 推荐将所有的内容用双引号包围  

输出内容举例如下：

2015-08-26 20:03:18 [test.sh] (INFO) hello, this logInfo  
2015-08-26 20:12:21 [test.sh] (DEBUG) hello, logDebug  
2015-08-26 20:12:21 [test.sh] (INFO) hello, logInfo  
2015-08-26 20:12:21 [test.sh] (WARN) hello, logWarn  
2015-08-26 20:12:21 [test.sh] (ERROR) hello, logError  
2015-08-26 20:12:21 [test.sh] (ECHO) hello, myEcho  
2015-08-26 20:12:21 [test.sh] (ECHO_ERROR) hello, myEchoError  
2015-08-26 20:13:26 [test.sh] (DEBUG) hello, logDebug  

设置日志级别

simpleLog4sh支持6个日志级别，含义与Apache日志框架类似：

ALL
DEBUG
INFO
WARN
ERROR
OFF

如果要设置指定的日志级别，请在导入simpleLogsh之后，export变量LOG_LEVEL，可设置为如下预置常量：

LOG_LEVEL_ALL  
LOG_LEVEL_DEBUG  
LOG_LEVEL_INFO  
LOG_LEVEL_WARN  
LOG_LEVEL_ERROR  
LOG_LEVEL_OFF  

throw语句

throw语句类似java语言中抛异常。通过使用throw语句，达到类似抛异常的效果。比如：

throw "ParamsNumberException: need 2 params"

使用throw语句，程序将在stderr输出上述语句，同时在日志文件以LOG_LEVEL_ERROR级别记录。最后程序会意退出码1退出。

myEcho与myEchoError语句

myEcho和myEchoError与shell的echo语句类似，但有两点增强：

myEcho和myEchoError不仅会输出到控制台，还会输出到日志文件。
myEchoError的输出是stdErr

日志路径与日志文件滚动

默认程序的输出日志路径是/tmp/simplelog4sh，并在此目录下面生成已当前日期命名的日志文件，类似如下：

-rw-r--r--  1 maoshuai  wheel  1839  8 25 23:48 log_20150825.log  
-rw-r--r--  1 maoshuai  wheel  1839  8 26 20:32 log_20150826.log  

当然，你可以通过export变量SIMPLE_LOG_4_SH_DIR指定你的日志路径，替换上述默认值。比如：export SIMPLE_LOG_4_SH_DIR=/var/log，则所有日志都打印到/var/log目录下面

-------------------------

本文采用知识共享署名 4.0 国际许可协议（CC-BY 4.0）进行许可。转载请注明来源：https://imshuai.com/simplelog4sh 欢迎指正或在下方评论。

毛帅

{Code, Thoughts, Sharing}