SNMP を使用した Caché の監視

Caché での SNMP の使用法

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

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

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

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

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

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

サブエージェントとしての Caché

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

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

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

Caché での SNMP の管理

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

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

1. 管理ポータルで、[システム]→[セキュリティ管理]→[サービス] に移動します。

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

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

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

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

1. 管理ポータルで、[システム]→[構成]→[モニタ設定] に移動します。

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

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

^SNMP ルーチンを使用して、Caché SNMP サブエージェントを手動で開始および停止することもできます。

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

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

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

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

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

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

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

すべてのシステム ：

• SNMP エージェントが Caché から独立して動作し、少なくとも一般的なシステム情報について mib-2.system ツリーへクエリを実行できることを確認してください。これに失敗したときには、Windows の場合は Windows SNMP サービスを確認してください。Unix®/Linux の場合は SNMP デーモン (snmpd) が実行されているかどうかを確認してください。

• SNMP システム情報を正常にクエリできるが、Caché MIB をクエリできない場合は、Caché で ^SNMP ルーチンを実行するバックグラウンド・プロセスを確認します。$$start^SNMP() 関数を使用してこのルーチンの起動を試行します。このルーチンが起動はしても、実行を継続しない場合は、Caché の install-dir/mgr ディレクトリにある、cconsole.log および SNMP.log ログ・ファイルでエラーを確認してください。Windows では、発生したすべてのエラーが iscsnmp.dll　によって %System%\System32\snmpdbg.log に記録されます (64 ビット Windows システムでは、このファイルは SysWOW64 サブディレクトリにあります)。

• Caché の %Service_Monitor サービスが有効化されていることを確認します。

• %SYS ネームスペースで、^SYS(“MONITOR”,”SNMP”,”DEBUG”)=1 を設定し、^SNMP Caché サブエージェント・プロセスを再起動すれば、より多くの情報を SNMP.log ファイルに記録させることができます。このログでは、送受信されるメッセージごとに詳細情報が記録されます。

Windows システム ：

• Windows のすべてのバージョンが、既定で Windows SNMP サービスをインストールするわけではありません。これには、追加の手順が必要になる場合があります。このサービスの [プロパティ] ダイアログの [セキュリティ] タブに、少なくとも 1 つ読み取り権限のあるパブリック・コミュニティが存在することを確認してください。SNMP トラップを送信するには、プロパティ・ダイアログの [トラップ] タブで [コミュニティ名] と [トラップ送信先] を定義する必要があります。

• Caché では、Caché をインストールする前に SNMP サービスがインストールされていることを想定しているため、iscsnmp.dll を適切なレジストリ・キーに追加できます。Caché をインストールしたら、SNMP サービスを再起動して、これが iscsnmp.dll を適切にロードし、新しい Caché インスタンスを検出して通信するようにする必要があります。

  Note:

  Caché が SNMP サービスよりも先にインストールされていると、 iscsnmp.dll が適切に登録されません。Windows SNMP サービスのインストール後に、set myStatus=$$Register^SNMP() 関数を使用して登録する必要があります。これを行ったら、SNMP サービスを再起動する必要があります。

• Windows では、$$start^SNMP() 関数は SNMP サービスにシグナルを送信するだけで、Caché の ^SNMP プロセスは、実際には SNMP サービスから Cache へのコールバックによって起動されます。プロセスが開始されるまでには数秒かかり、クエリに応答できるまでにはさらに数秒かかる場合があります。

現時点において、多くの UNIX オペレーティング・システム (HP-UX、IBM AIX®、および Oracle Solaris) では、AgentX プロトコルがサポートされていません。システムで AgentX がサポートされていない場合は、AgentX をサポートする Net-SNMP などの独立した SNMP エージェントをインストールする必要があります。

Linux システムおよび Mac OS X システム ：

• 既定では AgentX サポートは有効化されず、既定のポートは 705 ではありません。snmpd.conf ファイルを修正して、master agentx および agentXSocket TCP:localhost:705 を追加するか、コマンド行で snmpd -x TCP:localhost:705 を使用する必要があります。

• syslocation、syscontact、sysservices などの基本的なシステム情報を snmpd.conf で定義して、snmpd デーモンが正常に起動できるようにする必要があります。

• 最新バージョンの Net-SNMP も VACM (ビューベースのアクセス制御モデル) のセキュリティを実装しており、既定で、mib-2.system サブツリーへのアクセスのみが許可されます。Caché サブエージェントは、エラーなく起動および実行されますが、SNMP 要求は、Caché に転送されません。snmpd.conf で定義されている “ビュー” を拡張して、Caché MIB サブツリーを追加する必要があります。

• SNMP トラップを送信するには、snmpd.conf ファイルで trapsink パラメータを使用して送信先を定義する必要があります。例えば、trapsink 192.16.61.36 public のように指定します。

Caché MIB 構造

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

Caché MIB で定義されているデータはこのファイル自体に詳しく記載されているので、ここでは説明しません。Caché 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 のアプリケーション拡張を定義する場合は、Caché と同様、以下のように enterprise 分岐を使用します。

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

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

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

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

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

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

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

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

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

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

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

1.3.6.1.4.1.16563.1.1.3.1.6.4.84.69.83.84.1

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

iso.org.dod.internet.private.enterprises.intersystems.iscCache.cacheObjects
.cacheDBTab.cacheDBRow.cacheDBSize.TEST(instname).1(DBindex)

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

このセクションでは、SNMP を介したクエリの対象とすることができるユーザ・アプリケーション・モニタ・クラス (このドキュメントの “Caché システム・モニタの使用” の章の "Caché アプリケーション・モニタ" を参照) の定義方法の例を示します。アプリケーション・モニタは、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
  }

}

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

クラスをロードするには、このドキュメントの “Caché システム・モニタの使用” の章の "^%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>zn "%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-CACHE;


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