由于网络服务器可能会因各种天灾人祸或是因为需要进行系统更新而必须重新开机,因此在部署网络相关的服务时,我们应该要确保网络服务可以在服务器重新开机之后也跟着自动启动。再来,网络服务器可能会遭遇到各种意外状况,而导致程序运行出错,造成程序崩溃(crash),一旦提供服务的应用程序崩溃了,就无法再继续处理后续进来的请求,因此有个能够保证服务能够在崩溃或是被关闭之后自动重启的机制也是很重要的。在 Linux 操作系统上,我们可以直接透过 Linux 操作系统内置的 init 系统,来将任意应用程序变成开机可自动运行,且保证能够在崩溃或是被关闭之后自动重启的服务。

Linux 内置的 init 系统,从过去主流的 SysV-init,到过渡的 Upstart,再到成为新主流的 Systemd,都可以用来处理上述问题。本篇文章只会介绍 Systemd 的作法。

Systemd Unit

Systemd Unit 是 Systemd 设置档的类型,常用的类型有处理服务的 .service、处理 runlevel 的 .target、处理文件系统挂载的 .mount。

Debian 或是其衍生的 Linux 发行版会有三个目录来存放不同优先等级的 Systemd Unit。第一个是优先权最低的系统目录 /lib/systemd/system(已安装套件通常会将 Systemd Unit 文件放置在此目录,如果是红帽系的 Linux 发行版的话,此目录的路径是 /usr/lib/systemd/system),第二个是优先权中等的运行阶段目录 /run/systemd/system,第三个是优先权最高的管理员自订目录 /etc/systemd/system。如果要查看 Systemd Unit 是否有发生覆写,可以在终端机使用 systemd-delta 指令,有兴趣者可以自行试试,这篇文章就不细谈这部份了。

撰写 Systemd Service Unit 的设置档

若我们想要利用 Systemd Service Unit 来启动某个与操作系统本身运作没什么关联的应用程序,可以将 Systemd Service Unit 的设置档写在管理员自订目录 /etc/systemd/system 下。

直接在 /etc/systemd/system 下创建一个扩展名为 .service 的文件,并先使用以下文字作为文件内容:

[Unit]
Description=A description for this service unit.
After=network.target
 
[Service]
# User=user
# Group=group
# WorkingDirectory=/path/to/folder
ExecStart=/path/to/program [arguments]
Restart=always
RestartSec=3s

# Environment="VARIABLE_1=VALUE_1" "VARIABLE_2=VALUE_2"
# Environment="VARIABLE_3=VALUE_3" "VARIABLE_4=VALUE_4"
 
[Install]
WantedBy=multi-user.target

[Unit] 区块中,我们撰写了两个项目。Description 用来设置这个 Systemd Service Unit 设置文件的描述,可以让管理员在日后查看时还能想起这个 Systemd Service Unit 的目的是什么。另一个 After 项目可以用来指定一个 Systemd Target Unit,可以确保目前正在设置的这个 Unit,会在 Systemd Target Unit 运行完后再运行。如果是用来提供 Web 服务的应用程序,那么通常就必须要在操作系统环境的网络功能被激活之后才能够正常启动,所以 After 项目设置为 network.target 可以确保该程序在第一次运行时候就顺利启动。

[Service] 区块中有五个使用井字号 # 注解掉的项目,这些先不要管它,稍后会再提到。ExecStart 项目可以用来设置当这个 Systemd Service Unit 项目启动时要运行的应用程序(需使用完整绝对路径),并且如果需要的话,可以利用空白字符来分隔多个不同的参数。若是这个程序需要搭配 shell 的命令行功能(例如变量、管线等)来运行,那就使用如以下的方式先运行 shell 之后,再运行 shell 的命令吧!

ExecStart=/bin/bash -c 'shell命令'

Restart 项目可以设置 ExecStart 所运行的程序要在什么样的情况被关闭时,以相同的指令再重新运行一次。有效的设置值如下:

  • no:不重启。(默认值)
  • always:不管什么原因都会重启。
  • on-success:只在成功运行结束后(也就是进程回传的 Exit Status 为 0 的时候)才进行重启。(这蛮少用)
  • on-failure:在运行失败后(进程回传的 Exit Status 非为 0、被使用 Kill 信号强制关闭、逾时或是喂狗没反应时)才进行重启。
  • on-abnormal:在意外地运行失败后(被使用 Kill 信号强制关闭、逾时或是喂狗没反应时)才进行重启。
  • on-abort:被使用 Kill 信号强制关闭时才进行重启。
  • on-watchdog:喂狗没反应时才进行重启。

上述提到的「逾时」,可以在 [Service] 区块中用 TimeoutSec 项目来设置程序在运行多久后算是逾时,一般我们是用不到这个机制啦!而「喂狗」则是使用 Systemd 提供的看门狗(Watchdog)机制,使程序在固定时间内(可以在 [Service] 区块中用 WatchdogSec 项目来设置),必须主动调用 Systemd 函数库的 sd_notify 函数,以利 Systemd 判断该程序是否还是正常运作的状态,一般我们也是用不到这个机制的啦!

至于 RestartSec 这个项目,就是设置程序在被关闭后,到下次自动重启的间隔时间,预设是 100ms(毫秒)。

最后的 [Install] 区块中,只有 WantedBy 这一个设置项目,它可以用来指定一个 Systemd Target Unit,让目前正在设置的这个 Unit,会在运行该 Systemd Target Unit 时,也跟着被运行。

接着来谈谈被注解掉的项目,首先是 User 和 Group 这两个项目,它们可以分别用来设置要运行 ExecStart 项目所指定的程序时所使用的用户名和群组名称。另外如果程序的运行必须仰赖工作目录的支持的话,就要使用 WorkingDirectory 项目来手动指定程序工作目录的路径。

而如果要替运行的程序设置环境变量的话,可以透过一个或是数个 Environment 项目来设置,一个 Environment 项目可以设置多个环境变量。

套用 Systemd Unit 的设置档变更

在添加、或是修改 Systemd Unit 的设置档后,要在终端机运行以下指令才会重新加载:

sudo systemctl daemon-reload

这个指令并不会导致正常运行中的服务被重启。(换句话说,正在运行中的服务还是会使用原来的 Systemd Unit 设置档,除非手动重启它。)

启动、重新启动、停止指定的 Systemd Service Unit

systemctl 指令除了可以让 Systemd 重新加载新的 Systemd Unit 的设置档外,当然也可以用来进行其它的管理操作。

例如要启动 magiclen.org.service 这个 Systemd Service Unit,可以在终端机运行以下指令:

sudo systemctl start magiclen.org.service

Systemd Unit 文件的扩展名可以省略掉,所以以上的指令也可以简写成:

sudo systemctl start magiclen.org

如果是要「重新启动」正在运行的服务,就把指令中的 start 换成 restart 即可。

如果是要「停止」正在运行的服务,就把指令中的 start 换成 stop 即可。

查看指定 Systemd Service Unit 的状态

使用 systemctl start 指令来启动服务时,它只会等到服务被视为启动完成就结束。本篇的设置档没有设置 Type 项目,预设的 simple 类型会在程序一被运行时就视为启动完成,就算程序之后马上出错结束,指令也不会显示错误,所以我们无法直接得知服务到底有没有运行成功。因此在手动使用 systemctl start 指令运行服务之后,通常还会再使用 systemctl status 指令来查看指定的 Systemd Service Unit 的状态。

如果是想要查看 Systemd Service Unit 所运行的程序所输出的 Log,可以使用 journalctl 指令,基本用法如下:

journalctl -u 要查看Systemd Service Unit名称

如果要同时查看多个 Systemd Service Unit,可以再使用多个 -u 参数进行串接。

在预设情况下 journalctl 会把所有时间以及所有层级(如 Debug、Warning、Error)的 Log 通通显示出来,如果要进行过滤的话,可以将指令写成:

journalctl -u 要查看Systemd Service Unit名称 -p 要查看的Log最高层级 --since 起始时间点 --until 终止时间点

Log 的层级列表如下:

  • 0: emerg
  • 1: alert
  • 2: crit
  • 3: err
  • 4: warning
  • 5: notice
  • 6: info
  • 7: debug

层级数字或是层级名称都可以与 -p 参数搭配使用。

时间点的写法最基本的就是使用以下格式:

YYYY-MM-DD[ HH:MM[:SS]]

例如:2019-06-19、2019-06-19 12:00 或 2019-06-19 12:00:00。

或是:

HH:MM[:SS]

例如:12:00 表示今天正中午。

另外也可以用 yesterday、today 和 tomorrow 来分别表示昨天、今天和明天(未来日记?)。

也可以用 1 hour ago、1 hours ago、2 week ago、2 weeks ago 等来表示距离现在时间多久前的时间点。

开机自动启动服务

如果要将 Systemd Service Unit 在开机时自动运行的话,首先要确定设置档中的 [Install] 区块有撰写正确,接着要在终端机上运行以下指令:

sudo systemctl enable 要自动启动的Systemd Service Unit名称

如果要关闭自动运行的功能,则在终端机上运行以下指令:

sudo systemctl disable 要自动启动的Systemd Service Unit名称

牛刀小试

利用这篇文章中所介绍的 mprober 来架设出可开机自动运行,且保证能够在崩溃或是被关闭之后自动重启的系统状态监看之 Web 服务。该 Web 服务必须监听 TCP 的 9958 连接端口。

参考答案

按照 mprober 文章的方法将 mprober 安装在 /usr/local/bin 目录中。然后添加一个 /etc/systemd/system/mprober.service 文件,内容如下:

[Unit]
Description=M Prober
After=network.target

[Service]
ExecStart=/usr/local/bin/mprober web -p 9958
Restart=always
RestartSec=3s

[Install]
WantedBy=multi-user.target

在终端机运行以下指令:

sudo systemctl daemon-reload
sudo systemctl start mprober
sudo systemctl status mprober

若 mprober 有成功运行,再运行以下指令:

sudo systemctl enable mprober