Debian 13 講座 / systemdタイマーで定期処理と失敗を確認する

Debian 13では、systemdタイマーが実行時刻を設定し、リンクされたサービスが実際の作業を行います。タイマーがアクティブであってもタスクが失敗することがあるため、次回のスケジュールだけでなく、サービスの終了コード、ログおよび生成された結果も確認する必要があります。

ファイルコピーラボの要件を確認する

今回は、単一のテキストファイルが、通常ユーザー lfstudent の専用フォルダから結果ファイルにコピーされます。元の内容と結果内容が同じ場合は上書きされず、別の実行が同時に行われている場合はロックにより拒否されます。これは複数の時点からデータを保持するバックアッププログラムではなく、操作中に元のファイルが変更されない小さなテストファイルを対象としています。

実習ではDebian 13のsystemd 257で flock、mktemp、および cmp を使用します。flock は、ファイルに基づいてプロセス間で排他的ロックを取得するコマンドです。新しいユニット、フォルダ、またはスクリプトがすでに存在する場合は、まず内容を確認し、上書きしないでください。

id lfstudent
command -v flock mktemp cmp
systemctl show lf-timer18.timer -p LoadState
ls -ld /home/lfstudent/lf-timer18
ls -l /usr/local/libexec/lf-timer18.sh /etc/systemd/system/lf-timer18.service /etc/systemd/system/lf-timer18.timer

タイマーが見つからず、残りの練習用パスが存在しないことを確認してください。ファイルが見つからないエラーは、事前に確認した際の予期される結果です。ツールが存在しない場合は、必要なツールをインストールするために apt-cache show util-linux coreutils diffutilsなどでパッケージ情報を確認し、必要なものをAPTでインストールしてください。ランタイム状態と起動時の設定は、systemdサービスとdrop-inの実習 で扱われた区別を使用します。

同じ入力なら結果が変わらないコピー処理を作る

lfstudent でログインして専用の入力ファイルを作成してください。同じフォルダが存在する場合、以下のmkdirは失敗し、後続のprintfも実行されません。その場合は実習を止め、既存の内容を確認してください。

mkdir /home/lfstudent/lf-timer18 &&
printf 'scheduled-copy-v1\n' > /home/lfstudent/lf-timer18/source.txt

管理者権限でスクリプトを保存するフォルダを準備し、sudo nano /usr/local/libexec/lf-timer18.sh から以下の全文を記述してください。nano が使用できない場合は、使用しているエディタを選んでください。

sudo install -d /usr/local/libexec
#!/bin/sh
set -eu
task_dir=/home/lfstudent/lf-timer18
exec 9>"$task_dir/.lock"
if ! flock -n 9; then
    printf 'Another copy is running\n' >&2
    exit 75
fi
test -r "$task_dir/source.txt"
if test -f "$task_dir/snapshot.txt" && cmp -s "$task_dir/source.txt" "$task_dir/snapshot.txt"; then
    printf 'Snapshot unchanged\n'
    exit 0
fi
task_tmp=$(mktemp "$task_dir/.snapshot.XXXXXX")
trap 'rm -f -- "$task_tmp"' EXIT HUP INT TERM
cat "$task_dir/source.txt" > "$task_tmp"
mv -- "$task_tmp" "$task_dir/snapshot.txt"
printf 'Snapshot updated\n'

これはファイルに保存するスクリプトであり、ターミナルに貼り付けて現在のシェル全体を置き換えて実行するコマンドではありません。保存後、実行権限と構文を確認してください。

sudo chmod 755 /usr/local/libexec/lf-timer18.sh
sh -n /usr/local/libexec/lf-timer18.sh
ls -l /usr/local/libexec/lf-timer18.sh

管理者が所有する実行可能ファイルは、通常のユーザーによって変更することはできず、実際のデータフォルダは lfstudent によって使用されます。mktemp は同じフォルダ内に一時ファイルを作成し、コピー後に名前を変更するため、通常の置換処理では、結果ファイルを読むプログラムにコピー途中の内容を見せずに切り替えられます。この例は、ディスク障害後の耐久性や、同時に変更されているデータベースの一貫したコピーを保証するものではありません。新しい結果ファイルは mktemp の制限付きアクセス権限を引き継ぎます。

冪等性(べきとうせい)とは、同じ入力で操作を繰り返しても同じ結果が得られることを意味します。ここでは、同じ入力を再度コピーしても重複データが追加されません。このスクリプトは、内容が同じ場合に Snapshot unchanged を出力して終了します。ロックは、同じファイルを使用する協力的な実行間でのみ機能します。他のプログラムが元のファイルを変更するのを防ぐことはできません。非ブロッキングロックや終了動作は flock マニュアル で確認できます。

oneshotサービスと間隔指定のタイマーを作る

作業単位を sudo nano /etc/systemd/system/lf-timer18.service として保存します

[Unit]
Description=Copy one lesson 18 test file

[Service]
Type=oneshot
User=lfstudent
ExecStart=/usr/local/libexec/lf-timer18.sh

これは短時間で終了するタスクなので、oneshot を使用します。繰り返し呼び出す必要があるため、RemainAfterExit=yes でアクティブに保持しません。このサービスはタイマーでトリガーされるため、このサービスには自動起動用の[Install]設定を付けません。

以下を sudo nano /etc/systemd/system/lf-timer18.timer に保存してください。5秒および20秒の間隔は、結果を素早く確認するための練習用であり、運用サイクルには推奨されません。

[Unit]
Description=Lesson 18 interval timer

[Timer]
OnActiveSec=5s
OnUnitInactiveSec=20s
AccuracySec=1s
Unit=lf-timer18.service

[Install]
WantedBy=timers.target

タイマーを起動すると、最初の実行は約5秒後に要求され、作業ユニットが非アクティブ状態に入ってから約20秒後に再度実行されるように設定されています。これは正確なリアルタイム実行を保証するものではなく、負荷や精度設定などによって遅延する可能性があります。同じサービスが実行中の場合、タイマーは別のサービスインスタンスを同時に実行しません。スクリプトが直接実行される他のエントリーポイントも考慮して、スクリプト内にもロックが配置されています。スケジュールオプションは、systemd.timer のドキュメント を基にしています。

sudo systemd-analyze verify /etc/systemd/system/lf-timer18.service /etc/systemd/system/lf-timer18.timer
sudo systemctl daemon-reload
sudo systemctl start lf-timer18.service
systemctl show lf-timer18.service -p Result -p ExecMainCode -p ExecMainStatus -p ActiveState
cmp /home/lfstudent/lf-timer18/source.txt /home/lfstudent/lf-timer18/snapshot.txt
sudo systemctl enable --now lf-timer18.timer
systemctl list-timers lf-timer18.timer --no-pager

手動実行では Result=success と終了ステータス 0 が報告され、cmp は出力なしで成功する必要があります。その後、タイマーをオンにします。完了したワンショットサービスの非アクティブ状態は正常な結果である場合があるため、Result と終了コードの両方を確認してください。タイマーは次回の予定実行時間と最後の実行時間を表示します。

最初の予定された起動後、タイマー、ジョブ結果、コピーされたデータを確認します。

systemctl is-active lf-timer18.timer
systemctl show lf-timer18.service -p Result -p ExecMainStatus -p ActiveState
sudo journalctl -u lf-timer18.service -b --no-pager -n 20
cat /home/lfstudent/lf-timer18/snapshot.txt
cmp /home/lfstudent/lf-timer18/source.txt /home/lfstudent/lf-timer18/snapshot.txt

ジャーナルのタイムスタンプを Snapshot updated または Snapshot unchanged と実際の結果と一緒に確認します。この演習では、タイマーがファイルコピー・スクリプトを実行するサービスを起動し、同じソースで再実行した場合、変更なしで終了することを確認しました。

作業が失敗してもタイマーはactiveか確認する

元のファイルを削除せず、名前だけを変更して読み取り失敗を作成します。まず、source.saved がすでに存在しないことを確認してください。この操作は、同じデータフォルダを使用する他のタスクがない専用演習でのみ実行してください。

test ! -e /home/lfstudent/lf-timer18/source.saved &&
mv /home/lfstudent/lf-timer18/source.txt /home/lfstudent/lf-timer18/source.saved
sudo systemctl start lf-timer18.service
systemctl is-active lf-timer18.timer
systemctl show lf-timer18.service -p Result -p ExecMainCode -p ExecMainStatus -p ActiveState
sudo journalctl -u lf-timer18.service -b --no-pager -n 12
systemctl list-timers lf-timer18.timer --no-pager

開始要求は失敗し、サービスのResultはexit-code、ExecMainStatusは1となります。タイマーはアクティブのまま残る場合があり、次のスケジュールも維持されます。つまり、スケジュールが維持されているからといって、ファイルのコピーが成功したわけではありません。演習では、失敗の後も前回の有効な結果ファイルがそのまま残ることを確認できます。タイマーが再度動作する前に元のファイルが復元されない場合、同じ失敗が繰り返される可能性があります。

mv /home/lfstudent/lf-timer18/source.saved /home/lfstudent/lf-timer18/source.txt
sudo systemctl start lf-timer18.service
systemctl show lf-timer18.service -p Result -p ExecMainStatus
cmp /home/lfstudent/lf-timer18/source.txt /home/lfstudent/lf-timer18/snapshot.txt

元に戻した後、手動で再実行してResult=success、終了ステータス0、および内容の一致を確認します。reset-failedを単に実行するだけでは元のファイルは復元されません。作業中はログを保持し、タスクの結果を監視するか、失敗通知を別途設定する必要があります。

ロック競合のテストと解除後のリトライ

自動呼び出しや比較と混同しないように、この演習タイマーをまず停止します。無効化すると、このタイマーの起動リンクも削除されます。

sudo systemctl disable --now lf-timer18.timer

端末Aで、lfstudentとしてログインし、ロックを一時的に保持します。

flock /home/lfstudent/lf-timer18/.lock sleep 20

20秒以内に同じユーザーで端末Bから実行します。

/usr/local/libexec/lf-timer18.sh
echo $?

Another copy is runningというメッセージと、スクリプトが定義した終了コード75を確認します。75はflock自体の既定の競合終了コードではありません。端末Aのコマンドが終了してから再実行すると成功します。ロックファイルが残っているだけで、ロック中だと判断しないでください。実行中のプロセスがロックを保持しているかが重要です。競合を解消するためにファイルを削除すると、別のロック対象が作られて重複実行を許すおそれがあります。

カレンダー指定とcronの使い分けを考える

練習用の間隔タイマーではなく、毎日韓国標準時(KST)午前2時のようにカレンダーに基づく時間が必要な場合、OnCalendarを検討してください。以下は原文の検証環境に合わせたAsia/Seoulの例です。日本時間で設定する場合は、この解析コマンドと後述のOnCalendarの両方でAsia/SeoulをAsia/Tokyoに置き換え、解析結果の次回時刻を確認してください。

systemd-analyze calendar '*-*-* 02:00:00 Asia/Seoul'

以下は、既存のタイマーファイルを置き換える際に使用できる別の例です。 間隔の設定を置き換えてください。このカレンダースケジュールと一緒に OnActiveSec および OnUnitInactiveSec を保持しないでください。 複数のスケジュール条件が一緒に使用される場合、どれか一つの条件によってトリガーされることがあります。本講義での実際の自動実行および失敗の比較は、前述の短い間隔のタイマーを使用して行われました。

[Unit]
Description=Daily lesson 18 file copy

[Timer]
OnCalendar=*-*-* 02:00:00 Asia/Seoul
Persistent=true
Unit=lf-timer18.service

[Install]
WantedBy=timers.target

カレンダー指定の構成を選択した場合、まずこのラボタイマーを停止し、そのファイル全体を置き換えて sudo systemd-analyze verify /etc/systemd/system/lf-timer18.timer を実行してください。検証が成功したら sudo systemctl daemon-reload を実行し、その後 sudo systemctl enable --now lf-timer18.timer を実行して systemctl list-timers lf-timer18.timer --no-pager を確認してください。短時間間隔テストに戻るには、タイマーを停止し、以前の完全なファイルを復元して検証し、再読み込みして再度開始します。カレンダーの解析は元のラボで確認されましたが、Persistentによる実行漏れの補完動作は実地検証していません。

Persistent=trueはOnCalendarに対して有効です。タイマーが停止していた間に実行時刻を一度以上過ぎていれば、再有効化時にサービスを起動して実行漏れを補います。これは、実行されなかった回数分すべての実行を順番に再現するわけではなく、また前回の間隔タイマーと同じ効果を持つオプションでもありません。カレンダーに基づくタスクは、システム時刻およびタイムゾーンとの同期も確認する必要があります。表現ルールは、systemd.time ドキュメント で確認できます。

要件 判断基準
サービスアカウント、依存関係、終了コード、およびジャーナルの総合管理 systemdのサービスとタイマーの組み合わせを検討する
既存のユーザー別の単純な定期コマンドを維持する 既存のcron設定、環境変数、および出力処理を確認する
停止していた期間中のカレンダータスクを補う タイマーのPersistent設定を確認する。通常のcronに同等の実行漏れ補完があるとは想定しない
同じスクリプトの重複実行を防ぐ 任意のスケジューリングツールについて、他のエントリーポイントとロック設計も確認する

Debianのcrontabマニュアル にあるように、cronでは実行ユーザー、環境、メールや出力の取り扱い条件を個別に考慮する必要があります。同じタスクをcronとタイマーの両方に重複して登録しないでください。ツールの選択よりも重要なのは、実際の実行結果や失敗を確認できる設定です。

実習用のスケジュールとファイルだけを削除する

Persistent付きのカレンダー指定を有効にしている場合は、タイマーを停止し、sudo systemctl clean --what=state lf-timer18.timer を実行してからユニットファイルを削除し、保存されたアクティベーションのタイムスタンプを削除してください。短い間隔のバージョンはこのPersistent状態を作成しません。

カレンダーの例を適用した場合、そのタイマーもクリーンアップの対象となります。まずスケジュールを停止し、実行中のタスクが終了していることを確認し、現在のファイルのみを削除してください。

sudo systemctl disable --now lf-timer18.timer
sudo systemctl stop lf-timer18.service
sudo rm -- /etc/systemd/system/lf-timer18.timer /etc/systemd/system/lf-timer18.service /usr/local/libexec/lf-timer18.sh
sudo systemctl daemon-reload
rm -- /home/lfstudent/lf-timer18/source.txt /home/lfstudent/lf-timer18/snapshot.txt /home/lfstudent/lf-timer18/.lock
rmdir -- /home/lfstudent/lf-timer18
systemctl show lf-timer18.timer -p LoadState
systemctl show lf-timer18.service -p LoadState

両方のユニットがLoadState=not-foundとなること、そしてフォルダが削除されていることを確認してください。元の一時的な名前や他のファイルがフォルダに残っている場合は、処理を行う前に内容を確認し、そのチェックを回避するために再帰的な削除は行わないでください。/usr/local/libexecのような共有ディレクトリ、他のタイマーや既存のジャーナルファイルは保持してください。