Systemwalker Operation Manager 解説書 - UNIX共通 - - Microsoft(R) Windows NT(R)/Windows(R) 2000/Windows Server(TM) 2003 -

2.9.3 Systemwalkerスクリプトのデバッグ方法

Systemwalkerスクリプトは、コンパイル手続きなしで動作させることができますが、スクリプト内に誤りがあった場合には、該当箇所を動作させるまで検出することができません。Systemwalker Operation Managerにおける実運用での支障がないように、スクリプト作成後の段階において動作確認・デバッグを実施し、これらの誤りを取り除くことが必要です。

スクリプト作成時に作り込む誤りには、次のものが考えられます。

• 単純な記述ミス
• 文法上の誤り
• 論理的な誤り

  条件式が文法上は正しいが本来意図した判定を行うものでない、条件分岐の仕方によっては必要な変数に値が設定されないなど。

• 実行環境に対する考慮洩れ

  必ず存在すると思っていたファイルが存在しない場合もある、起動プログラムからの出力情報として想定外のものがあるなど。

◆トレースレベルについて

スクリプト内には、デバッグに備えてトレース拡張コマンドの呼び出しをあらかじめ入れておきます。

トレース拡張コマンドは、オプションでトレースレベルを指定します。トレースレベルの指定方法については、“Systemwalker Operation Manager リファレンスマニュアル”を参照してください。

トレースレベルを変えることでトレース情報の採取内容を切り替えることが可能です。トレースが採取されるトレースレベルは、2段階あります。トレースレベルは、以下のように使い分けることを推奨します。

レベル１：実運用時にも採取する情報の出力に使用する。

起動時や処理結果など「動作ログ」として残す情報の出力をする。

異常を検知した場合の詳細情報など、「エラーログ」として残す情報の出力をする。

レベル２：動作確認テスト時やデバッグ時に採取する情報の出力に使用する。

処理分岐点や外部プログラム起動の前後など、スクリプトがどのルートをどこまで実行したかの「ルートチェック」として残す情報の出力をする。

読み込みファイルの内容やループ処理内での変数値など、「スクリプト内情報」として残す情報の出力をする。

◆動作確認とデバッグ手順

Systemwalkerスクリプトの動作確認とデバッグに関して、各工程で実施する内容は以下のとおりです。

1. スクリプト作成工程

   スクリプト中にトレース拡張コマンドの呼び出し処理を適宜入れます。

   • 動作ログ/エラーログ相当の採取箇所は、レベル1のトレースにします。
   • ルートチェック/スクリプト内情報の採取箇所は、レベル2のトレースにします。
2. スクリプト動作確認・デバッグ工程
   1. テスト用の実行コマンド(swotclsh)を使用してスクリプトを実行します。その際、以下の点に留意してください。
      • アプリケーション起動など、テストでは実際に動作させられない、またはさせてはいけない処理がある場合は、該当処理をコメントにするか、テスト用のダミープログラム起動に置き換えるなどの修正を加えます。
      • 動作確認時にはルートチェック用のトレースを採取・参照し、スクリプトが正しいルートを通っていることを確認します。
      • 動作確認はスクリプトの正常ルートだけでなく、エラー処理ルートも含めて条件分岐により枝分かれする全ルートを１つずつ確認します(スクリプトは変数名のタイプミスなどがあってもそのルートが実行されない限りエラーが検知されないため)。
   2. 正常に動作しない場合は、Tcl/Tkが出力するエラーメッセージ(エラーが出ている場合)、および採取したトレースから問題のある箇所を探し出し、原因を取り除きます。
3. ジョブ運用開始後

   運用開始後に顕在化する障害が存在する場合に備え、調査資料となる必要最低限のデバッグ情報は常時採取することを推奨します。スクリプトの動作で異常が発生した場合は、常時採取しているトレースの退避とその調査、さらに、必要に応じてトレースレベルを上げた状態でのトレース調査を行います。

TclProによるデバッグ方法

SystemwalkerスクリプトはTcl/Tkをベースにしているため、作成したスクリプトは、Tcl/Tk開発環境製品である以下のツールを使用してデバッグすることができます。

• TclPro1.4(Windows版 98/NT/2000に対応)【Windows】
• TclPro1.4(Solaris OE版)【UNIX】

なお、TclProは、UNIX版ではSolaris OE版のみサポートされています。そのため、Solaris OE版以外では本デバッグ方法は利用できません。

以下に、ツールの概要を説明します。

• TclPro Checker

  スクリプトを実行することなく文法エラーの検出をします。

• TclPro Debugger

  スクリプトのグラフィカルデバッガーです。

  画面上にスクリプトファイル(プログラム)が表示されてそれを元に、スクリプトコマンドのステップ実行、指定した位置までの実行をします。また、デバッグ実行中のスクリプトで使用している変数に対し、値の監視や入力を行うことができます。

【参考】

TclProはマルチプラットフォームに対応した製品であり、Solaris OE版の場合、GUIはXウィンドウ上の表示となります。

拡張コマンドのダミー定義について

Systemwalkerスクリプトは、Tcl/Tkに対し以下の拡張コマンドを追加しています。

• sw_TcOpenTrace
• sw_TcWriteTrace
• sw_TcCloseTrace

  スクリプトファイル中に上記コマンドの呼び出しがある場合は、そのままTclProによるデバッグを行うことができません。そこで、テスト対象スクリプトファイルの先頭に以下の記述により、拡張コマンドのダミー定義を行ってください。

  例：拡張コマンドのダミー定義

  # ダミー拡張コマンド定義
  proc sw_TcOpenTrace {args} {
  　　　　return 1
  }
  proc sw_TcWriteTrace {args} {
  　　　　return "TCOK"
  }
  proc sw_TcCloseTrace {args} {
  　　　　return "TCOK"
  }

  
  

  また、execコマンドなどデバッグ中に誤って実際に動作させたくないコマンドがある場合も、同様にしてダミーコマンドの定義をしてください。

  例：execコマンドのダミー定義【Windows】

  # ダミー拡張コマンド定義

  proc exec {args} {

  　　　　# 引数の指定値を記録する

  　　　　set fc [open {C:\tmp\exec.param} w+]

  　　　　puts $fc $args

  　　　　close $fc

  　　　　return ""

  }

  例：execコマンドのダミー定義【UNIX】

  # ダミー拡張コマンド定義
  proc exec {args} {
  　　　　# 引数の指定値を記録する
  　　　　set fc [open "/tmp/exec.param" w+]
  　　　　puts $fc $args
  　　　　close $fc
  　　　　return ""
  }

TclProについての詳細は、TclPro1.4(Windows版)またはTclPro1.4(Solaris OE版)が提供するマニュアルを参照してください。