ページのトップに戻る
Systemwalker Operation Manager  リファレンスマニュアル

16.3.1 トレース拡張コマンド

Systemwalkerスクリプト内に以下のコマンドを記述して、トレースを採取することにより、スクリプトのデバッグを可能にします。

16.3.1.1 sw_TcOpenTrace (トレースファイルオープンコマンド)

機能説明

トレースファイルをオープンし、トレース採取のための初期処理を行います。スクリプトの実行トレース採取を開始する場合は、本コマンドが最初に呼び出されなければなりません。

記述形式

sw_TcOpenTrace 【-size fsize】【-level tlevel
【-mode group|other】 filename

オプション

-size fsize

fsizeにトレースファイル1ファイルあたりの最大サイズを1~100000[KB]で指定します。省略時のデフォルト値は、50KBです。

トレース採取は、2つのファイルが作成されサイクリックに採取されるため、ファイルサイズの最大値の見積もりはここで指定するサイズの2倍になります。

-level tlevel

tlevelにトレースレベルを0~2で指定します。省略時のデフォルト値は、1です。以下にレベルごとの採取内容と推奨例を示します。

0:

それ以降のsw_TcWriteTraceコマンドは無効となりトレースは採取されません。

1:

それ以降のsw_TcWriteTraceでトレースレベル1のものだけが採取されます。
例:実運用時にも採取する情報の出力に使用
    ・起動時や処理結果など動作ログとして残す情報の出力
    ・異常を検知した場合の詳細情報など、エラーログとして残す情報の出力

2:

それ以降のsw_TcWriteTraceでトレースレベル1と2のものが採取されます。
例:動作確認テスト時やデバッグ時に採取する情報の出力に使用
    ・処理分岐点や外部プログラム起動の前後など、スクリプトのルートチェックとして残す情報の出力
    ・読み込みファイルの内容やループ処理内での変数値など、スクリプト内情報として残す情報の出力

-mode group|other

作成するトレースファイルの書き込みモードを指定します。省略時は、所有者のみに書き込み許可属性を設定します。本オプションは、Windows上では無視されます。

group

所有者およびグループに書き込み許可属性を設定します。

other

所有者、グループおよびその他に書き込み許可属性を設定します。

filename

トレースファイル名を指定します。パス指定なしでファイル名のみ指定した場合はデフォルトのトレース格納ディレクトリへ採取され、パス指定をした場合はそのパスに従って採取されます。

Windows上のファイル名の場合は、ディレクトリの区切りを“¥”(円記号)の他に“/”(スラッシュ)で記述することが可能です。円記号を使用する場合は、エスケープ文字に扱われないようファイル名全体を“{}”(中括弧)で囲む必要があります。

トレースは、デフォルトで以下のディレクトリに格納されます。

【Windows版】

Systemwalker Operation Managerインストールディレクトリ
¥MpWalker.JM¥mpfwtco¥trc

【UNIX版】

/var/opt/FJSVfwtco/trc

注意

トレースファイルが作成されるディレクトリは、Systemwalkerスクリプトを実行するユーザが更新権を持つディレクトリにしてください。

参考

トレースは、2つのファイルが作成されそれらに対してサイクリックに採取していきます。そのため、実際のファイル名は、ここで指定するファイル名の後ろに“#1.txt”または“#2.txt”が付加された名前となります。

例えば、{c:¥tmp¥trc}と指定した場合、c:¥tmp配下にtrc#1.txtとtrc#2.txtが作成されます。【Windows版】

“/tmp/trc”と指定した場合、/tmp配下にtrc#1.txtとtrc#2.txtが作成されます。【UNIX版】

復帰値

正の値:

正常終了。トレースコマンドで使用するハンドル

-9:

メモリ不足

-15:

コード変換エラー

-17:

ファイルオープンエラー

参照

sw_TcCloseTrace

実行環境による差異

OSやエディションによる差異はなし。

使用例

【Windows版】

ファイルc:¥var¥tmp¥usrtrcをトレースファイルに指定してトレースをオープンし、ハンドルを変数hwndに格納します。

set hwnd [sw_TcOpenTrace {c:¥var¥tmp¥usrtrc}]

【UNIX版】

ファイル/var/tmp/usrtrcをトレースファイルに指定してトレースをオープンし、ハンドルを変数hwndに格納します。

set hwnd [sw_TcOpenTrace /var/tmp/usrtrc]

実行結果/出力形式

なし

16.3.1.2 sw_TcWriteTrace(トレース情報出力コマンド)

機能説明

トレースファイルにトレース情報を出力します。

記述形式

sw_TcWriteTrace 【-level tlevelthandle text

オプション

-level tlevel

tlevelにトレースレベル1または2を指定します。省略時のデフォルト値は、1です。

thandle

sw_TcOpenTraceで取得したハンドルを指定します。空文字列 “”を指定した場合は、トレースの採取はされません。

text

トレースファイルに出力する任意の文字列を900バイト以内で指定します。900バイトを超える文字列は、900バイトで切り捨てられます。

復帰値

TCOK:

正常終了

TCERR_WRITE:

ファイル書き込みエラー

TCERR_CODECONV:

コード変換エラー

参照

sw_TcOpenTrace

実行環境による差異

OSやエディションによる差異はなし。

使用例

変数hwndにsw_TcOpenTraceの復帰値が格納されている場合、文字列“File open error” をhwndが示すトレースファイルに書きます。

sw_TcWriteTrace $hwnd "File open error"

実行結果/出力形式

出力項目の説明

出力項目について説明します。

(1)時刻

出力時の時刻が“曜日 月 日 時:分:秒 年”の形式で出力されます。

(2)プロセスID

systemwalkerスクリプトのプロセスIDが出力されます。

(3)文字列

sw_TcWriteTrace で指定した文字列が出力されます。

16.3.1.3 sw_TcCloseTrace (トレースファイルクローズコマンド)

機能説明

トレースファイルをクローズし、トレースの採取を終了します。

記述形式

sw_TcCloseTrace thandle

オプション

thandle

sw_TcOpenTraceで取得したハンドルを指定します。

復帰値

TCOK:

正常終了

TCERR:

異常終了

参照

sw_TcOpenTrace

実行環境による差異

OSやエディションによる差異はなし。

使用例

変数hwndにsw_TcOpenTraceの復帰値が格納されている場合、hwndが示すトレースファイルをクローズする。

sw_TcCloseTrace $hwnd

実行結果/出力形式

なし