test

Sun WBEM 開発ガイド

第 13 章 イベントのロギング

ロギングは、WBEM 管理者が異常なイベントを追跡して発生原因を調べることができるようにするためのサービスです。この章で取り上げる内容は次のとおりです。

ロギングについて

ロギングサービスは、Solaris WBEM Services または Sun WBEM SDK のコンポーネントによるすべてのアクションを記録します。このサービスでは、通知用のメッセージとエラーメッセージがログに記録されます。たとえば、ユーザーがシリアルポートを無効にすると、シリアルポートプロバイダによってこの情報が自動的に記録されます。システムエラーなどの障害が発生すると、WBEM 管理者はログ記録を検査して発生原因を調べることができます。

Sun WBEM SDK と Solaris WBEM Services のコンポーネント、アプリケーション、およびプロバイダはすべて、イベントに応答してロギングを自動的に開始します。たとえば、CIM Object Manager は、インストールと起動が終わると自動的にイベントを記録します。

WBEM 環境向けに開発されるアプリケーションとプロバイダには、ロギングを設定できます。詳細は、「API によるロギングの有効化」を参照してください。ログデータは、通常の管理や、アプリケーション用に開発するロギング機能のデバッグのために、CIM WorkShop で表示することもできます。

ログファイル

アプリケーションまたはプロバイダがイベントを記録するように設定すると、イベントはログファイルに書き込まれます。ログ記録はすべて、パス /var/opt/SUNWconn/wbem/log/ に格納されます。ログファイルは、次の命名規則を使用します。

wbem_log.#

# は、ログファイルのバージョンを示すために付加される番号です。.1 が付いたログファイル (例: wbem_log.1) は、最も新しいバージョンです。.2 が付いたログファイルは、その次に新しいバージョンです。拡張子が大きいファイル (例: wbem_log.16) は、バージョンが古いことを示します。最も新しいバージョンのファイル、それ以前のバージョンのファイルとも、/var/opt/SUNWconn/wbem/log 内に 1 つのアーカイブとして共存します。

次の状況の 1 つが発生する場合、ファイル拡張子 .1 によるログファイルの名前変更、保存、およびアーカイブが行われます。

ログファイルの規則

Solaris_LogServiceProperties クラスは、Solaris_Core1.0.mof で定義されています。Solaris_LogServiceProperties クラスには、次のログファイル属性を制御する各プロパティがあります。

データをログファイルに書き込むアプリケーションにこれらの属性のどれかを指定するには、Solaris_LogServiceProperties の新しいインスタンスを作成し、その関連プロパティの値を設定します。

ログファイルの形式

ロギングサービスは、一般的なログファイルとして、アプリケーションログ、システムログ、およびセキュリティログの 3 種類を提供しています。ログ記録は、通知用のメッセージであることも、エラーまたは警告を記述したデータであることもあります。ログに表示できる標準のフィールドがデータに定義されていますが、ログはすべてのフィールドを使用するとは限りません。たとえば、通知用のログではイベントについて説明した簡単なメッセージが示され、エラーログでは詳細なメッセージが示される場合があります。

ログデータフィールドの中には、CIM Repository 内のデータを識別するものがあります。これらのフィールドは、Solaris_LogRecord クラス内の読み取り専用のキー修飾子が付けられたプロパティです。これらのフィールドの値は設定できません。ログファイル内の次のフィールドの値は設定できます。

ログクラス

ロギングには、2 つの Solaris スキーマクラス、Solaris_LogRecord と Solaris_LogService が使用されます。

Solaris_LogRecord

Solaris_LogRecord は、Solaris_Core1.0.mof でログファイル内のエントリをモデル化するように定義されています。イベントに応答してアプリケーションまたはプロバイダが Solaris_LogRecord クラスを呼び出す場合、Solaris_LogRecord クラスはそのイベントによって生成されるデータをすべてログファイルに書き込みます。Solaris_LogRecord クラスの定義を Solaris プロバイダの一部として見るには、任意のテキストエディタで Solaris_Core1.0.mof ファイルを表示してください。Solaris_Core1.0.mof ファイルは、/opt/SUNWconn/wbem/schema に入っています。

Solaris_LogRecord は、プロパティのベクトルとキー修飾子を使用して、データを生成したイベント、システム、ユーザー、およびアプリケーションまたはプロバイダの属性を指定します。アプリケーションと CIM Repository 間で使用されるように、読み取り専用修飾子の値が透過的に生成されます。たとえば、値 RecordID はログエントリを個別に識別しますが、生成されたデータが表示される場合にログ書式の一部としては示されません。

書き込み可能修飾子の値は設定できます。たとえば、イベントが発生したシステムを識別する ClientMachineName と ServerMachineName のようなプロパティの修飾子の値を設定できます。

Solaris_LogService

Solaris_LogService クラスは、ロギングサービスのオペレーションの制御と、ログデータの処理方法の定義を行います。このクラスには、アプリケーションが特定のイベントについてのデータを発行元アプリケーションから CIM Object Manager へ配付するために使用できる一連のメソッドが含まれます。データは、CIM Object Manager からの応答 (CIM Repository からのデータ検出など) を生成するトリガーとなります。

Solaris_LogService クラスは、次のメソッドを使用します。

Solaris_Core1.0.mof ファイル内の Solaris_LogService の定義は、任意のテキストエディタでこのファイルを開いて表示できます。Solaris_Core1.0.mof ファイルは、/opt/SUNWconn/wbem/schema に入っています。

ログデータの表示

イベントに対する応答としてデータを記録するようにアプリケーションが設定されている場合、生成されたデータを CIM Workshop で表示できます。

ログデータを表示する方法

  1. CIM Workshop で、クラス継承ツリー内の solaris_logrecord を選択します。

  2. 「アクション (Action)」、「インスタンス (Instances)」の順に選択します。

  3. 「Solaris LogRecord のインスタンス (Instances for Solaris_LogRecord)」ウィンドウの左側で、アプリケーションが生成したインスタンスをクリックします。

    「Solaris LogRecord のインスタンス (Instances for Solaris_LogRecord)」の右側に、ログファイルのフィールドがプロパティとして表示されます。各プロパティの値は「値 (Values)」列に示されます。

API によるロギングの有効化

ログファイルの内容は現在 CIM Workshop で表示できますが、独自の方法でログファイルを表示したい場合はロギング API を使用してログビューアを開発できます。この API を使用すると、アプリケーションからログファイルへのデータの書き込み、またはログファイルからログビューアへのデータの読み込みが行えます。

ログファイルへのデータの書き込み

アプリケーションでデータをログファイルに書き込むには、次の作業を行います。

データを書き込むために Solaris_LogRecord のインスタンスを作成するには

  1. 必要なすべての java.rmi クラスをインポートします。

    例 13-1 クラスのインポート

    import java.rmi.*; 
import com.sun.wbem.client.CIMClient; 
import com.sun.wbem.cim.CIMInstance; 
import com.sun.wbem.cim.CIMValue; 
import com.sun.wbem.cim.CIMProperty; 
import com.sun.wbem.cim.CIMNameSpace; 
import com.sun.wbem.cim.CIMObjectPath; 
import com.sun.wbem.cim.CIMClass; 
import com.sun.wbem.cim.CIMException; 
import com.sun.wbem.solarisprovider.*; 
import java.util.*; 
import java.util.Enumeration;

  2. 公開クラス CreateLog と次の値を宣言します。

    • CIMClient の値

    • CIMObjectPath の値

    • CIMNameSpace の値

    例 13-2 CreateLog クラスと値の宣言

    public class CreateLog {
    public static void main(String args[ ]) throws CIMException {
	
	if ( args.length != 3) {
	    System.out.println("Usage: CreateLog host username password"); 
	    System.exit(1);
	}
 
	CIMClient cc = null;
	CIMObjectPath cop = null;
	try {
	    CIMNameSpace cns = new CIMNameSpace(args[0]);
	    cc = new CIMClient(cns, args[1], args[2]);

  3. プロパティのベクトルが返されるように指定します。修飾子のプロパティに値を設定します。

    例 13-3 プロパティのベクトルと値の指定

    Vector keys = new Vector();  		
CIMProperty logsvcKey = new CIMProperty("RecordID"); 		
logsvcKey.setValue(new CIMValue(new Integer(0))); 		
keys.addElement(logsvcKey); 		
logsvcKey = new CIMProperty("RecordHashCode"); 		
logsvcKey.setValue(new CIMValue(new Integer(0))); 		
keys.addElement(logsvcKey); 		
logsvcKey = new CIMProperty("Filename"); 		
logsvcKey.setValue(new CIMValue("some_file")); 		
keys.addElement(logsvcKey); 		
logsvcKey = new CIMProperty("category"); 		
logsvcKey.setValue(new CIMValue(new Integer(2))); 		
keys.addElement(logsvcKey); 		
logsvcKey = new CIMProperty("severity"); 		
logsvcKey.setValue(new CIMValue(new Integer(2))); 		
keys.addElement(logsvcKey); 		
logsvcKey = new CIMProperty("AppName"); 		
logsvcKey.setValue(new CIMValue("SomeApp")); 		
keys.addElement(logsvcKey); 		
logsvcKey = new CIMProperty("UserName"); 		
logsvcKey.setValue(new CIMValue("molly")); 		
keys.addElement(logsvcKey); 		
logsvcKey = new CIMProperty("ClientMachineName"); 		
logsvcKey.setValue(new CIMValue("dragonfly")); 		
keys.addElement(logsvcKey); 		
logsvcKey = new CIMProperty("ServerMachineName"); 		
logsvcKey.setValue(new CIMValue("spider")); 		
keys.addElement(logsvcKey); 		
logsvcKey = new CIMProperty("SummaryMessage"); 		
logsvcKey.setValue(new CIMValue("brief_description")); 		
keys.addElement(logsvcKey); 		
logsvcKey = new CIMProperty("DetailedMessage"); 		
logsvcKey.setValue(new CIMValue("detailed_description")); 		
keys.addElement(logsvcKey); 		
logsvcKey = new CIMProperty("data"); 		
logsvcKey.setValue(new CIMValue("0xfe 0x45 0xae 0xda")); 
	keys.addElement(logsvcKey); 		
logsvcKey = new CIMProperty("SyslogFlag"); 		
logsvcKey.setValue(new CIMValue(new Boolean(true))); 		
keys.addElement(logsvcKey);

  4. ログ記録用に CIMObjectPath の新しいインスタンスを宣言します。

    例 13-4 CIMObjectPath の新しいインスタンスの宣言

    CIMObjectPath logreccop = new CIMObjectPath("Solaris_LogRecord", keys);

  5. Solaris_LogRecord の新しいインスタンスを宣言します。ファイルに書き込むようにプロパティのベクトルを設定します。

    例 13-5 インスタンスとプロパティの設定

    CIMInstance ci = new CIMInstance();
		ci.setClassName("Solaris_LogRecord");
		ci.setProperties(keys);
		//System.out.println(ci.toString());
		cc.setInstance(logreccop,ci);
	}
	catch (Exception e) {
	    System.out.println("Exception: "+e);
		e.printStackTrace();
	}

  6. データがログファイルに書き込まれたあと、セッションを閉じます。

    例 13-6 セッションを閉じる

    	// セッションを閉じる
	if(cc != null) {
	    cc.close();
	}
    }
}

ログファイルからのデータの読み取り

アプリケーションでログファイルからログビューアにデータを読み込むには、次の作業を行います

Solaris_LogRecord のインスタンスを取得し、データを読み取るには

  1. 必要なすべての java.rmi クラスをインポートします。

    例 13-7 クラスのインポート

    import java.rmi.*;
import com.sun.wbem.client.CIMClient;
import com.sun.wbem.cim.CIMInstance;
import com.sun.wbem.cim.CIMValue;
import com.sun.wbem.cim.CIMProperty;
import com.sun.wbem.cim.CIMNameSpace;
import com.sun.wbem.cim.CIMObjectPath;
import com.sun.wbem.cim.CIMClass;
import com.sun.wbem.cim.CIMException;
import com.sun.wbem.solarisprovider.*;
import java.util.*;
import java.util.Enumeration;

  2. クラス ReadLog を宣言します。

    例 13-8 ReadLog クラスの宣言

    public class ReadLog 
    {
    public static void main(String args[]) throws 
    CIMException 
    {
    if ( args.length != 3) 
    {
    System.out.println("Usage: ReadLog host username 
    password"); 
	    System.exit(1);

  3. ReadLog クラスのクライアント、オブジェクトパス、およびネームスペースの値を設定します。

    例 13-9 

    	} 	
CIMClient cc = null; 
	CIMObjectPath cop = null; 
try { 	    CIMNameSpace cns = new CIMNameSpace(args[0]); 
cc = new CIMClient(cns, args[1], args[2]); 
cop = new CIMObjectPath("Solaris_LogRecord");

  4. Solaris_LogRecord のインスタンスを列挙します。

    例 13-10 インスタンスの列挙

     Enumeration e = cc.enumInstances(cop, true);
		for (; e.hasMoreElements(); ) {

  5. プロパティの値を出力デバイスに送ります。

    例 13-11 プロパティ値の送信

    	System.out.println("------------------------
---------");
			CIMObjectPath op = (CIMObjectPath)e.nextElement();
			CIMInstance ci = cc.getInstance(op);
			System.out.println("Record ID : " + 
      (((Long)ci.getProperty("RecordID").getValue().
      getValue()).longValue()));
			System.out.println("Log filename : " + 
      ((String)ci.getProperty("FileName").getValue().
      getValue())); 
			int categ = (((Integer)ci.getProperty("category").
      getValue().getValue()).intValue());
			if (categ == 0)
				System.out.println("Category : Application Log");
			else if (categ == 1)
				System.out.println("Category : Security Log");
			else if (categ == 2)
				System.out.println("Category : System Log");
			int severity = (((Integer)ci.getProperty
      ("severity").getValue().getValue()).intValue());
			if (severity == 0)
				System.out.println("Severity : Informational");
			else if (severity == 1)
				System.out.println("Severity : Warning Log!");
			else if (severity == 2)
				System.out.println("Severity : Error!!");
			System.out.println("Log Record written by :" + 
      ((String)ci.getProperty("AppName").getValue().
      getValue()));
			System.out.println("User : " + ((String)ci.
      getProperty("UserName").getValue().getValue()));
			System.out.println("Client Machine : " + ((String)ci.
      getProperty("ClientMachineName").getValue().getValue
      ()));
			System.out.println("Server Machine : " + ((String)ci.
      getProperty("ServerMachineName").getValue().getValue
      ()));
			System.out.println("Summary Message : " + ((String)
      ci.getProperty("SummaryMessage").getValue().getValue
      ()));
			System.out.println("Detailed Message : " + ((String)
      ci.getProperty("DetailedMessage").getValue().getValue
      ()));
			System.out.println("Additional data : " + ((String)
      ci.getProperty("data").getValue().getValue()));
			boolean syslogflag =
				((Boolean)ci.getProperty("syslogflag").getValue().
      getValue()).booleanValue();
		   if (syslogflag == true) {
			System.out.println("Record was written to syslog as 
      well");
			} else {
			System.out.println("Record was not written to 
      syslog");
			}
			System.out.println("-----------------------------
      ----");
		}

  6. エラー状況が発生する場合は、ユーザーにエラーメッセージを返します。

    例 13-12 エラーメッセージを返す

    }
	catch (Exception e) {
	    System.out.println("Exception: "+e);
		e.printStackTrace();
	}

  7. ファイルからデータが読み取られたあとセッションを閉じます。

    例 13-13 セッションを閉じる

    	// セッションを閉じる。
	if(cc != null) {
	    cc.close();
	}
}
}