IRISで使用できるユーティリティ一覧

記事

Megumi Kakechi · 2022年8月22日 16m read

#システム管理 #ヒントとコツ #InterSystems IRIS #InterSystems IRIS for Health

InterSystems IRIS で使用できるユーティリティの一部を一覧でご紹介します。

以下の表の各ユーティリティ名をクリックすると、ユーティリティの詳細情報をご覧いただけます。

ユーティリティ名	概要
^BACKUP	バックアップやリストア処理を行います
^DATABASE	データベースの作成・編集・削除など、データベースの管理を行います
^DATACHECK	2つのIRIS.DAT の内容が一致しているかを確認します
^DBSIZE	データベースサイズを計測します
^GBLOCKCOPY	データベース内のグローバルデータを別データベースまたはネームスペースにコピーします
^GETPPGINFO	IRISTEMPデータベースでどのような一時グローバルを使用しているかを確認します
^%GCMP	２つのグローバルの内容を単純比較します
^%GSIZE	ネームスペース内の各グローバルのデータサイズを確認します
^Integrity/ ^INTEGRIT	データベースのセット、またはデータベース内のグローバルのサブセットの構造的な整合性を検証します
^JOBEXAM	プロセス一覧を表示します。各プロセス詳細情報の表示や停止も行えます
^JOURNAL	ジャーナリングを構成します
^LOCKTAB	現在使用しているロック情報の表示と削除を行います
^mgstat	サンプリング周期単位でグローバルアクセスのカウンター情報を連続してファイルに記録します
^MIRROR	ミラーリング構成、管理、およびステータスの操作などを行います
^MONMGR	メッセージログ(messages.log)を監視して通知を生成したり電子メールを送信します
^SECURITY	IRISセキュリティが適切に機能するのに必須のデータの設定とメンテナンスを実行します
^RESJOB	IRISプロセスを停止します
^%SS	プロセス一覧を表示します(参照のみ)。
^SYSLOG	共有メモリの一部分に記録している、IRIS内部のエラーログ情報を出力します
^SystemCheck （旧：^Buttons）	IRISが使用しているプロセスの状態や共有メモリなどの情報収集を行います
^SystemPerformance	IRISおよびインスタンスが稼働するプラットフォームに関する詳細なパフォーマンスデータを収集します
^TASKMGR	タスクのスケジュールや管理を行います

※%付きのユーティリティ以外はすべて %SYS ネームスペースで実行する必要があります。
※管理ポータル：は、管理ポータルから実行できる対象機能になります。
※★＜ユーティリティ名＞をクリックすると製品ドキュメントの説明をご覧いただけます（一部記載なし）

★^BACKUP

バックアップやリストア処理を行います。
^BACKUPユーティリティには以下のようなメニューがあります。

%SYS>do ^BACKUP
1) Backup                                        // データベースのバックアップを行います
2) Restore ALL                                   // すべてのデータベースのリストアを行います
3) Restore Selected or Renamed Directories       // 選択したデータベースのリストアを行います
4) Edit/Display List of Directories for Backups  // バックアップに必要なディレクトリ・リストの編集/表示を行います
5) Abort Backup                                  // 実行中のバックアップを中止します
6) Display Backup volume information             // バックアップ・ボリュームに関する情報を表示します
7) Monitor progress of backup or restore         // バックアップまたはリストアの進行状況を監視します

管理ポータル：
システムオペレーション > バックアップ

【ご参考】
データベースのバックアップについて(InterSystems Symposia 2014)
累積バックアップと差分バックアップの違いについて
 稼働中のインスタンスを停止せずにバックアップを行う方法
 データベースのバックアップ方法について

★^DATABASE

データベースの作成・編集・削除など、データベースの管理に使用します。
^DATABASEユーティリティには以下のようなメニューがあります。

%SYS>do ^DATABASE
 1) Create a database                    // 新しいデータベースを作成します
 2) Edit a database                      // 既存データベースの属性を変更します
 3) List databases                       // データベースの一覧を表示します
 4) Delete a database                    // 既存データベースを削除します
 5) Mount a database                     // データベースのマウントを行います
 6) Dismount a database                  // データベースをディスマウントします
 7) Compact globals in a database        // データベースのグローバルの圧縮を行います。この機能は使用可能バージョンに制限(※)があります。
 8) Show free space for a database       // データベースの使用可能な空き容量を表示します
 9) Show details for a database          // 指定されたデータベースの詳細情報を表示します
10) Recreate a database                  // 既存のデータベースのパラメータに基づいて、新しい空のデータベースを作成します
11) Manage database encryption           // データベース暗号化の管理を行います
12) Return unused space for a database   // データベースの未使用領域を解放します
13) Compact free space in a database     // データベースの空き容量を圧縮します。この機能は使用可能バージョンに制限(※)ががあります。
14) Defragment a database                // データベースのデフラグを行います。この機能は使用可能バージョンに制限(※)ががあります。
15) Show background database tasks       // バックグラウンドのデータベースタスクを表示します

※制限：圧縮やデフラグの機能は、ご利用のバージョンによって使用できない場合がありますのでご注意ください。
　　　　詳細はこちらをご覧ください。

管理ポータル：
システム管理 > 構成 > システム構成 > データベース

【ご参考】
データベースファイルのサイズを圧縮する方法
 ターミナルやAPIを使用してネームスペースやデータベースを作成する方法
 プログラムでデータベースをマウント／ディスマウントする方法

★^DATACHECK

2つのIRIS.DAT の内容が一致しているかを確認します。

【ご参考】
2つのデータベースにある複数のグローバルやルーチンを比較する方法

★^DBSIZE

データベースサイズを計測します。
例えば、バックアップを実行する直前に、バックアップに必要なディスク領域を計算するのに使用します。

【ご参考】
オンラインバックアップでのバックアップサイズを見積もる方法

★^GBLOCKCOPY

データベース内のグローバルデータを、別データベース・またはネームスペースにコピーします。
その際、余計なサイズ(Killされて空いたサイズ)はコピーされないので、データベースの縮小が可能です。

【ご参考】
【FAQ】データベースファイル IRIS.DAT のサイズを小さくするにはどうすればいいですか？

★^GETPPGINFO

現在の全てのプロセスプライベートグローバルの名前およびそれらのスペース割り当てをブロック単位で表示します。

【ご参考】
IRISTEMPデータベースでどの一時グローバルがサイズ消費しているかを特定する方法
 プロセス・プライベート・グローバルとは

★^%GCMP

２つのグローバルに違いがないか内容を比較をします。

【ご参考】
２つのグローバルの内容を比較する方法

★^%GSIZE

ネームスペース内の各グローバルのデータサイズを確認します。

管理ポータル：
システム管理 > 構成 > ローカルデータベース > グローバル

【ご参考】
各グローバルのデータサイズを調べる方法
 ^%GSIZE で出力される各項目の意味

★^Integrity または ^INTEGRIT

データベースのセット、またはデータベース内のグローバルのサブセットの構造的な整合性を検証します。

%SYS>do ^Integrity
This utility is used to check the integrity of a database
and the pointer structure of one or more globals.
 
Output results on
Device:                // ファイルに出力したい場合はファイルパスを入力
Right margin: 80 =>
 
Stop after any error?  No=>
Do you want to check all databases?  No=> Y    // 全てのデータベースをチェック
                                               // No の場合はデータベースディレクトリを指定
:

管理ポータル：
システムオペレーション > データベース > 整合性チェック

★^JOBEXAM

プロセス一覧を表示します。各プロセス詳細の表示や停止も行えます。

管理ポータル：
システムオペレーション > プロセス

★^JOURNAL

ジャーナリングを構成します。
^JOURNALユーティリティには以下のようなメニューがあります。

%SYS>do ^JOURNAL
 1) Begin Journaling (^JRNSTART)             // ジャーナリングの開始
 2) Stop Journaling (^JRNSTOP)               // ジャーナリングの停止
 3) Switch Journal File (^JRNSWTCH)          // ジャーナルファイルの切り替え
 4) Restore Globals From Journal (^JRNRESTO) // ジャーナルファイルのリストア
 5) Display Journal File (^JRNDUMP)          // ジャーナルファイルの表示
 6) Purge Journal Files (PURGE^JOURNAL)      // ジャーナルファイルの削除
 7) Edit Journal Properties (^JRNOPTS)       // ジャーナルオプションの変更
 8) Activate or Deactivate Journal Encryption (ENCRYPT^JOURNAL())    // ジャーナルファイル暗号化の Activate/Deactivate
 9) Display Journal status (Status^JOURNAL)  // 現在のジャーナル状態の表示
10) -not available-
11) -not available-
12) Journal catch-up for mirrored databases (MirrorCatchup^JRNRESTO) // ミラーデータベースのジャーナルキャッチアップ
13) -not available-

管理ポータル：
システム管理 > 構成 > システム構成 > ジャーナル設定
システムオペレーション > ジャーナル

★^LOCKTAB

現在使用しているロック情報の表示と削除を行います。

管理ポータル：
システムオペレーション > ロック

【ご参考】
プログラム内でロック情報を取得する方法

★^mgstat

サンプリング周期(既定は2秒)単位でグローバルアクセスのカウンター情報を連続してファイルに記録します。
^mgstat は、^SystemPerformance ユーティリティを実行した場合にも実行され、HTML パフォーマンスレポートに含められます。

【ご参考】
Grafana ベースの mgstat（InterSystems Caché / Ensemble / HealthShareのシステム監視ツール）用 GUI

★^MIRROR

ミラーリング構成、管理、およびステータスの操作などを行います。

管理ポータル：
システム管理 > 構成 > ミラー設定

【ご参考】
データベースミラーリングを使用した HA および DR の構成例
 パフォーマンス101
ミラージャーナルファイルの削除のタイミングと要件
 ミラーリングの機能について

★^MONMGR

IRISインスタンスのメッセージログ（messages.log）を監視して、システムからレポートされたアラートを検出し、通知を生成したり（alert.log）、電子メールを送信します。

【ご参考】
メッセージログ(messages.log) のログ深刻度が 2 以上でメールを送るようにする方法

★^RESJOB

プロセスIDを指定して、実行中のIRISプロセスを停止します（現在のプロセスは停止できません）。^JOBEXAMを使うと、すべての実行中のプロセスのリストが表示されるので、その中で停止 (終了)、中断、または再開するプロセスを指定できます。

USER>zn "%SYS"
%SYS>do ^RESJOB
Force a process to quit InterSystems IRIS
 
Process ID (? for status report): 17456    // 消したいプロセスのPIDを入力して <Enter> すると消える
Process ID (? for status report):          // ? を入れるとプロセス一覧が表示される「「

現在のプロセスは、以下で停止できる。

 DO $SYSTEM.Process.Terminate()

以下は、^RESJOB ユーティリティと同じで、現在のプロセス以外のその他のプロセスを停止する。

 DO $SYSTEM.Process.Terminate(17456)

★^SECURITY

IRISセキュリティが適切に機能するのに必須のデータの設定とメンテナンスを実行します。
^SECURITYユーティリティには以下のようなメニューがあります。

%SYS>do ^SECURITY
1) User setup                     // ユーザ定義の表示、追加、編集を行います
2) Role setup                     // ロール定義の表示、追加、編集を行います
3) Service setup                  // サービス定義を表示または編集します
4) Resource setup                 //  リソース定義の表示、追加、編集を行います
5) Application setup              // アプリケーション定義の表示、追加、編集を行います
6) Auditing setup                 // 監査ログの閲覧や、エクスポートを行います
8) SSL configuration setup        // SSL/TLS 構成の表示、追加、編集を行います
9) Mobile phone service provider setup  // 携帯電話サービスプロバイダ定義を表示または編集します
10) OpenAM Identity Services setup      // OpenAM ID サービスを設定します
11) Encryption key setup          // データベース暗号化キーファイルの作成や管理を行います
12) System parameter setup        // システムワイドセキュリティパラメータの参照と編集を行います
13) X509 User setup               // ウェブサービスセキュリティで使用する X.509 認証情報の表示、追加、編集を行います
14) KMIP server setup             // KMIP(Key Management Interoperability Protocol) サーバの管理・構成を行います
15) Exit

管理ポータル：
システム管理 > セキュリティ

【ご参考】
CSP/RESTアプリケーションに接続できません。どのように調査すれば良いですか？
セキュリティ設定のエクスポートとインポートに関するTips

★^%SS

現システムでアクティブな各プロセスの状態の情報を一覧表示します（参照機能のみ）。
各プロセスの詳細情報を表示したり、プロセスを終了したい場合は ^JOBEXAM を使用します。

管理ポータル：
システムオペレーション > プロセス

★^SYSLOG

共有メモリの一部分に記録している、IRIS内部のエラーログ情報を出力します。
このログには、システムに何らかの問題が生じている場合の重要な診断情報が含まれることがあります。

1) 実行方法は以下のようになります。

USER>zn "%SYS"
%SYS>do ^SYSLOG
Device:   // Enter 押下、または出力ファイルパスを入力
Right margin: 80 =>   // Enter 押下
Show detail? No => Yes   // Yes + <Enter> 押下
InterSystems IRIS System Error Log printed on May 19 2023 at 11:53 AM
--------------------------------------------------------
Printing the last 8 entries out of 8 total occurrences.
Err   Process    Date/Time           Mod Line  Routine            Namespace
3     30848      05/19/2023 09:01:02AM 91 1304 BF0+1373^SYS.Datab %SYS
:

※上記は Err = 3 なので、オペレーティングシステムエラーの「指定されたパスが見つかりません」のエラーになります。
Errは必ずしもオペレーティングシステムのエラーとは限りません。詳細はサポートセンターまでお問い合わせください。

C:\>net helpmsg 3
指定されたパスが見つかりません。

2) SYSLOG情報は共有メモリに保存される情報であるため、IRISを停止すると失われます。
以下のIRIS構成パラメータ設定することにより、IRIS停止時に内部エラーログ情報をmessages.log に記録します。

管理ポータル：
システム管理 > 構成 > 追加の設定 > 互換性
ShutDownLogErrors 偽(既定値) -> 真

【ご参考】
syslog-その正体と意味するもの

★^SystemCheck

IRISが使用しているプロセスの状態や共有メモリなどの情報収集を行います。
トラブル発生時には、まずこちらの診断レポート情報（^SystemCheck）を取得していただきます。
※Caché/Ensemble では ^Buttons というユーティリティ名でした

実行方法は以下のようになります（取得に数分間要します）。

%SYS>do ^SystemCheck
Diagnostic Report Build # 087 Evidence Logging Tool
 
This reporting tool provides the information required for InterSystems
Technical Support to analyze most issues. Please send the resulting file with
each and every new problem sent to Support.
 
This process will take approximately 5 minutes to complete. Please be patient.
 
Continue (Y)? y    // Enter 押下または yes(y) を指定します
Report Interoperability-specific info? [No] n    //no(n) を指定します
Collecting information, please do not interrupt this process.

Please wait approximately 30 seconds for %SS snapshots.
Please wait approximately 1 minute for "irisstat" snapshots.
 
GloStat information now being collected.
Please wait approximately 1 minute and 40 seconds.
 
FTP the following files to ISC Support:
c:\intersystems\iris\mgr\***202208260909.html in text mode - 579,486 bytes
%SYS>
// <インストールディレクトリ>\mgr 下にhtmlファイルが出力されます。***部分は使用されているライセンスにより異なります

Cache の場合、^Buttons情報の取得は以下のようになります。

%SYS>do ^Buttons
Diagnostic Report Build # 087 Evidence Logging Tool
 
This reporting tool provides the information required for InterSystems
Technical Support to analyze most issues. Please send the resulting file with
each and every new problem sent to Support.
 
This process will take approximately 5 minutes to complete. Please be patient.
 
Continue (Y)?       // Enter 押下または yes(y) を指定します
Please wait approximately 30 seconds for %SS snapshots.
Please wait approximately 1 minute for "cstat" snapshots.
 
GloStat information now being collected.
Please wait approximately 1 minute and 40 seconds.
 
Log file saved to: c:\intersystems\cache\mgr\***202407291050.html, 1,955,622 bytes
Upload the file(s) above to InterSystems Support.
%SYS>
// <インストールディレクトリ>\mgr 下にhtmlファイルが出力されます。***部分は使用されているライセンスにより異なります

【注意】
2023.1.0より前のバージョンでは、^SystemCheck情報収集時にONにする「ECP」と「ミラーリング」のデバッグフラグがOFFにならない（クリアされない）事象が発生する場合があります。
対象バージョンをご使用の場合、^SystemCheck 情報取得後、以下のコマンドでデバッグフラグをクリアするようにしてください。

%SYS>Do ^REDEBUG
Old flag values = *****   // FF ではないときはクリアが必要
New flag values (in Hex): FF  // FF でクリア設定
Done

%SYS>

システムがハング状態になるなどしてターミナルが開けない場合は、Windowsコマンドプロンプトより IRISHung.cmd (Linux系は IRISHung.sh) を実行します。
数分後、<IRISインストールディレクトリ>\mgr 下に、IRISHung_mmss.html ファイルが生成されます。

C:\>cd /intersystems/iris/bin    // <インストールディレクトリ>\bin に移動
C:\InterSystems\IRIS\bin>IRISHung.cmd

Full name of InterSystems IRIS directory: C:\InterSystems\IRIS    // IRISインストールディレクトリを入力
Writing information to "C:\InterSystems\IRIS\Mgr\IRISHung_mmss.html"
Please wait...

Log file saved to:
"C:\InterSystems\IRIS\Mgr\IRISHung_mmss.html"
File size is ***** bytes long

C:\InterSystems\IRIS\bin>

【ご参考】
InterSystems IRISトラブル対応ガイド～情報収集編～（^SystemCheck／IRISHungの使い方）
※P.7 (1).診断レポート（^SystemCheck）の実行

【IRISベース】トラブル発生時の情報収集方法（IRIS ／ IRIS for Health ／ UCR 編）