1. Oracle Coherenceのマネージメント
  2. Oracle Coherenceのレポート機能の使用

5 Oracle Coherenceのレポート機能の使用

Oracle Coherenceでは、管理データを収集し、定期的に更新される一連のレポートを生成するレポート機能が提供されます。レポートでは、生成されるレポート、レポートの保存場所、レポート・データの更新頻度などを制御する、多くの構成オプションがサポートされています。

この章の内容は次のとおりです。

Oracle Coherenceのレポート機能の概要

Oracle Coherenceレポートは、重要な管理情報を時系列で示します。このレポートでは、多くの場合、トラブルシューティングおよび計画に役立つ傾向が特定されます。レポート機能はデフォルトでは無効になっているため、明示的に有効にする必要があります。

レポートの表示

デフォルトのレポート動作では、1時間おきに10種類のレポートが作成されます。これらのレポートは毎分リフレッシュされます。レポートは、クラスタ・メンバーを起動するディレクトリに保存されます。各ファイルには、YYYYMMDDHH形式のレポート・タイムスタンプを持つプレフィックスが含まれます。この形式により、不要な情報を簡単に特定して削除できます。表5-1に、レポートをまとめています。

表5-1 デフォルトのOracle Coherenceレポート

ファイル名 説明

YYYYMMDDHH-cache-usage.txt

各キャッシュの使用(put、getなど)の統計が含まれます。キャッシュのレポートは、クラスタにキャッシュが存在する場合にのみ作成されます。

YYYYMMDDHH-Management.txt

Oracle Coherence管理フレームワークに関する情報が含まれます

YYYYMMDDHH-memory-status.txt

各メンバーに関するメモリーおよびガベージ・コレクションの情報が含まれます

YYYYMMDDHH-network-health.txt

クラスタ全体におけるパブリッシャの成功率および受信側の成功率が含まれます

YYYYMMDDHH-network-health-detail.txt

各メンバーにおけるパブリッシャの成功率および受信側の成功率が含まれます

YYYYMMDDHH-nodes.txt

クラスタのメンバーのリストが含まれます

YYYYMMDDHH-persistence.txt

特定のサービスのキャッシュ永続性情報が含まれます

YYYYMMDDHH-persistence-detail.txt

特定のサービスおよびノードのキャッシュ永続性情報が含まれます

YYYYMMDDHH-report-proxy.txt

クラスタ内の各プロキシ・サーバーに関する使用状況が含まれます

YYYYMMDDHH-service.txt

各サービスのリクエストおよびタスク情報が含まれます

親トピック: Oracle Coherenceのレポート機能の使用

レポート機能の構成の理解

レポート構成ファイルは、単一レポートを定義します。たとえば、report-node.xml構成ファイルは、YYYYMMDDHH-nodes.txtレポートを作成します。レポート構成ファイルは、Oracle Coherence MBeanを使用してこのレポートで使用されているデータを収集します。coherence.jar/reportsディレクトリには、事前定義されたレポート構成ファイルが含まれます。「レポート・ファイル構成要素」を参照してください。

レポート・グループ構成ファイルは、生成するレポート、レポートのリフレッシュ頻度、レポートの保存先ディレクトリおよびレポートの各パラメータを決定します。coherence.jar/reportsディレクトリには、3つの事前定義済レポート・グループ構成ファイル(report-group.xml、report-web-group.xml、およびreport-all.xml)が含まれます。「レポート・グループ構成要素」を参照してください。

親トピック: Oracle Coherenceのレポート機能の概要

レポートのカスタマイズ

レポート構成ファイルをカスタマイズしたり、必要に応じて新しい構成ファイルを作成することができます。レポートには、すべてのMBean(カスタムMBeanを含む)からの情報を含められます。「カスタム・レポートの作成」を参照してください。

親トピック: Oracle Coherenceのレポート機能の概要

クラスタ・メンバーでのOracle Coherenceのレポート機能の有効化

レポート機能はデフォルトでは無効になっているため、明示的に有効にする必要があります。レポート構成を編集して、クラスタ・メンバーのレポートを有効にし、管理レポートを生成できます。レポート機能を有効化する前に、クラスタ・メンバーでのJMX管理が有効化されていることを確認してください。「JMX管理の構成」を参照してください。

デフォルトのレポート機能の構成では、1時間ごとにレポートのセットが作成され、1分ごとにレポートがリフレッシュされます。レポートは、クラスタ・メンバーを起動するディレクトリに保存されます。

ノート:

レポート機能を有効化する前に、レポートをアーカイブする計画を決定します。

レポート機能を有効化するには、オペレーション・オーバーライド・ファイルを編集し、<reporter>要素内に、trueに設定した<autostart>要素を追加します。たとえば: 

<?xml version='1.0'?>

<coherence xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://xmlns.oracle.com/coherence/coherence-operational-config"
   xsi:schemaLocation="http://xmlns.oracle.com/coherence/coherence-operational-config
   coherence-operational-config.xsd">
   <management-config>
      <reporter>
         <autostart
            system-property="coherence.management.report.autostart">true
         </autostart>
      </reporter>
   </management-config>
</coherence>

coherence.management.report.autostartシステム・プロパティによりレポート機能を有効にすることもできます。たとえば: 

-Dcoherence.management.report.autostart=true

親トピック: Oracle Coherenceのレポート機能の使用

デフォルトのレポート・グループ構成ファイルの切替え

別のレポート・グループ構成ファイルを指定することによって、生成されるレポートを制御できます。
次の3つの事前定義済レポート・グループ構成ファイルがcoherence.jar/reportsディレクトリに含まれます。

  • report-group.xml – 生成する一連のコア・レポートを構成します。これは、デフォルトの構成におけるレポート・グループ構成ファイルです。

  • report-web-group.xml – 一連のOracle Coherence*Webレポートを構成します。『Oracle Coherence*WebでのHTTPセッション・マネージメントの管理』のパフォーマンス・レポートの実行に関する項を参照してください。

  • report-all.xml – 生成するすべての事前定義済レポートを構成します。

レポート・グループ構成ファイルを変更するには、オペレーション・オーバーライド・ファイルを編集し、<reporter>要素内に、レポート・グループ構成ファイルに設定した<configuration>要素を追加します。たとえば: 

<?xml version='1.0'?>

<coherence xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://xmlns.oracle.com/coherence/coherence-operational-config"
   xsi:schemaLocation="http://xmlns.oracle.com/coherence/coherence-operational-config
   coherence-operational-config.xsd">
   <management-config>
      <reporter>
         <configuration
            system-property="coherence.management.report.configuration">
            reports/report-all.xml</configuration>
      </reporter>
   </management-config>
</coherence>

coherence.management.report.configurationシステム・プロパティによりデフォルトのレポート・グループ構成ファイルを切り替えることもできます。たとえば: 

-Dcoherence.management.report.configuration=reports/report-all.xml

親トピック: Oracle Coherenceのレポート機能の使用

レポート・グループ出力ディレクトリのオーバーライド

事前定義されたレポート・グループは、クラスタ・メンバーの起動場所であるディレクトリにレポートを保存するようデフォルトで構成されています。レポートが保存されるクラスタ・メンバーの出力ディレクトリを構成できます。

出力ディレクトリは、coherence.reporter.output.directoryシステム・プロパティを使用してオーバーライドされます。たとえば: 

-Dcoherence.reporter.output.directory=/mydirectory

パスは、絶対パスまたはクラスタ・メンバーが起動されるディレクトリに対する相対パス(./)として指定できます。メンバーが実行しているユーザー名には、このパスに対する読取り/書込みアクセスが必要です。

親トピック: Oracle Coherenceのレポート機能の使用

レポートのタイムスタンプ・フォーマットの変更

レポートのタイム・ゾーンおよび時刻と日付の形式は、必要に応じて変更できます。レポート・タイムスタンプは、ローカルのタイム・ゾーンのデフォルトの日時形式(EEE MMM dd HH:mm:ss zzz yyyy)で表示されます。タイム・ゾーンは、ゾーンID(たとえば、US/東部時間)またはカスタムID(たとえば、GMT-05:00)を使用して入力します。日時形式は、java.text.SimpleDateFormatクラスで定義したパターンに従います。

レポート・タイムスタンプ・フォーマットを変更するには、オペレーション・オーバーライド・ファイルを編集し、<reporter>要素内に<timezone>および<timeformat>要素を、それぞれ該当するタイムゾーンと日時形式に設定して追加します。たとえば: 

<?xml version='1.0'?>

<coherence xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://xmlns.oracle.com/coherence/coherence-operational-config"
   xsi:schemaLocation="http://xmlns.oracle.com/coherence/coherence-operational-config
   coherence-operational-config.xsd">
   <management-config>
      <reporter>
         <timezone 
            system-property="coherence.management.report.timezone">
            US/Eastern
         </timezone>
         <timeformat 
            system-property="coherence.management.report.timeformat">
            MMM dd, yyyy  hh:mm:ss a
         </timeformat>
      </reporter>
   </management-config>
</coherence>

coherence.management.report.timezoneおよびcoherence.management.report.timeformatシステム・プロパティでレポート・タイムスタンプ・フォーマットを変更することもできます。たとえば: 

-Dcoherence.management.report.timezone=US/Eastern
-Dcoherence.management.report.timeformat=MMM dd, yyyy hh:mm:ss a

親トピック: Oracle Coherenceのレポート機能の使用

Reporter MBeanを使用したOracle Coherenceのレポート機能の管理

ReporterMBean MBeanは、Coherenceレポートを管理し、共通のレポート・タスクを実行するための便利な方法を提供します。
MBeanには、リアルタイムでレポートを管理するための多くの属性と操作が含まれています。「Oracle Coherence MBeanへのアクセス」を参照してください。

ノート:

ReporterMBean MBeanで行った変更は永続的ではありません。クラスタ・メンバーが再起動すると、設定は元の値に戻ります。

ReporterMBean MBeanは次のタスクを実行します。

  • レポート作成の開始 – 現在停止している場合は、start操作を使用してレポート作成を開始します。

  • レポート作成の停止 – stop操作を使用してレポート作成を停止します。クラスタ・メンバーがレポート作成を自動的に開始するように構成されている場合、クラスタ・メンバーの再起動時にレポート作成が再開します。

  • オンデマンド・レポートの実行 – runReport操作を使用して、1つのレポートまたはレポート・グループの作成を一度に実行できます。クラスパスにあるレポート構成ファイルまたはレポート・グループ構成ファイルの完全パスまたは相対パスを指定します。レポートを実行する前に、レポート機能が有効化されていることを確認してください。たとえば、reports/report-memory-summary.xmlを入力し、coherence.jarファイルにあるメモリー・サマリー・レポートを実行します。

  • オンデマンド表レポートの実行 – runTabularReport操作を使用して、1つのレポートまたはレポート・グループを一度に実行します。結果は、別のウィンドウに表形式で返され表示されます。レポートを実行する前に、レポート機能が有効化されていることを確認してください。

    クラスパスにあるレポート構成ファイルまたはレポート・グループ構成ファイルの完全パスまたは相対パスを指定します。たとえば、reports/report-memory-summary.xmlを入力し、coherence.jarファイルにあるメモリー・サマリー・レポートを実行します。

    runTabularReport操作でも、レポートまたはレポート・グループ構成ファイルのXML構文を入力できます。XML構文を入力すると、クラスパスにないレポートを実行でき、これによって、レポートまたはレポート・グループをすべてのキャッシュ・サーバーにデプロイするステップとローリング再起動を実行するステップを省略できます。レポート・グループのXMLを入力すると、個々のレポートがクラスパスで検出される必要があります。

  • オンデマンド表グループ・レポートの実行 – runTabularGroupReport操作を使用して、レポート・グループを一度に実行し、レポートのXML構文に渡します。結果は、別のウィンドウに表形式で返され表示されます。レポートを実行する前に、レポート機能が有効化されていることを確認してください。

  • 出力パスの変更 – OutputPath属性を使用して、レポートの保存先を変更します。

  • リフレッシュ間隔の変更 – IntervalSeconds属性を使用して、レポート・データのリフレッシュ頻度を変更します。

  • レポート構成ファイルの変更 – ConfigFile属性を使用して、使用するレポート・グループ構成ファイルを変更します。

  • バッチ番号の変更 – CurrentBatch属性を使用して、現在のバッチ番号を変更します。レポートの次回のリフレッシュでは、新しいバッチ番号から増分します。

図5-1は、JConsole内のReporterMBean MBeanの属性と操作を示しています。「Reporter MBean」も参照してください。

図5-1 JConsole内のReporterMBean MBean

図5-1の説明が続きます
「図5-1 JConsole内のReporterMBean MBean」の説明

親トピック: Oracle Coherenceのレポート機能の使用

分散構成でのOracle Coherenceのレポート機能の実行

分散レポートは、報告者の集中管理を可能にしながら、各メンバーがローカルのJMX統計のみをログに記録するように構成されます。分散構成は、クラスタの安定性が確認されている状況を想定しています。この構成では、各クラスタ・メンバーのレポートの実行時間は調整されません。そのため、クラスタ・レベルの分析は非常に困難になりますが、メンバーがクラスタに参加または離脱している間のメンバー・レベルの分析は可能です。

分散構成を有効にするには、次のシステム・プロパティを使用して、管理メンバーを起動します。

-Dcoherence.management.report.autostart=false
-Dcoherence.management.report.distributed=true
-Dcoherence.management=all

次のシステム・プロパティを使用して、管理対象クラスタ・メンバーを起動します。

-Dcoherence.management.report.autostart=true
-Dcoherence.management.report.distributed=true
-Dcoherence.management=local-only
-Dcoherence.management.remote=true

親トピック: Oracle Coherenceのレポート機能の使用