Stata
shell 経由で curl を使います:Windows 10 と 11 では curl.exe、macOS と Linux では curl(コードが c(os) でどちらかを選ぶので、同じ do ファイルがどこでも動きます)。Stata のバッチモードは常に 0 で終了するため、エラーは do ファイルの中で捕まえ、Stata の r() コード付きで送ります。tb_log に do ファイルのログを指定すると(stata -b do job.do は job.log を書き出します)、その最後の 20 行が失敗と一緒に送られます。
コード
これは Code(コード)タブが生成するコードです(開始、エラー、行数 にチェックを入れた状態)。アプリでは、あなたのジョブ専用のアドレスがすでに入っています。
* --- TaskBeacon: top of the do-file ---
local tb "https://taskbeacon.io/ping/your-job-id"
* curl.exe is built into Windows 10 and 11; macOS and Linux have curl
local tb_curl = cond(c(os) == "Windows", "curl.exe", "curl")
local tb_log "" // optional: this do-file's log (batch mode: stata -b do job.do, or StataMP-64.exe /e do job.do on Windows, writes job.log in the current folder); its last 20 lines go with a failure
shell `tb_curl' -fsS -m 10 "`tb'/start"
capture noisily {
* --- your code here (the example data: replace with your own) ---
sysuse auto, clear
}
quietly {
local tb_rc = _rc
if `tb_rc' {
* the last 20 lines of the log (if tb_log is set) go with the failure
local tb_data ""
if `"`tb_log'"' != "" {
tempfile tb_tail
tempname tb_in tb_out
capture {
file open `tb_in' using `"`tb_log'"', read text
local tb_n 0
file read `tb_in' tb_line
while r(eof) == 0 {
local tb_n = `tb_n' + 1
local tb_k = mod(`tb_n', 20)
local tb_l`tb_k' = substr(`"`macval(tb_line)'"', 1, 300)
file read `tb_in' tb_line
}
file close `tb_in'
file open `tb_out' using `"`tb_tail'"', write text replace
forvalues tb_i = `=max(1, `tb_n' - 19)'/`tb_n' {
local tb_k = mod(`tb_i', 20)
file write `tb_out' `"`macval(tb_l`tb_k')'"' _n
}
file close `tb_out'
local tb_data `"--data-binary "@`tb_tail'" -H "Content-Type: text/plain""'
}
capture file close `tb_in'
capture file close `tb_out'
}
shell `tb_curl' -fsS -m 10 `tb_data' "`tb'/fail?rc=`tb_rc'"
exit `tb_rc'
}
}
* --- TaskBeacon: end of the do-file ---
local tb_rows = _N
shell `tb_curl' -fsS -m 10 "`tb'?rows=`tb_rows'"仕組み
コードはスクリプトの開始時に /start、正常に終わったときに行数付きでそのままのアドレス、失敗したときに /fail を ping し、Stata のリターンコードと、tb_log が設定されていればログの最後の 20 行を送ります。
一部を省きたい場合は、Code タブでオプションのチェックを外してください。出力を送らず、エラーか終了コードだけを送るには Send output lines(出力行を送信)のチェックを外します。報告できる内容もご覧ください。
do ファイルをスケジュールで実行する
Stata for Windows は /e スイッチで do ファイルをウィンドウなしで実行します(/b では OK のクリックを待つため、スケジュール実行には向きません)。お使いの Stata エディションのフルパスを使ってください。
"C:\Program Files\Stata18\StataMP-64.exe" /e do "C:\jobs\sales.do"
毎朝起動するには、コマンド プロンプトからタスクを作成します(1 行)。
schtasks /Create /TN "Sales report" /SC DAILY /ST 06:00 /TR "\"C:\Program Files\Stata18\StataMP-64.exe\" /e do \"C:\jobs\sales.do\""
macOS や Linux では、cron からバッチモードで実行します(crontab -e。プログラム名はエディションによって異なり、たとえば stata-mp です)。
0 6 * * * cd /home/me/jobs && /usr/local/stata/stata-mp -b do sales.do
上のコードは Windows では curl.exe を、それ以外では curl を使います(c(os) で判定します)。そのため同じ do ファイルがどのマシンでも動きます。
Stata は作業フォルダーに sales.log を書き出します。Task Scheduler で Start in(開始)に do ファイルのフォルダーを設定してください(タスクの編集 → Actions → Start in)。設定しないと、ログが Stata のプログラム フォルダーに書かれようとし、通常そこには書き込めません(そのとき Stata は r(608) で止まります)。
終了コードが嘘をつく理由
バッチモードで do ファイルがエラーで止まると、エラーはログに残りますが、Stata 自体はそれを失敗として Windows に報告しません。Task Scheduler には The operation completed successfully (0x0) と表示されたままです。
そのため上のコードは、処理を capture noisily { … } で囲んでいます。do ファイルが自分のエラーを捕捉し、Stata のリターンコード(たとえば rc=601、ファイルが見つからない)を付けて /fail?rc= を送り、その後 exit で止まります。
失敗する可能性のある処理はすべて波かっこの中に入れてください。閉じかっこの後のコマンドが失敗しても捕捉されません。
行数を報告する
最後の行は _N、つまり do ファイルの終了時にメモリにあるオブザベーション数を送ります。対象のデータセットが終了時にメモリにあるものでない場合は、それがある場所で数えてください。
use "C:\data\sales_clean.dta", clear
local tb_rows = _N
TaskBeacon は、行数が最近の実行より 40% を超えて減ったとき、または 0 のときにアラートを送ります。どちらのルールもジョブのページで変更できます。
よくある問題
- ping がまったく届かない。
shellは Windows ではcurl.exe(Windows 10 と 11 に標準で入っています)を、macOS と Linux ではcurlを実行します。そのマシンのコマンド プロンプトかターミナルで curl の行を実行してください。HTTPS を遮断するプロキシやファイアウォールがあれば、そこで分かります。 - 黒いウィンドウが一瞬表示される(Windows)。
shellが curl のためにコンソールを開いているだけで、害はありません。 - 開始は届くが、終了が届かない。 do ファイルが
capture noisilyの外で止まったか、Stata が強制終了されました。猶予時間が過ぎると、ジョブは Late(遅延)と表示されます。 - ネットワーク ドライブ。 ログアウト中に実行されるタスクからは、
S:のような割り当てたドライブ文字が見えません。UNC パス(\\server\share\…)を使ってください。
ユースケース: バッチモードで Stata の do ファイルが失敗したときにアラートを受け取る。その他のご質問: FAQ