【IRIS】【計測関連】システム単位でアレコレ計測しよう(コマンド実行)

本記事では、計測シリーズの一環として「^PERFMON」を使用し、コマンド実行によるデータ収集方法について解説します。

※この記事は下記の方向けになります。

システム（インスタンス）単位で計測を行いたい方
システム全体のボトルネック箇所を特定したい方
毎回ターミナルを起動する手間を省きたい方

はじめに
全体の流れ
開始（Start Monitor)
一時停止（Pause Monitor）
レポート出力（Report Statistics）
停止（Stop Monitor）
その他
1. 測定値のクリア
2. Collect
おわりに

はじめに

^PERFMON については、前回の記事で紹介しています。
詳細は以下をご参照ください。

【IRIS】【計測関連】システム単位でアレコレ計測しよう (^PERFMON)

^PERFMONを使ったObjectScriptのパフォーマンス計測方法を解説。インスタンス全体の動作を可視化し、グローバル・ルーチン・DB・ネットワーク別にボトルネックを特定する手順と出力方法を紹介します。

※出力内容などの詳細については、本記事では割愛します。

今回は、^PERFMON をコマンドから実行する方法を解説します。
毎回ターミナルから設定・出力を行うのが煩雑に感じる場合は、ぜひ本手法をお試しください。

全体の流れ

まずは、全体の処理フローを確認します。

^PREFMONの流れ

Start Monitor（開始）
[計測中]
Pause Monitor（一時停止）
Report Statistics（レポート出力）
Stop Monitor（停止）

コマンドで実行すると、以下のようになります。

zn "%SYS"
d $$Start^PERFMON() // ① Start Monitor

// 計測中

d $$Pause^PERFMON() // ③ Pause Monitor
d $$Report^PERFMON("R","P","P","D:\Temp\csv\sample.txt") // ④ Report Statistics
d $$Stop^PERFMON() // ⑤ Stop Monitor

それでは、各処理について順に確認していきます。

開始（Start Monitor)

最初に計測の開始です。

実行するネームスペースは「％SYS」になります。

zn "%SYS"
s flg = $$Start^PERFMON([process],[routine],[global],[database],[network])

項目	説明
process	プロセス用スロット数（デフォルト：プロセステーブル数）
routine	ルーチン用スロット数（デフォルト：200）
global	グローバル用スロット数（デフォルト：100）
database	データベース用スロット数（デフォルト：10）
network	ネットワークノード数（デフォルト：5）

※ターミナル実行時に表示される設定値が、そのまま引数として指定可能です。

戻り値の「flg」は％Integer型です。

戻り値	説明
1	成功
-1	他のユーザが実行中
-2	実行中
-3	メモリの割り当てに失敗
-4	上記以外でのエラー

■連続実行した時の各戻り値を確認

一時停止（Pause Monitor）

一時停止は引数なしで実行できます。

s flg = $$Pause^PERFMON()

戻り値	説明
1	成功
-1	他のユーザが実行中
-2	開始していない
-3	既に停止中

■連続実行した時の各戻り値を確認

レポート出力（Report Statistics）

計測結果をファイルとして出力します。

s flg = $$Report^PERFMON([report],[sort],[format],[output],[list],[data])

// サンプル
w $$Report^PERFMON("R","P","P","D:\Temp\csv\sample.txt")

どのようなファイルが出力できるのかは、前回の記事を参照してください。

引数	説明
report	出力するレポートの種類　– 必須 G:グローバル動作, R:ルーチン動作, N:ネットワーク動作, C:カスタム
sort	レポートのグループ分けと並べ替えの順序　– 必須 P:プロセス, R:ルーチン, G:グローバル, D:データベース, I:着信ノード, O:発信ノード
format	出力形式　– 必須 P:テキスト, D:CSV, X:エクセル, H:HTML
output	ファイル名　– 必須ファイル名を入力する or 0(画面出力) or 未指定(規定ファイル名)
list	report=C (カスタム)選択時メトリックの番号をカンマ区切りで記述する
data	レポートするデータの種類 1:1 秒あたりの標準比率, 0:未加工の合計データ

ファイル出力に慣れるまでは、エラーをよく見る事になると思います。
戻り値から、何が問題なのかが分かりやすいので、うまく出力できない場合は、戻り値を確認して下さい。

戻り値	説明
1	成功
-1	未実行
-2	引数がない
-3	カテゴリの設定値に問題あり
-4	ソートの設定値に問題あり
-5	ファイルタイプの設定値に問題あり
-6	[list]の設定値に問題あり
-7	データの形式に不正あり

停止（Stop Monitor）

最後に計測を停止します。

s flg = $$Stop^PERFMON()

戻り値	説明
1	成功
-1	他のユーザが実行中
-2	開始していない

■連続実行した時の各戻り値を確認

その他

測定値のクリア

s flg = $$Clear^PERFMON()

戻り値	説明
1	成功
-1	他のユーザが実行中
-2	開始していない

■クリア>停止>クリアの順に実行した際の戻り値を確認

Collect

指定時間内でパフォーマンスデータを自動収集します。

s flg = $$Clear^PERFMON([time],[format],[output])

引数	説明
time	収集時間（デフォルト：30秒）
format	HTML : HTMLファイル ※XMLはデフォルトのため省略可能
output	ファイル名（フルパス）ファイル名を入力する or 0(画面出力) or 未指定(規定ファイル名)

Collectは、１つのファイルに下記データ種をまとめて出力します。

出力されるデータ種