SNMP を使用した InterSystems IRIS の監視

InterSystems IRIS での SNMP の使用法

SNMP は、クライアント (ネットワーク管理アプリケーション) がサーバ・プログラム (SNMP エージェント) に接続するクライアント・サーバ関係を定義します。このサーバ・プログラムは、リモート・ネットワーク・デバイスまたはコンピュータ・システム上で実行されます。クライアントは、エージェントに対して情報を要求し、エージェントから情報を受け取ります。SNMP メッセージには次の 4 つの基本タイプがあります。

• GET – 特定の管理対象オブジェクトのデータを取得します。

• GETNEXT – 階層ツリーで、次に位置している管理対象オブジェクトのデータを取得します。これによって、システム管理者は、デバイスのすべてのデータを参照できます。

• SET – 特定の管理対象オブジェクトの値を設定します。

• TRAP – 管理対象のデバイスまたはシステムが送信した非同期アラート。

SNMP MIB (Management Information Base) には、管理対象オブジェクトの定義が格納されます。各デバイスは、標準 MIB のどの部分をサポートしているかを定義するファイル (MIB)、および管理対象オブジェクトのカスタム定義を発行します。InterSystems IRIS では ISC-IRIS.mib ファイルがこれに相当します。このファイルは、install-dir\SNMP ディレクトリに配置されています。

サブエージェントとしての InterSystems IRIS

SNMP クライアントは、既知のアドレス (ポート 161) で待ち受け状態にある SNMP エージェントに接続します。クライアントは常にこのポートを介して接続するので、コンピュータ・システム上では 1 つの SNMP エージェントしか実行できません。システム上の複数のアプリケーションにアクセスする必要がある場合は、マスタ・エージェントを実装します。これによって、複数のサブエージェントに接続できるようになります。インターシステムズでは、SNMP マスタ・エージェントを介して通信するサブエージェントとして InterSystems IRIS SNMP インタフェースを実装しています。

InterSystems IRIS がサポートしているほとんどのオペレーティング・システムには、複数のサブエージェントをサポートするように拡張できる SNMP マスタ・エージェントが備わっています。ただし、多くの場合、これらのエージェントの拡張性は互換性のない独自の方法で実装されています。InterSystems IRIS は、RFC 2741Opens in a new tab で定義されている IETF 推奨の標準プロトコル AgentX (Agent Extensibility) を使用してサブエージェントを実装しています。

一部の標準 SNMP マスタ・エージェントは AgentX をサポートしています。オペレーティング・システムで提供されている SNMP マスタ・エージェントが AgentX 互換でない場合は、代わりに、パブリック・ドメイン Net-SNMP エージェントを使用できます。

InterSystems IRIS での SNMP の管理

SNMP は標準プロトコルなので、InterSystems IRIS サブエージェントの管理は最小限で済みます。最も重要な作業は、システム上の SNMP マスタ・エージェントが AgentX (Agent Extensibility) プロトコル ("サブエージェントとしての InterSystems IRIS" を参照してください) と互換性があることを確認し、標準の AgentX TCP ポート 705 で接続要求を待ち受けるように設定することです。Windows システムの場合、標準 Windows SNMP サービスに接続するための DLL がシステムによって自動的にインストールされます。Windows SNMP サービスがインストールされており、自動または手動で開始されていることを確認してください。

次に、以下の手順で、監視サービスを有効にします。

1. 管理ポータルの [サービス] ページ ([システム管理] > [セキュリティ] > [サービス]) に移動します。

2. %Service_Monitor サービスをクリックします。

3. [サービス有効] チェック・ボックスにチェックを付けて、[保存] をクリックします。

4. サービス・リストのページに戻り、%Service_Monitor サービスが有効になっていることを確認してください。

最後に、InterSystems IRIS を起動したとき、InterSystems IRIS SNMP サブエージェントが自動的に開始されるように構成するには、以下の手順に従います。

1. 管理ポータルの [モニタ設定] ページ ([システム管理] > [構成] > [追加設定] > [モニタ]) に移動します。

2. [システム開始時にSNMPエージェントを開始] の設定で、[はい] を選択して、[保存] をクリックします。

3. この設定を編集した場合、InterSystems IRIS 側の SNMP インタフェースは即座に停止した後に開始します。

^SNMP ルーチンを使用して、InterSystems IRIS SNMP サブエージェントを手動で、またはプログラム的に開始および停止することもできます。

Do start^SNMP(<port>,<timeout>)
Do stop^SNMP

ここで、<port> は、接続に使用する TCP ポート (既定は 705)、<timeout> は TCP ポートの読み取りタイムアウト値 (既定は 20 秒) です。InterSystems IRIS は、<timeout> 値に達するまで、接続の確立時や要求への応答時に発生した問題を install-dir\mgr ディレクトリにある SNMP.LOG ファイルに記録します。

SNMP のトラブルシューティング

InterSystems IRIS サブエージェント (^SNMP ルーチンを実行) は、オペレーティング・システムが提供する SNMP マスタ・エージェントが適切にインストールおよび構成されていることを前提としています。"サブエージェントとしての InterSystems IRIS" の説明のとおり、^SNMP ルーチンはこのマスタ・エージェントと主に 2 つの方法で通信します。

• 基本的に、^SNMP は、TCP ポート 705 で AgentX プロトコルを使用します。

• Windows では ^SNMP は、iscsnmp.dll としてインストールされた Windows 拡張エージェント DLL を使用します。

SNMP エージェントの構成手順の詳細は、オペレーティング・システムで提供されており、システム管理者はこの構成方法を理解するために時間を取る必要があります。以下に、InterSystems IRIS と SNMP エージェントの通信を行う際に問題が発生した場合のトラブルシューティングの基本的なガイドラインとヒントを示します。

InterSystems IRIS MIB 構造

InterSystems IRIS SNMP インタフェースを介して取得できるすべての管理対象オブジェクト・データは、InterSystems IRIS MIB ファイル ISC-IRIS.mib で定義されています。このファイルは、install-dir\SNMP ディレクトリにあります。通常、SNMP 管理アプリケーションが情報を理解して、適切に表示するためには、管理対象アプリケーションの MIB ファイルをロードする必要があります。この手順はアプリケーションによって異なるため、InterSystems IRIS MIB のロード方法については、使用する管理アプリケーションのドキュメントを参照してください。

InterSystems IRIS MIB で定義されているデータはこのファイル自体に詳しく記載されているので、ここでは説明しません。InterSystems IRIS MIB ツリーの全体的な構造を理解しておくと、同一システム上で複数のインスタンスを実行する場合などに非常に役立ちます。

SNMP では、すべての管理対象オブジェクトを網羅する特別な階層ツリー構造である SMI (Structure of Management Information) が定義されています。詳細は RFC 1155Opens in a new tab で規定されています。それぞれの管理対象オブジェクトには、一連の整数をピリオドで区切って表される一意なオブジェクト識別子 (OID) が割り当てられます (例：1.3.6.1.2.1.1.1)。MIB は、このドット区切り整数識別子をテキスト名に変換します。

標準の SNMP MIB では、多数の標準管理対象オブジェクトが定義されています。標準 MIB のアプリケーション特有拡張を定義する場合、InterSystems IRIS と同様、アプリケーションでは以下のように enterprise 分岐を使用します。

iso.org.dod.internet.private.enterprises (1.3.6.1.4.1)

IANA (Internet Assigned Numbers Authority) では、階層の次のレベルに該当するプライベートなエンタープライズ番号を各組織に割り当てています。InterSystems IRIS の場合、この番号は intersystems を表す 16563 です。

この下に、以下のように InterSystems IRIS のエンタープライズ・プライベート・サブツリーが実装されています。

• intersystems の下位レベルは、“製品” ID またはアプリケーション ID のレベルです。InterSystems IRIS の場合、これは .4 (iscIris) です。この番号は、MIB モジュール ID として使用できます。

• 次のレベルは “オブジェクト” のレベルで、ここでは通知からデータ・オブジェクトが抽出されます。InterSystems IRIS の場合、これらは .1 (irisObjects) と .2 (irisTraps) です。慣例により、intersystems ツリーでは、すべてのデータ・オブジェクトと通知名に小文字の短い接頭語が追加されます。InterSystems IRIS の場合、これは iris です。

• 次のレベルは “テーブル” (グループ・レベル) です。すべてのデータ・オブジェクトはテーブルとして管理されます。テーブルに含まれるインスタンス (“行”) が 1 つしかない場合も同様です。これによって、管理データ・オブジェクトをグループ化することができます。また、1 台のマシン上で複数の InterSystems IRIS インスタンスを実行する場合も、テーブルが必要になります。テーブルの最初のインデックスでは、必ず InterSystems IRIS のインスタンス名が使用されます。テーブルに複数のインデックスが含まれる場合もあります。

• 次のレベルは、(SNMP SMI で義務付けられている) テーブルの “概念行” で、常に .1 です。

• 最後に、インデックスとして指定されているデータを含め、テーブル内の個々のデータ・オブジェクトが配置されます。

• 通知 (トラップ) は、“テーブル” と同じ階層レベルで、個々のエントリとして定義されます。詳細は、この付録の "InterSystems IRIS SNMP トラップ" を参照してください。

• 通知 (トラップ) を介して送信される InterSystems IRIS 固有の予備オブジェクトは、“テーブル” と同じ階層レベルで、個々のエントリとして定義されます。詳細は、この付録の "InterSystems IRIS SNMP トラップ" を参照してください。

例えば、データベースのサイズが、

1.3.6.1.4.1.16563.4.1.3.1.6.4.84.69.83.84.1

としてコード化されている場合、このコードは以下の内容を表しています。

iso.org.dod.internet.private.enterprises.intersystems.isciris.irisObjects
irisDBTab.irisDBRow.irisDBSize.TEST(instname).1(DBindex)

サンプル・ユーザ定義 SNMP モニタ・クラス

このセクションでは、SNMP を介したクエリの対象とすることができるユーザ・アプリケーション・モニタ・クラス (このドキュメントの “システム・モニタの使用” の章の "アプリケーション・モニタ" を参照) の定義方法の例を示します。アプリケーション・モニタは、SNMP データの %Monitor データ型のプロパティのみを含んでいます。

この例のサンプル・クラスは以下のとおりです。

Class SNMP.Example Extends %Monitor.Adaptor
{

  /// Give the application a name. This allows you to group different 
  /// classes together under the same application level in the SNMP MIB.
  /// The default is the same as the Package name.
  Parameter APPLICATION = "MyApp";

  /// This groups a set of properties together at the "table" level of the
  /// SNMP MIB hierarchy. The default is the Class name.
  Parameter GROUPNAME = "MyTable";

  /// An integer metric counter
  Property Counter1 As %Monitor.Integer;

  /// Another integer metric counter
  Property Counter2 As %Monitor.Integer;

  /// A status indicator as a string data type
  Property Status As %Monitor.String;

  /// The method is REQUIRED. It is where the Application Monitor
  /// calls to collect data samples, which then get picked up by the
  /// ^SNMP server process when requested.
  Method GetSample() As %Status
  {
    set ..Counter1=$r(200)
    set ..Counter2=200+$r(100)
    set n=$r(4)
    set ..Status=$s(n=1:"Crashed",n=2:"Warning",n=3:"Error",1:"Normal")
    Quit $$$OK
  }

}

このクラスをユーザのネームスペースでコンパイルする前に、InterSystems IRIS はサポートするクラスをそのユーザのネームスペースにロードする必要があります。これらのクラスは、SNMP のデータ・サンプルを保存するために必要です。

クラスをロードするには、このドキュメントの “システム・モニタの使用” の章の "^%SYSMONMGR を使用したアプリケーション・モニタの管理" の説明に従って ^%SYSMONMGR を実行し、以下の操作を行います。

• オプション 2 の Manage Monitor Classes (モニタ・クラスの管理) を選択します。

• オプション 3 の Register Monitor System Classes (モニタ・システム・クラスの登録) を選択します。

サンプル・クラスをコンパイルするときに、サンプル・データを格納するための SNMP.Sample.Example クラスが作成されます。

^%SYSMONMGR を実行して、サンプル・クラスを有効化し、アプリケーション・モニタを起動してサンプルを収集します。

1. オプション 2 の Manage Monitor Classes (モニタ・クラスの管理) を選択します。

2. オプション 1 の Activate/Deactivate a Monitor Class (モニタ・クラスの有効化/無効化) を選択します。

3. 登録済みのモニタ・クラスの番号付きリストを表示するには「?」を入力します。

4. 有効化するモニタ・クラスの番号を入力します。例えば、SNMP.Example というユーザ定義クラスを有効にするには、クラス名の横にある番号を入力します。

5. オプション 6 の Exit (終了) を選択します (アプリケーション・モニタのメイン・メニューに戻ります)。

6. オプション 1 の Manage Application Monitor (アプリケーション・モニタの管理) を選択します。

7. オプション 1 の Start Application Monitor (アプリケーション・モニタの開始) を選択します。

8. オプション 5 の Exit (終了) を選択します (アプリケーション・モニタのメイン・メニューに戻ります)。

9. オプション 6 の Exit (終了) を選択します (アプリケーション・モニタのメイン・メニューを終了します)。

SNMP MIB を作成するには、%SYS ネームスペースで MonitorTools.SNMP:CreateMIB メソッドを実行します。詳細は、MonitorTools.SNMPOpens in a new tab クラス・ドキュメントを参照してください。

このメソッドに対する入力パラメータは、以下のようになります。

CreateMIB("MyApp","USER",99990,1,"mycorp","myapp","mc","MC-MYAPP","Unknown",1)

USER>set $namespace = "%SYS"
 
%SYS>Do ##class(MonitorTools.SNMP).CreateMIB("MyApp","USER",99990,1,"mycorp",
"myapp","mc","MC-MYAPP","Unknown",1)
 
 
Create SNMP structure for Application - MyApp
 
     Group - MyTable
          Counter1 = Integer
          Counter2 = Integer
          Status = String
 
 
Create MIB file for MyApp
 
     Generate table MyTable
          Add object Counter1
          Add object Counter2
          Add object Status
 
 
%SYS>

これにより、既定のディレクトリ (install-dir\mgr\User) に MC-MYAPP.MIB ファイルが作成されます。このファイルを、使用する SNMP 管理アプリケーションにロードできます。

--
-- MIB file generated for mcMyApp product.
--
-- Sep 16, 2008
--

MC-MYAPP DEFINITIONS ::= BEGIN

IMPORTS

  MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE,
  Counter32, Gauge32, Integer32
  FROM SNMPv2-SMI
  DisplayString
  FROM SNMPv2-TC
  enterprises
  FROM RFC1155-SMI
  cacheSysIndex
  FROM ISC-IRIS;


mcMyApp MODULE-IDENTITY
    LAST-UPDATED "200809161700Z"
    ORGANIZATION "mycorp"
    CONTACT-INFO "
                    Unknown"
    DESCRIPTION ""
    ::= { mycorp 1 }

mycorp OBJECT IDENTIFIER ::= { enterprises 16563 }

myappObjects OBJECT IDENTIFIER ::= { mcMyApp 1 }

--
-- Begin tables
--

-- Table myappMyTable

myappMyTable         OBJECT-TYPE
       SYNTAX        SEQUENCE OF myappMyTableR
       MAX-ACCESS    not-accessible
       STATUS        current
       DESCRIPTION
       ""
   ::= { myappObjects 1 }

myappMyTableR        OBJECT-TYPE
       SYNTAX        myappMyTableR
       MAX-ACCESS    not-accessible
       STATUS        current
       DESCRIPTION
       "Conceptual row for MyTable table."
       INDEX  { cacheSysIndex }
   ::= { myappMyTable 1 }

myappMyTableR ::=
       SEQUENCE {
        myappCounter1   Integer32
        myappCounter2   Integer32
        myappStatus   DisplayString
       }

myappCounter1        OBJECT-TYPE
       SYNTAX        Integer32
       MAX-ACCESS    read-only
       STATUS        current
       DESCRIPTION
       ""
       ::= { myappMyTableR 1 }

myappCounter2        OBJECT-TYPE
       SYNTAX        Integer32
       MAX-ACCESS    read-only
       STATUS        current
       DESCRIPTION
       ""
       ::= { myappMyTableR 2 }

myappStatus          OBJECT-TYPE
       SYNTAX        DisplayString
       MAX-ACCESS    read-only
       STATUS        current
       DESCRIPTION
       "Status"
       ::= { myappMyTableR 3 }

--  End of MyTable table

myappTraps  OBJECT IDENTIFIER ::= { mcMyApp 2 }

-------------------------------------------------------------
 END