ODL構成

ODLロギング・フォーマットを使用する各Oracle Enterprise Performance Management System製品には、ロギング構成ファイルlogging.xmlが少なくとも1つ存在します。EPM Systemのコンポーネントには、loggingCOMPONENT_NAME.xmlというフォーマットの説明的な名前が付けられています。

ロギング構成ファイルは、log_handlersおよびloggersの2つのセクションで構成されます。log_handlersセクションがロガーとそのパラメータを定義する一方、loggersセクションはロギング・レベルと使用するlog_handlerを含む詳細を識別します。

指定できるlog_handlerプロパティのリストは、表3-9を参照してください。

ODLロギング・レベル

表3-7 ODLロギング・レベル

レベル 説明
INCIDENT_ERROR:1 不明な理由で発生した、重大な問題に関連するメッセージ。問題を解決するには、ユーザーはOracleサポートに連絡する必要があります。
ERROR:1 システム管理者の即時の対応が必要だが、EPM Systemコンポーネントの不具合が原因ではない重大な問題に関連するメッセージ
WARNING:1 システム管理者の確認を必要とする潜在的な問題に関連するメッセージ
NOTIFICATION:1 主なサブコンポーネントまたは機能のアクティブ化または非アクティブ化などの重要なライフサイクル・イベントに関連するメッセージ
NOTIFICATION:16 EPM Systemコンポーネントの通常のイベントに関連するメッセージ
TRACE:1 EPM Systemコンポーネントのエンド・ユーザーにとって意味のあるイベントのトレースまたはデバッグ・メッセージ
TRACE:16 EPM Systemコンポーネントの問題を診断するためにOracleサポートが使用できる、詳細なトレースまたはデバッグ・メッセージ
TRACE:32 通常はOracle Developerがエラーの発生元のソースを特定することを目的としている、非常に詳細なトレースまたはデバッグ・メッセージ

ODL構成ファイル: 単一の管理対象サーバーのデプロイメント

EPM Systemコンポーネントの単一の管理対象サーバーへのデプロイメントでは、デプロイされたすべてのJava Webアプリケーションに対して統合されたロギング構成ファイルlogging.xmlが生成されます。Windowsサーバーでこのファイルは通常、MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/EPMServer0にあります。

ODL構成ファイル: 標準デプロイメント

EPM Systemの標準デプロイメントでは、デプロイされた各Java Webアプリケーションに対してロギング構成ファイルlogging.xmlが生成されます。Windowsサーバーで、これらのファイルは通常、次のように配置されます:

表3-8 標準デプロイメントでのODL構成ファイルの場所

コンポーネント logging.xmlの場所
管理サーバー(Oracle WebLogic Server管理コンソール、Oracle Web Services Manager、Enterprise Manager) MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/AdminServer/logging.xml
Oracle Hyperion Provider Services MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/AnalyticProviderServices0/logging.xml
Oracle Hyperion Calculation Manager MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/CalcMgr0/logging.xml
Oracle Essbase Administration Services MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/EssbaseAdminServices0/logging.xml
Oracle Hyperion Foundation Services MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/FoundationServices0/logging.xml
Oracle Hyperion Financial Management Web MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/HFMWeb0/logging.xml
Oracle Hyperion Planning MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/Planning0/logging.xml

ODL構成ファイルの変更

logging.xmlで定義されたロガーのプロパティを変更して、記録されるメッセージ・レベルを決定します。デフォルトでは、EPM Systemコンポーネントの通常の操作に適切なロギング・レベルはlogging.xmlで設定されます。追加のログ・ハンドラ・パラメータは、ロギング動作を変更するように設定できます。たとえば、ログ・ハンドラにrotationFrequencyパラメータを含めることで、ロギング・ファイルのローテーション頻度を指定できます。パラメータの包括的なリストは、表3-9を参照してください。

表3-9 構成可能なODLログ・プロパティ

ログ・プロパティ 説明

path

ログのパス

format

使用するフォーマット

推奨値はODL-Textです。

maxFileSize

各ログ・ファイルの最大サイズ(バイト)

メインのログ・ファイルが指定されたサイズに達すると、ログ・ローテーションがトリガーされます。メインのログ・ファイルがアーカイブされて、新しいログ・ファイルが作成されます。

maxLogSize

ログ全体の最大サイズ(バイト)

ログの合計サイズを指定の上限以下に保つために、古いアーカイブ・ファイルは削除されます。

rotationFrequency

ログのローテーションの頻度(分)

値は数値(分)、あるいはhourly、daily、weeklyのいずれかです。(この設定は大文字と小文字が区別されません。)

baseRotationTime

時間ベースのログ・ローテーションの基本時間; たとえば、rotationFrequency設定の基準となります

デフォルト: 1970年1月1日(UTC)

次のいずれかのフォーマットを使用します:

  • HH:mm

  • yyyy-MM-dd

  • yyyy-MM-ddT-HH:mm

  • yyyy-MM-dd-HH:mm:ss.sTZ。TZはタイムゾーン・インディケータであり、UTCを表すZ、またはグリニッジ標準時からのオフセット(フォーマットはplus_or_minusHH:mmm)を指定します

注:

時間フォーマットがタイムゾーンを指定しない場合は、ローカル・タイムゾーンが使用されます。

retentionPeriod

ログ・ファイルの保存期間

指定した期間よりも古いファイルは削除されます。ファイルはログ・ローテーションがある場合のみ削除され、バックグラウンド・スレッドがログ・ファイルを削除することはありません。このため、保存期間が終了した後もファイルがしばらく削除されない場合があります。値は数値(分)、もしくは日単位、週単位、月単位(30日)または年単位になります(値の大文字と小文字は区別されません)。

encoding

使用する文字エンコードのタイプ

XMLファイルは、拡張文字を処理するため、UTF-8エンコードにする必要があります。デフォルトは<?xml version="1.0" encoding="UTF-8" ?>です。

supplementalAttributes

カンマで区切られた補足属性名のリストで、各ログ・メッセージに追加できます。

属性値はExecutionContextクラスで定義する必要があります。

useSourceClassAndMethod

Javaソース・クラスとメソッド名を各ログ・メッセージに追加するかどうか

値はレベル名です。指定したレベル以下のメッセージにソース・クラスおよびメソッド名が含まれます。定数trueおよびfalseもOFFおよびALLの別名として受け取られます。デフォルト値はTRACE:1 (詳細)です。

useDefaultAttributes

データベースの属性値を各ログ・メッセージに追加するかどうか

割当て可能なデフォルト属性はHOST_ID、HOST_NWADDRおよびUSER_IDです。値はtrueまたはfalseになります。デフォルト値はODL-XMLフォーマットではtrue、ODL-テキスト・フォーマットではfalseです。

includeMessageArguments

メッセージの引数を、メッセージIDも持つフォーマットされたログ・メッセージに含めるかどうか

指定可能な値: true (デフォルト)またはfalse。

useThreadName

ハンドラが、java.util.logging.LogRecordによって提供されるthreadIDのかわりに、実際のスレッド名を記録しようとするかどうかを制御する、useThreadNameフラグ。

フラグがtrueの場合、ハンドラは実際のスレッド名を記録しようとします。ハンドラが実際のスレッド名を判定できないこともありますが、その場合はthreadIDを記録します。デフォルト値はtrueです。

useRealThreadId

useRealThreadIdフラグは、java.util.logging.LogRecordに提供されるthreadIDではなく、実際のスレッドIDをハンドラが記録しようとする場合に制御を行います。

フラグがtrueの場合、ハンドラは実際のスレッドIDを記録しようとします。ハンドラが実際のスレッド名を判定できないこともありますが、その場合はthreadIDを記録します。デフォルト値はfalseです。実際のスレッドIDの記録は、useThreadNameプロパティと相互に排他的になります。useThreadNameがtrueの場合、useRealThreadIdプロパティの値は無視されます。

locale

メッセージをローカライズするためのデフォルトのロケールのオーバーライド

デフォルト値はデフォルト・ロケールです。これは、EPM Systemコンフィグレータで設定されます。

keepOpen

メインのログ・ファイルが常に開いているか、それともログ操作のたびに開かれて閉じられるか。

指定可能な設定: trueおよびfalse。デフォルト設定はtrueです。この場合、メインのログ・ファイルは常に開いています。

ほとんどのケースでデフォルト値を使用します。

autoFlushLevel

自動フラッシュのレベル設定

ODLHandlerではログ・レコードをバッファできますが、指定されたautoFlushレベル以上のログ・レコードを取得すると、バッファが自動的にフラッシュされます。デフォルト値はNOTIFICATION:1です。

addJvmNumber

ログ・ファイル名に追加されたJVM番号

JVM番号はシステム・プロパティoracle.process.indexにより定義されます。システム・プロパティが設定されていない場合、このオプションは無視されます。

applicationContextProvider

ApplicationContextインタフェースを実装するクラスの名前

クラスにはデフォルトのコンストラクタが必要です。特殊な値、disabledはアプリケーション名のロギングの無効化に使用できます。デフォルトのアプリケーション・コンテキスト・プロバイダはプラットフォームに固有であり、ほとんどの場合、このプロパティを設定する必要はありません。

userContextProvider

UserContextインタフェースを実装するクラスの名前

クラスにはデフォルトのコンストラクタが必要です。特殊な値、disabledはユーザー名のロギングの無効化に使用できます。デフォルトのユーザー・コンテキスト・プロバイダはプラットフォームに固有であり、ほとんどの場合、このプロパティを設定する必要はありません。

ロガーのプロパティを変更することで、コンポーネントをデバッグするか、EPM Systemコンポーネントに関する問題を特定するためにOracleサポートで求められる情報を生成します。

たとえば、Oracle Hyperion Shared Servicesデバッグ・メッセージを取得するために、各Shared Servicesロガー定義のロギング・レベルをTRACE:32に変更します。

注:

デバッグが完了した後、最適なロギング設定を確実にするため、バックアップ・コピーから元のlogging.xmlをリストアします。

ロギング構成ファイルを変更するには:

  1. ロギング動作が変更される対象のEPM Systemコンポーネントの、ロギング構成ファイルのバックアップ・コピーを作成します。EPM System製品のロギング・マトリックスを参照してください。

  2. テキスト・エディタを使用して、logging.xmlを開きます。

  3. ロガー定義を特定します。たとえば、Shared Servicesのロギング・レベルを変更するには、次のロガー定義を変更します:

    <logger name="oracle.EPMCAS" level="NOTIFICATION:1" useParentHandlers="false">
     <handler name="epmcas-handler" />
</logger>
<logger name="oracle.EPMCES" level="NOTIFICATION:1" useParentHandlers="false">
     <handler name="epmces-handler" />
</logger>
<logger name="oracle.EPMCMS" level="NOTIFICATION:1" useParentHandlers="false">
     <handler name="epmcms-handler" />
</logger>
<logger level="NOTIFICATION:1" name="oracle.EPMCSS">
     <handler name="epmcss-handler" />
</logger>

  4. メッセージ・ロギング・レベルを変更するために必要に応じてlevelプロパティを変更します。たとえば、詳細なデバッグ・メッセージを記録するために各ロガーのlevelプロパティをTRACE:32に設定します。

    ODLロギング・レベルを参照してください。

  5. logging.xmlを保存して閉じます。

  6. 変更を有効にするにはEPM Systemコンポーネントを再起動します。