英语软件的日志怎么写

Posted 2022-05-27 有数可据

今天一个外企个小伙伴跑来跟我说，老板说他的程序里的英语写的太烂，让我教他怎么写日志。虽然我自己用英语写log，也还马马虎虎，但是让我系统的介绍，我也犯了难。

好在，我做过自然语言处理（NLP），也做过针对计算机系统的日志的挖掘，所以我知道有个东西叫做数据集（dataset），你可以找到各种NLP的dataset，包括日志。NLP专家用他们来训练NLP模型，判断系统是否正常，而我们可以找到他们，研究英语日志是怎么写的。

我在搜索引擎里换了好几次的关键字，最后用“log dataset”关键字，找到了一个叫loghub的项目。

其github地址如下：

https://github.com/logpai/loghub

这里一共收集了16种计算机系统的log。从windows，linux，mac到Hadoop，Zookeeper等，都是一些非常重要的系统的log，相信这样的log，也是质量非常高的。

为什么要参考已有的日志

有的人认为自己的英语很好，就能写好log了，我觉得未必。我可以问你一个问题，在美国怎么称呼法官？如果你不知道，你可能永远也不知道法官叫Your Honor。这就是特定场景有特定用语。

下面，我反复翻阅了loghub，总结出一些规律，希望对大家有用。

如何表示开始和结束

在写英语日志的时候，要记住英语是有时态的。所以，常用的表示开始和结束的写法是doing 和 done，既用现在进行时表示开始，用过去分词表示结束。

比如，有processing 和 processed。例句如下：

Processing the event EventType: JOB_SETUP

Processed session termination for sessionid: 0x14ede63a5a7003a

Opening 和 Opened

Opening proxy : 04DN8IQ.fareast.corp.microsoft.com:54883

session opened for user news by (uid=0)

也可以用begin/start和end，这是动词的时态可以是现在时，也可以是完成时。

startAnimation begin

startAnimation end

klogd 1.4.1, log source = /proc/kmsg started.

表示成功和失败

名次 + 成功/失败的完成时。

combo cups: cupsd shutdown succeeded

combo cups: cupsd startup succeeded

Kerberos authentication failed

过去时 + successfully

Instance spawned successfully.

failed to + 动词原形

failed to read message prefix on control stream (Ciostream socket to 172.16.96.116:33569

Failed to read DnsConfig.

Error

错误信息可以时 Error + 现在进行时

Error loading /home/spelce1/HPCC_IBM/Urgent/

Error reading message prefix on CioStream

和 Connection 相关的

Connection timed out

Connection reset by peer

Closed socket connection for client /10.10.34.12:33342

Connection request from old client /10.10.34.12:56424

Accepted socket connection from /10.10.34.11:37330

Connection closed by 194.190.163.22 [preauth]

必填字段

必填字段在英语里是required

Error creating node map from file /p/gb2/pakin1/sweep3d-5x5x400-10mk-3mmi-1024pes-xyzt/xyzt.map: Block device required

名字 + required，就表示必填字段未填。

我大概就总结了这些。如果你要写一些特定的日志，可以在loghub里搜一下有没有。

平时就要积累

如果你在外企工作，请先把windows设置成英文版，软件也都按照英文版。这样平时就会看到各种的提示，错误信息，log等，看得多了，自然就会了。没有输入，哪来输出？