This is a log collector for shell scripts, like the ⚓anchor of the ⛵ sail (shell).

MobaXterm

Xshell

Windows Terminal

这个脚本是日志收集器，主要用来收集自己写的一些shell脚本中产生的日志，以便于快于定位和解决问题。

不然就像在茫茫大海中，毫无目标。如果在航行中，通过锚(Anchor)就可以进行定位。

本脚本也参考了一些其他优秀脚本的思路，修改后更加贴合自己的要求。

• 可以使用（debug/info/notice/error/warn)标注不同的信息。并且可以配置不同的颜色，以便更快区别信息。
• 可以定位错误的Trace Stack。
• 设置日志输出的等级。（屏蔽和限制等级不进行输出）。
• 可以同时输出到终端与写入文件。
• 日志输出错误，可以进行report_capsize后续不再继续输出。

在你的脚本文件开头，加入source ./SailAnchor.sh

在关键的位置加入（debug/info/notice/error/warn)等函数提示信息。

例如：

#!/bin/bash

source ./SailAnchor.sh

notice Sailing
your_command
if [ $? = 0 ];then
  info Command downwind, succeeded.

else
  error Command capsize, failed!
fi

或者使用快速判断函数wave()

这里推荐一个使用方法，类似于：./logger.sh > anchors.log 2>&1

#!/bin/bash

source ./SailAnchor.sh

notice Sailing
your_command
wave $? your_command

关于颜色，可以参考标准定义Standard ECMA-48 (p61, p62).

Normal are:

可以同时设置显示（字母颜色）和背景。例如，如果使用红色背景和白色正面颜色进行错误输出，请设置：

SAILOR_ERROR_COLOR="37;41"

基本函数可以使用如下：

debug "This is a debug"
info "This is a info"
notice "This is a notice"
Warn "This is a Warn"
error "This is a error"

step 1 TestCommand1
TestCommand
wave $? "TestCommand"

step TestCommand2
if [ $? = 0 ];then
  info Command downwind, succeeded.
else
  error Command capsize, failed!
fi

• 保证SHELL_NAME与实际脚本的名称一致。

• 脚本尽量不要给予+x权限,通过source方式去加载。

• 尽量使用debug,info,notice,warn,error等具有信息标签的日志输出函数。日志格式统一。

• 而step,before_sail,after_sail,report_capsize,report_arrival等报告信息函数可以在关键信息报告或者测试中使用！会破坏一定日志格式。

• 使用report_capsize会屏蔽后续错误日志的输出！

• 如果要修改参数，可以在source SailAnchor之前进行赋值，如

  LOG_FILE=../logs/demo.log
  SAILOR_SHOW_WELCOME=0
  source ./SailAnchor.sh

• 实际运行中可能存在一些问题，后续有待调整!