「再現しません」と言わせないエラーログ設計——現場配布ツールの鉄則
配布したツールが現場で落ちる。問い合わせを受けて手元で試すと動く。「再現しません」。この返答をした瞬間、ユーザーの信頼は目に見えて減ります。私たちは社内外に500本以上のツールを配ってきて、この問題への答えは一つだと考えています。ログの品質は設計の段階で決まります。本記事はCATIAマクロのエラーログ設計の実務です。
Photo: Unsplash「再現しません」はツールの死因になる
現場配布ツールの寿命を縮める最大の要因は、機能不足ではなくエラー時の振る舞いです。落ちたのに何も記録が残らない。作者の手元では再現しない。調査は「もう一度起きたら教えてください」で止まる。これを2回繰り返すと、ユーザーは黙ってツールを使わなくなります。
厳しい言い方をすれば、「再現しません」は調査の終わりではなく、ログ不足の告白です。発生時の状況が記録されていれば、再現できなくても原因は追えます。記録がないから、再現に頼るしかなくなるのです。
作者の手元で起きない不具合は、環境の差から生まれます。CATIAのバージョン、開いていたデータの構造、ネットワークドライブの応答、ユーザーの操作順。これらは手元では再現しようがない。だからこそ、発生した現場でその瞬間を記録する仕組みが要ります。
エラーログに何を書くか
必要な項目は決まっています。発生日時。実行ユーザー。ツール名とそのバージョン。CATIAのバージョンとサービスパック。開いていたドキュメント名。エラー番号とエラー内容。そして可能なら、エラーが発生した処理の名前です。この7点があれば、初動調査で困ることはほぼありません。
中でも差が付くのは「どの処理まで進んだか」です。マクロの主要な節目で処理名を変数に控えておき、エラー時にそれをログへ書く。直前の操作が書いてあるログは強い。エラー番号だけのログと比べて、原因特定の速さがまるで違います。
逆に、書きすぎにも注意が要ります。形状データの中身や顧客固有の情報をログに残すと、ログファイル自体が管理対象になってしまいます。調査に要る最小限に絞る。ログ設計は「何を書かないか」の設計でもあります。
正直に止まるツールは信頼される。
黙って壊れるツールは捨てられる
どこに書くか——共有か、ローカルか
書き先の第一候補は共有フォルダです。全ユーザーのエラーが一箇所に集まると、「特定の誰かだけ落ちる」のか「全員落ちる」のかが一目で分かります。この切り分けだけで原因の半分は絞れます。個人の環境要因か、ツール側の欠陥かが見えるからです。
ただし共有フォルダは書けないことがあります。ネットワーク断、権限不足、フォルダ移設。そこで、共有に書けなければローカルに退避し、次回起動時に送り直す二段構えにします。ログ機構自体がエラーで落ちるのは最悪なので、ログ書き込みは失敗しても本体を巻き込まない作りにします。
ファイル形式は一行一件のテキストで十分です。タブ区切りにしておけば、集まったログをそのまま表計算ソフトで集計できます。ツール別・エラー番号別に件数を並べるだけで、次に直すべき箇所の優先順位が出ます。
エラー処理の流れを設計する
ログは記録の話ですが、その前提としてエラー処理の流れを決めておく必要があります。私たちの標準は、捕捉、記録、通知、停止の4段です。エラーを捕捉したら、まずログに書く。次にユーザーへ「何が起きたか」と「どうすればよいか」を平易に通知する。そして処理を安全に止めます。
重要なのは最後の「止まる」です。エラーを握りつぶして処理を続行すると、壊れたデータが後工程に流れます。異常があれば止まる。これは自働化の原則です。中途半端に動き続けるツールより、正直に止まるツールの方が、現場では信頼されます。
通知文にも設計が要ります。「実行時エラー '-2147467259'」を現場のユーザーに見せても何も伝わりません。「保存先フォルダにアクセスできませんでした。ネットワーク接続を確認してください」のように、次の行動が分かる言葉に翻訳して表示します。エラー番号はログにだけ残せば十分です。
共通ログ関数の実装例
以下は私たちの考え方を落とし込んだ参考実装です。ポイントは3つ。ログ書き込み自体のエラーを握りつぶすこと、共有フォルダに書けない場合のローカル退避、そしてタブ区切りの一行フォーマットです。これを共通関数として全ツールから呼びます。
共通化の効果は、ツールが増えるほど効いてきます。どのマクロも同じ形式でログを吐くので、集計も調査も一つのやり方で済む。新しいツールを作るときは、雛形にこの関数が最初から入っています。ログは後付けの飾りではなく、雛形の一部です。
エラーログはユーザーのためのものであると同時に、作る側の資産です。どの環境で何が起きるかの記録が蓄積されるほど、次のツールは最初から頑丈になります。「再現しません」と言わない開発は、この蓄積の上に成り立ちます。
手元の作業がこの方法で楽になりそうか、判断が付かないときは相談してください。効果が出そうか出なさそうかを、着手前に金額で見立てるところまでお手伝いします。
' 共通エラーログ関数:全ツールからこれを呼ぶ
Public Sub WriteErrorLog(sTool As String, sVer As String, _
sStep As String, lErrNum As Long, sErrDesc As String)
' ログ機構自体の失敗でツール本体を巻き込まない
On Error Resume Next
Dim sLine As String
' タブ区切り一行:日時/ユーザー/ツール/版/CATIA版/文書/工程/番号/内容
sLine = Format(Now, "yyyy/mm/dd hh:nn:ss") & vbTab & _
Environ("USERNAME") & vbTab & _
sTool & vbTab & sVer & vbTab & _
CATIA.SystemService.Environ("CATIAVersion") & vbTab & _
CATIA.ActiveDocument.Name & vbTab & _
sStep & vbTab & CStr(lErrNum) & vbTab & sErrDesc
' まず共有フォルダへ、書けなければローカルへ退避
If Not AppendLine("\\server\ToolLog\error.log", sLine) Then
AppendLine Environ("TEMP") & "\ToolLog_local.log", sLine
End If
End Sub
' 一行追記。成功ならTrueを返す
Private Function AppendLine(sPath As String, sLine As String) As Boolean
On Error GoTo Fail
Dim n As Integer
n = FreeFile
Open sPath For Append As #n
Print #n, sLine
Close #n
AppendLine = True
Exit Function
Fail:
AppendLine = False
End Function