日志管理
日志介绍
VDS日志是应用程序自身运行过程中产生的记录文件,用于记录用户操作历史、系统状态、错误信息等重要信息。以便系统出现问题时,通过查看日志排查线索,从而快速定位并解决问题。
日志的默认存储路径为: Vastbase Data Studio\Userdata<用户名>\logs,其中 <用户名> 指的是当前登录VDS的操作系统的用户名称。该目录下包含如下3个日志文件:
用户可以根据实际需求自定义日志文件的存储路径,配置方法请参考5.2日志配置章节。
- operation.log:记录VDS在连接数据库过程中生成profile文件的相关操作信息,以及用户修改首选项的操作信息。
- security.log:专门用于记录VDS在连接数据库时涉及的用户密码的日志。
- Vastbase Data Studio.log:作为VDS的主日志文件,记录除operation.log和security.log中已记录信息外的所有运行时操作,包括但不限于系统启动/关闭、错误消息、SQL执行相关数据等。
日志文件中的消息描述如下所示:
日志的循环覆盖规则
VDS中的三种日志文件(operation.log、security.log、Vastbase Data Studio.log)均采用一致的循环覆盖规则来管理日志文件的大小和数量。下面以Vastbase Data Studio.log为例,详细说明该循环覆盖规则:
Vastbase Data Studio.log文件最大为10000 KB,当文件内容达到最大限制时,系统会进行以下操作来管理日志:
1、自动创建一个新的日志文件,命名为Vastbase Data Studio.log.1,并将Vastbase Data Studio.log中的当前日志内容移动到该文件中。
2、随着新日志的持续写入,当Vastbase Data Studio.log再次达到10000 KB时,系统会再次自动创建一个新日志文件,命名为Vastbase Data Studio.log.2,并将当前的日志内容转移到该文件。
3、这个过程会持续进行,直到创建了5个备份日志文件(从.log.1到.log.5)。
4、当Vastbase Data Studio.log.5文件也达到最大容量时,系统会开始循环覆盖旧的日志文件,删除最旧的日志文件Vastbase Data Studio.log.1,并将其余的日志文件名称依次向前移动一个序号(如.log.5重命名为.log.4,.log.4重命名为.log.3,以此类推)。
通过上述方式,VDS确保最新的日志信息始终写入原始的Vastbase Data Studio.log文件中,并且始终保留最新的五个日志文件,自动删除最旧的日志文件,从而有效地管理日志文件的大小和数量。
日志配置(可选)
日志配置为可选功能,用户可根据实际需求来自行决定是否进行个性化配置,包括日志的存储路径、日志级别以及记录的日志内容。若未进行配置,VDS将自动采用默认设置。
具体配置方法如下:
步骤 1: 打开 Vastbase Data Studio.ini 文件。
步骤 2: 在配置文件中可修改或添加如下选项来进行日志配置。
(1)配置日志路径。
通过设置参数-logfolder
用户可以自定义日志文件的存储路径。例如,如果您希望将日志文件存储在c:\test1\<用户名>\logs
路径下,则需要在配置文件中添加下列选项:
-logfolder=c:\test1
当用户指定的日志存储路径不存在或不可访问时,VDS将自动回退到默认路径进行日志存储。因此,即使自定义路径设置失败,用户也无需担心日志数据的丢失,日志仍然会被妥善保存在默认路径下。
(2)配置日志级别。
通过配置参数-logginglevel
,用户可以设置日志级别,从而控制记录到日志文件中的信息类型和数量。例如,如果您希望将在日志文件中记录所有的信息,则需要在配置文件中添加下列选项。
-logginglevel=ALL
不同类型的日志级别如下:
- TRACE:最低级别也是最为详细的日志信息,通常用于记录程序的细节信息。
- DEBUG:记录的信息较trace级别略微简单,通常用于记录一些调试信息,如变量的值,执行路径等。
- INFO:记录应用程序运行时的一般信息。
- WARN:记录潜在的问题或不符合预期的情况。
- ERROR:记录发生的错误事件,但是不影响系统正常运行。
- FATAL:记录造成应用终止的严重错误。
- ALL:启用所有日志级别。
- OFF:禁用所有日志级别和 ALL 级别相反。
如果用户输入无效的日志级别值,日志级别会设置为 WARN。
如果用户未指定日志级别,日志级别会设置为 WARN。
日志记录会输出高于或等于其日志级别的所有消息。日志级别顺序如下:
- | FATAL | ERROR | WARN | INFO | DEBUG | TRACE |
---|---|---|---|---|---|---|
OFF | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ |
FATAL | ✔ | ✘ | ✘ | ✘ | ✘ | ✘ |
ERROR | ✔ | ✔ | ✘ | ✘ | ✘ | ✘ |
WARN | ✔ | ✔ | ✔ | ✘ | ✘ | ✘ |
INFO | ✔ | ✔ | ✔ | ✔ | ✘ | ✘ |
DEBUG | ✔ | ✔ | ✔ | ✔ | ✔ | ✘ |
TRACE | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
ALL | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
✔ 创建日志文件 ✘不创建日志文件 |
(3)配置故障和错误日志。
设置参数-detailLogging
为true,错误信息会打印SQL异常的堆栈信息。
配置文件中尚未包含该参数项,如有需要请在配置文件中手动添加并设置该参数,不添加时默认为false。
步骤3: 参数配置完成后,需重新启动VDS。