ログおよびトレース・アナライザーは、以下のロギング・ユーティリティーにスタンドアロンおよびプラグインのサポートを提供しています。
このサポートには、以下が必要です。
このサポートは、以下のプラグインで提供されます。
ロギング・ユーティリティー |
プラグイン JAR |
---|---|
Java ロギング (JSR-047) |
org.eclipse.hyades.logging.core¥hl14.jar |
Apache Jakarta 共通ロギング |
org.eclipse.hyades.logging.core¥hlcommons.jar |
Apache Jakarta Log4J ロギング |
org.eclipse.hyades.logging.core¥hllog4j.jar |
EMF 共通ベース・イベント V1.0.1 |
org.eclipse.hyades.logging.core¥hlcbe101.jar |
以下のセクションでは、各タイプのロギング・ユーティリティー・サポートの詳細について説明し、その使用方法を示したサンプルへの参照を提供します。
org.eclipse.hyades.logging.java14 パッケージの下にある java.util.logging.LogRecord クラスの拡張により、org.eclipse.hyades.logging.events.cbe.CommonBaseEvent をロギングするためにカスタマイズされたログ・レコードを java.util.logging.LogRecord で作成することができます。この org.eclipse.hyades.logging.java14.CommonBaseEventLogRecord は、 java.util.logging.LogRecord を拡張したもので、org.eclipse.hyades.logging.events.cbe.CommonBaseEvent への参照を含んでいます。すべての java.util.logging.LogRecord プロパティーは、非共通ベース・イベントを認識するハンドラーおよびフォーマッターに対する再帰性を維持するために、1 つ以上の共通ベース・イベント・プロパティーにマップされています。
org.eclipse.hyades.logging.java14 パッケージの下にある java.util.logging.Filter インターフェースの実装でできるのは、org.eclipse.hyades.logging.java14.CommonBaseEventLogRecord を正常にログに記録することだけです。
org.eclipse.hyades.logging.java14 パッケージの下にある java.util.logging.Formatter 抽象クラスの拡張により、org.eclipse.hyades.logging.java14.CommonBaseEventLogRecord および java.util.logging.LogRecord ログ・メッセージを XML にフォーマットするためのハンドラーを構成できます。この org.eclipse.hyades.logging.java14.XmlFormatter フォーマッターは、 org.eclipse.hyades.logging.java14.CommonBaseEventLogRecord または java.util.logging.LogRecord ログ・メッセージを、共通ベース・イベント v1.0.1 スキーマに基づいて XML に変換します。ログ・メッセージは、フォーマット時に、それが org.eclipse.hyades.logging.core.IExternalizableToXml インターフェース (例えば org.eclipse.hyades.logging.java14.CommonBaseEventLogRecord) を実装しているかどうかを検査されます。実装している場合は、XML シリアライゼーションの代わりに externalizeCanonicalXmlString() API が呼び出されます。実装していない場合、java.util.logging.LogRecord ログ・メッセージは、org.eclipse.hyades.logging.events.cbe.CommonBaseEvent の場合と同じマッピングを使用して、共通ベース・イベント・オブジェクトに変換され、externalizeCanonicalXmlString() API を呼び出して XML にシリアライズされます。
org.eclipse.hyades.logging.java パッケージの下にある java.util.logging.Handler 抽象クラスの拡張により、org.eclipse.hyades.logging.events.cbe.CommonBaseEvent および java.util.logging.LogRecord ログ・メッセージをロギング・エージェントにロギングするようロガーを構成できます。
この org.eclipse.hyades.logging.java.LoggingAgentHandler ハンドラーは、ロガーに記録されている org.eclipse.hyades.logging.java14.CommonBaseEventLogRecord または java.util.logging.LogRecord ログ・メッセージを、ロガーおよびハンドラーのフィルターおよびロギング・レベルに基づいてログに記録できるかどうかを検査します。ログ・メッセージをログに記録する場合は、メッセージをログに記録するロガーと同じ名前でロギング・エージェントが解決されます。記録しない場合は、ロギング・エージェント・ハンドラーと呼ばれる、ロギング・エージェントを 1 つ作成する org.eclipse.hyades.logging.java.SingleLoggingAgentHandler ハンドラーを使用できます。メッセージは org.eclipse.hyades.logging.java.XmlFormatter を使用して XML でフォーマット設定され、ロギング・エージェントに書き込まれます。
具体的なサンプル
JSR-047 ロギングのサポートの利用方法を示しているサンプルが提供されています。このサンプルでは、JSR-047 Java ロギングのためのスタンドアロンおよびプラグインのサポートの新規および既存のユーザーに必要な構成およびインスツルメンテーションが示されています。詳しくは、「ファイル」>「新規」>「サンプル...」>「JSR-047 ロギング・サンプル」を開いてください。
org.eclipse.hyades.logging.commons パッケージの下にある org.apache.commons.logging.Log インターフェースの実装により、org.eclipse.hyades.logging.events.cbe.CommonBaseEvent、java.lang.Object、および java.lang.Throwable ログ・メッセージのロギング用ロガーを作成できます。この org.eclipse.hyades.logging.commons.Logger は、ロガーに記録されている org.eclipse.hyades.logging.events.cbe.CommonBaseEvent、java.lang.Object、または java.lang.Throwable ログ・メッセージを、そのロガーのロギング・レベルに基づいてログに記録できるかどうかを検査します。ログ・メッセージをログに記録する場合は、org.eclipse.hyades.logging.events.cbe.CommonBaseEvent、java.lang.Object、または java.lang.Throwable ログ・メッセージがフォーマット設定され、ログに記録されます。org.eclipse.hyades.logging.commons.Logger インスタンスに固有のプロキシー・ファクトリーを表す org.apache.commons.logging.LogFactory 抽象クラスの実装が提供されています。この org.eclipse.hyades.logging.commons.LoggerFactory プロキシー・ファクトリーは、個々のクラス・ローダーごとに 1 つ以上の異なるタイプのロガーおよびそのファクトリーが要求され、すべて同一の Apache 共通バイナリーを使用している複数のクラス・ローダー環境で使用することを意図しています。
org.eclipse.hyades.logging.commons.Logger は、共通ベース・イベント v1.0.1 スキーマに基づいて、org.eclipse.hyades.logging.events.cbe.CommonBaseEvent、java.lang.Object、および java.lang.Throwable ログ・メッセージを XML にフォーマットします。ログ・メッセージは、フォーマット時に、それが org.eclipse.hyades.logging.core.IExternalizableToXml インターフェースを実装しているかどうかが検査されます (例えば org.eclipse.hyades.logging.events.cbe.CommonBaseEvent)。実装している場合は、XML シリアライゼーションの代わりに externalizeCanonicalXmlString() API が呼び出されます。実装していない場合、java.lang.Object または java.lang.Throwable ログ・メッセージは、 org.eclipse.hyades.logging.events.cbe.util.EventHelpers.convertObjectToCommonBaseEvent() メソッドを使用して、共通ベース・イベント・オブジェクトに変換され、externalizeCanonicalXmlString() API を呼び出して XML にシリアライズされます。
org.eclipse.hyades.logging.commons.Logger は、org.eclipse.hyades.logging.events.cbe.CommonBaseEvent、java.lang.Object、および java.lang.Throwable ログ・メッセージをロギング・エージェントに記録します。ログ・メッセージをログに記録する場合は、メッセージをログに記録するロガーと同じ名前でロギング・エージェントが解決されます。メッセージは XML にフォーマット設定され、ロギング・エージェントに書き込まれます。
org.eclipse.hyades.logging.commons パッケージの下にある org.apache.commons.logging.Log インターフェースの実装により、org.eclipse.hyades.logging.events.cbe.CommonBaseEvent、java.lang.Object、および java.lang.Throwable ログ・メッセージのロギング用のロガーをローカル・ファイルに作成できます。この org.eclipse.hyades.logging.commons.FileLogger は、ロガーに記録されている org.eclipse.hyades.logging.events.cbe.CommonBaseEvent、java.lang.Object、または java.lang.Throwable ログ・メッセージを、そのロガーのロギング・レベルに基づいてログに記録できるかどうかを確認します。ログ・メッセージをログに記録する場合は、org.eclipse.hyades.logging.events.cbe.CommonBaseEvent、java.lang.Object、または java.lang.Throwable ログ・メッセージが XML にフォーマット設定され、ローカル・ファイルに記録されます。org.eclipse.hyades.logging.commons.FileLogger インスタンスに固有のプロキシー・ファクトリーを表す org.apache.commons.logging.LogFactory 抽象クラスの実装が提供されています。この org.eclipse.hyades.logging.commons.FileLoggerFactory プロキシー・ファクトリーは、個別のクラス・ローダーごとに 1 つ以上の異なるタイプのロガーおよびそのファクトリーが要求され、すべて同一の Apache 共通バイナリーを使用している複数のクラス・ローダー環境で使用することを意図しています。
具体的なサンプル
Apache Jakarta 共通ロギングのサポートを利用する方法を示しているサンプルが提供されています。このサンプルでは、Apache Jakarta 共通ロギングのスタンドアロンおよびプラグインのサポートの新規ユーザーおよび既存ユーザーに必要な構成およびインスツルメンテーションを示しています。詳しくは、「ファイル」>「新規」>「サンプル...」>「Apache 共通ロギング・サンプル」を参照してください。
org.apache.log4j.spi.LoggingEvent ログ・メッセージのメッセージ・プロパティーを使用すると、org.eclipse.hyades.logging.events.cbe.CommonBaseEvent をログに記録できます。
org.eclipse.hyades.logging.log4j パッケージの下にある org.apache.log4j.spi.Filter 抽象クラスの拡張でできるのは、org.eclipse.hyades.logging.events.cbe.CommonBaseEvent を正常にログに記録することだけです。
org.eclipse.hyades.logging.log4j パッケージの下にある org.apache.log4j.Layout 抽象クラスの拡張により、org.eclipse.hyades.logging.events.cbe.CommonBaseEvent および org.apache.log4j.spi.LoggingEvent ログ・メッセージを XML にフォーマット設定するためのアペンダーを構成できます。この org.eclipse.hyades.logging.log4j.XmlLayout フォーマッターは、共通ベース・イベント v1.0.1 スキーマに基づいて、org.eclipse.hyades.logging.events.cbe.CommonBaseEvent または org.apache.log4j.spi.LoggingEvent ログ・メッセージを XML に変換します。ログ・メッセージは、フォーマット時に、org.apache.log4j.spi.LoggingEvent のメッセージ・プロパティーが、org.eclipse.hyades.logging.core.IExternalizableToXml インターフェースを実装しているかどうかが検査されます (例えば、org.eclipse.hyades.logging.events.cbe.CommonBaseEvent)。実装している場合は、XML シリアライゼーションの代わりに externalizeCanonicalXmlString() API が呼び出されます。実装していない場合、org.apache.log4j.spi.LoggingEvent ログ・メッセージは、 org.eclipse.hyades.logging.events.cbe.util.EventHelpers.convertObjectToCommonBaseEvent() メソッドを使用して共通ベース・イベント・オブジェクトに変換され、externalizeCanonicalXmlString() API を呼び出して XML にシリアライズされます。
org.eclipse.hyades.logging.log4j パッケージの下にある org.apache.log4j.AppenderSkeleton 抽象クラスの拡張により、org.eclipse.hyades.logging.events.cbe.CommonBaseEvent および org.apache.log4j.spi.LoggingEvent ログ・メッセージをロギング・エージェントに記録するようロガーを構成できます。
この org.eclipse.hyades.logging.log4j.LoggingAgentAppender アペンダーは、ロガーに記録されている org.eclipse.hyades.logging.events.cbe.CommonBaseEvent および org.apache.log4j.spi.LoggingEvent ログ・メッセージを、そのロガーおよびアペンダーのフィルターおよびロギング・レベルに基づいてログに記録できるかどうかを検査します。ログ・メッセージをログに記録する場合は、メッセージをログに記録するロガーと同じ名前でロギング・エージェントが解決されます。記録しない場合は、ロギング・エージェントを 1 つ作成する、ロギング・エージェント・アペンダーと呼ばれる org.eclipse.hyades.logging.log4j.SingleLoggingAgentAppender アペンダーを使用できます。メッセージは org.eclipse.hyades.logging.log4j.XmlLayout を使用して XML にフォーマット設定され、ロギング・エージェントに書き込まれます。
具体的なサンプル
Apache Jakarta Log4J ロギングのサポートを利用する方法を示しているサンプルが提供されています。このサンプルでは、Apache Jakarta 共通ロギングのスタンドアロンおよびプラグインのサポートの新規ユーザーおよび既存ユーザーに必要な構成およびインスツルメンテーションを示しています。詳しくは、「ファイル」>「新規」>「サンプル...」>「Apache Log4J ロギング・サンプル」を参照してください。
具体的なサンプル
共通ベース・イベント XML ファイル・テンプレートのイベント・ファクトリーを使用して共通ベース・イベントを作成および構成することにより EMF 共通ベース・イベントのサポートを利用する方法を示すためにサンプルが提示されます。詳しくは、「ファイル」>「新規」>「サンプル...」>「EMF 共通ベース・イベント v1.0.1 サンプル」を参照してください。
関連概念
共通ベース・イベント・モデル
(C) Copyright IBM Corporation 2000, 2006. All Rights Reserved.