JMX コンソールを使用したサーバーリソースの監視 monitoring-server-resources-using-the-jmx-console

JMX コンソールを使用すると、CRX サーバー上のサービスを監視および管理できます。以下の節では、JMX フレームワークによって明らかになる属性および操作についてまとめます。

コンソール制御の使用方法について詳しくは、JMX コンソールの使用を参照してください。JMX の背景情報については、Oracle web サイトの Java Management Extensions (JMX) Technology ページを参照してください。

JMX コンソールを使用して、MBean を作成し、サービスを管理する方法について詳しくは、サービスと JMX コンソールの統合を参照してください。

ワークフローのメンテナンス workflow-maintenance

実行中、完了済み、期限切れ、または失敗したワークフローインスタンスを管理するための操作です。

運用 operations

listRunningWorkflowsPerModel ワークフローモデルごとに、実行されているワークフローインスタンスの数をリストします。

listCompletedWorkflowsPerModel ワークフローモデルごとに、完了したワークフローインスタンスの数をリストします。

returnWorkflowQueueInfo 処理済み、および処理に向けて待機中のワークフロー項目に関する情報をリストします。

returnWorkflowJobTopicInfo ワークフロージョブの処理情報を、トピックごとにまとめてリストします。

returnFailedWorkflowCount 失敗したワークフローインスタンスの数を表示します。クエリ対象のワークフローモデルを指定したり、すべてのワークフローモデルの情報を取得したりできます。

returnFailedWorkflowCountPerModel ワークフローモデルごとに、失敗したワークフローインスタンスの数を表示します。

terminateFailedInstances 失敗したワークフローインスタンスを終了します。失敗したインスタンスをすべて終了するか、特定のモデルの失敗したインスタンスのみを終了するかを指定できます。オプションで、終了後にインスタンスを再開できます。また、操作をテストして、実際に操作を行わずに結果を確認することもできます。

retryFailedWorkItems 失敗した作業項目のステップの実行を試みます。失敗した作業項目をすべて再試行するか、特定のワークフローモデルの失敗した作業項目のみを再試行するかを指定できます。オプションで、操作をテストして、実際に操作を行わずに結果を確認することもできます。

PurgeActive 特定の時間が経過したアクティブなワークフローインスタンスを削除します。すべてのモデルのアクティブなインスタンスをパージするか、特定のモデルのインスタンスのみをパージするかを指定できます。オプションで、操作をテストして、実際に操作を行わずに結果を確認することもできます。

countStaleWorkflows 古くなったワークフローインスタンスの数を返します。古くなったインスタンスの数は、すべてのワークフローモデルに関して、または特定のモデルに関して取得できます。

restartStaleWorkflows 古くなったワークフローインスタンスを再開します古くなったインスタンスをすべて再開するか、特定のモデルの古くなったインスタンスのみを再開するかを指定できます。また、操作をテストして、実際に操作を行わずに結果を確認することもできます。

fetchModelList すべてのワークフローモデルのリストを表示します。

countRunningWorkflows 実行中のワークフローインスタンスの数を返します。実行中のインスタンスの数は、すべてのワークフローモデルに関して、または特定のモデルに関して取得できます。

countCompletedWorkflows 完了したワークフローインスタンスの数を返します。完了したインスタンスの数は、すべてのワークフローモデルに関して、または特定のモデルに関して取得できます。

purgeCompleted 特定の期間が経過した完了済みワークフローの記録をリポジトリから削除します。この操作を定期的に使用すると、ワークフローを多用するときにリポジトリのサイズを最小限に抑えることができます。すべてのモデルの完了したインスタンスをパージするか、特定のモデルのインスタンスのみをパージするかを指定できます。オプションで、操作をテストして、実際に操作を行わずに結果を確認することもできます。

リポジトリ repository

CRX リポジトリに関する情報

属性 attributes

名前 JCR リポジトリ実装の名前。読み取り専用。

バージョン リポジトリの実装バージョン。読み取り専用。

HomeDir リポジトリが配置されているディレクトリ。デフォルトの場所は、＜QuickStart_Jar_Location＞／crx-quickstart／repository です。読み取り専用。

CustomerName ソフトウェアライセンスの発行対象である顧客の名前。読み取り専用。

LicenseKey リポジトリのこのインストールの一意なライセンスキー。読み取り専用。

AvailableDiskSpace リポジトリのこのインスタンスで使用可能なディスク容量（メガバイト単位）。読み取り専用。

MaximumNumberOfOpenFiles 一度に開くことのできるファイルの数。読み取り専用。

SessionTracker crx.debug.sessions システム変数の値。true は、デバッグセッションを示します。false は通常のセッションを示します。読み取り／書き込み。

Descriptors リポジトリのプロパティを表すキーと値のペア。すべてのプロパティは読み取り専用です。

WorkspaceNames リポジトリ内のワークスペースの名前。読み取り専用。

DataStoreGarbageCollectionDelay 10 番目のノードごとにスキャンした後、ガベージコレクションがスリープする時間をミリ秒で指定します。読み取り／書き込み。

BackupDelay バックアップの各ステップ間でバックアッププロセスがスリープする時間（ミリ秒）です。読み取り／書き込み。

BackupInProgress true の値がバックアップ処理が実行されていることを示します 。読み取り専用。

BackupProgress 現在のバックアップについて、全ファイルのバックアップが完了した割合。読み取り専用。

CurrentBackupTarget 現在のバックアップの場合、バックアップファイルが保存されている ZIP ファイルです。バックアップが進行中でない場合は、値は表示されません。読み取り専用。

BackupWasSuccessful 値が true の場合、現在のバックアップ中にエラーが発生していないか、処理中のバックアップがありません。false は、現在のバックアップ中にエラーが発生したことを示します。読み取り専用。

BackupResult 現在のバックアップのステータス。次の値を指定できます。

読み取り専用。

TarOptimizationRunningSince 現在の TAR ファイル最適化プロセスの開始時刻。読み取り専用。

TarOptimizationDelay TAR 最適化プロセスの各ステップの合間にプロセスがスリープ状態になる時間（ミリ秒単位）。読み取り／書き込み。

ClusterProperties クラスターのプロパティと値を表すキーと値のペアのセット。テーブル内の各行にクラスタープロパティが 1 つずつ表示されます。読み取り専用。

ClusterNodes リポジトリクラスターのメンバー。

ClusterId このリポジトリクラスターの識別子。読み取り専用。

ClusterMasterId このリポジトリクラスターのマスターノードの識別子。読み取り専用。

ClusterNodeId リポジトリクラスターのこのノードの識別子。読み取り専用。

操作 operations-1

createWorkspace このリポジトリにワークスペースを作成します。

runDataStoreGarbageCollection ​リポジトリノードでガベージコレクションを実行します。

stopDataStoreGarbageCollection 実行中のデータストアのガベージコレクションを停止します。

startBackup リポジトリデータを ZIP ファイルにバックアップします。

cancelBackup 現在のバックアッププロセスを停止して、データのアーカイブ用にプロセスによって作成された一時アーカイブを削除します。

blockRepositoryWrites ​リポジトリデータに対する変更をブロックします。すべてのリポジトリバックアップリスナーに、ブロックが通知されます。

unblockRepositoryWrites ​リポジトリからブロックを削除します。すべてのリポジトリバックアップリスナーに、ブロックの削除が通知されます。

startTarOptimization tarOptimizationDelay のデフォルト値を使用して、TAR ファイルの最適化プロセスを開始します。

stopTarOptimization TAR ファイルの最適化を停止します。

tarIndexMerge すべての TAR セットにおける上位のインデックスファイルを結合します。上位のインデックスファイルは、複数のメジャーバージョンのファイルです。例えば、index_1_1.tar ファイル、index_2_0.tar ファイル、index_3_0.tar ファイルは、index_3_1.tar ファイルに結合されます。結合されたファイルは削除されます（前の例では、index_1_1.tar、index_2_0.tar、index_3_0.tar が削除されます）。

becomeClusterMaster このリポジトリノードをクラスターのプライマリノードとして設定します。プライマリに設定されていない場合、このコマンドは現在のプライマリインスタンスのリスナーを停止し、現在のノードのプライマリリスナーを開始します。その後、このノードがプライマリノードとして設定され、再起動されると、クラスター内の他のすべてのノード（プライマリによって制御されるノード）がこのインスタンスに接続します。

joinCluster このリポジトリを、クラスターのプライマリによって制御されるノードとしてクラスターに追加します。認証のためにユーザー名とパスワードを指定します。接続では基本認証を使用します。セキュリティ資格情報は、サーバーに送信される前に base-64 エンコードされます。

traversalCheck 特定のノードで始まるサブツリー内の不整合をトラバースし、オプションで修正します。これについては、永続性マネージャーに関するドキュメントで詳しく説明します。

consistencyCheck データストアの整合性を確認し、オプションで修正します。これについては、データストアに関するドキュメントで詳しく説明します。

リポジトリ統計（TimeSeries） repository-statistics-timeseries

org.apache.jackrabbit.api.stats.RepositoryStatistics で定義される、各統計タイプの TimeSeries フィールドの値。

属性 attributes-1

報告される統計タイプごとに、以下の属性が提供されています。

リポジトリクエリ統計 repository-query-stats

リポジトリクエリに関する統計情報。

属性 attributes-2

SlowQueries 完了までの所要時間が最長だったリポジトリクエリに関する情報。読み取り専用。

SlowQueriesQueueSize SlowQueries リストに含めるクエリの最大数。読み取り／書き込み。

PopularQueries 最も多く発生したリポジトリクエリに関する情報。読み取り専用。

PopularQueriesQueueSize Popular Queries リスト内のクエリの最大数。読み取り／書き込み。

操作 operations-2

clearSlowQueriesQueue SlowQueries リストからすべてのクエリを削除します。

clearPopularQueriesQueue PopularQueries リストからすべてのクエリを削除します。

レプリケーションエージェント replication-agents

レプリケーションエージェントごとにサービスを監視します。レプリケーションエージェントを作成すると、JMX コンソールにサービスが自動的に表示されます。

属性 attributes-3

ID レプリケーションエージェント設定の識別情報を表す String 値。複数のエージェントが同じ設定を使用できます。読み取り専用。

Valid エージェントが正しく設定されているかどうかを示すブール値。

読み取り専用。

Enabled エージェントが有効かどうかを示すブール値。

QueueBlocked キューが存在し、ブロックされているかどうかを示すブール値。

読み取り専用。

QueuePaused ジョブキューが一時停止しているかどうかを示すブール値。

読み取り／書き込み。

QueueNumEntries エージェントキュー内のジョブ数を表す整数値。読み取り専用。

QueueStatusTime 表示されているステータス値が取得されたサーバー上の時間を示す Date 値。この値は、ページが読み込まれた時刻と一致します。読み取り専用。

QueueNextRetryTime ブロックされたキューについて、次回の自動再試行日を示す Date 値。時間が表示されない場合、キューはブロックされません。読み取り専用。

QueueProcessingSince 現在のジョブの処理を開始した日を示す Date 値。時間が表示されない場合、キューはブロックされるか、アイドル状態となります。読み取り専用。

QueueLastProcessTime 前回のジョブの完了日を示す Date 値。読み取り専用。

操作 operations-3

queueForceRetry ブロックされているキューに対して、再試行コマンドを発行します。

queueClear キューからすべてのジョブを削除します。

Sling エンジン sling-engine

HTTP リクエストに関する統計を提供し、SlingRequestProcessor サービスのパフォーマンスを監視できるようにします。

属性 attributes-4

RequestsCount 統計が最後にリセットされた以降に発生した要求の数。

MinRequestDurationMsec 統計が最後にリセットされた以降に要求の処理に要した最短時間（ミリ秒単位）。

MaxRequestDuratioMsec 統計が最後にリセットされた以降に要求の処理に要した最長時間（ミリ秒単位）。

StandardDeviationDurationMsec 要求の処理に要した時間の標準偏差。標準偏差は、統計が最後にリセットされた以降のすべての要求を使用して計算されます。

MeanRequestDurationMsec 1 つの要求の処理に要した平均時間。平均は、統計が最後にリセットされて以降のすべての要求を使用して計算されます。

運用 operations-4

resetStatistics すべての統計をゼロに設定します。特定の期間の要求処理のパフォーマンスを分析する必要があるときに統計をリセットします。

id パッケージ ID の文字列表現。

installed パッケージがインストールされているかどうかを示す boolean 値。

installedBy パッケージを最後にインストールしたユーザーの ID。

installedDate パッケージが最後にインストールされた日付。

size パッケージのサイズ（バイト数）を保持する long 値。

クイックスタートランチャー quickstart-launcher

起動プロセスおよびクイックスタートランチャーに関する情報。

運用 operations-5

log

クイックスタートウィンドウにメッセージを表示します。

引数：

startupFinished

サーバーランチャーの startupFinished メソッドを呼び出します。このメソッドにより、web ブラウザーにようこそページが開きます。

startupProgress

サーバー起動プロセスの完了値を設定します。クイックスタートウィンドウの進行状況バーが、完了値を表します。

サードパーティのサービス third-party-services

いくつかのサードパーティのサーバーリソースでは、MBean がインストールされ、これによって属性および操作が JMX コンソールに提供されます。次の表では、サードパーティのリソースをリストし、詳細のリンクを提供します。

JMX コンソールの使用 using-the-jmx-console

JMX コンソールには、サーバー上で実行されているいくつかのサービスに関する情報が表示されます。

OSGi サービスでデプロイされる MBean により、サービスの属性および操作がコンソールに公開されます。MBean は、公開される属性および操作と、属性が読み取り専用か読み取り／書き込みかを決定します。

JMX コンソールのメインページには、サービスの表が含まれます。表の行ごとに、MBean によって公開されるサービスを 1 つずつ表します。

監視のための外部 JMX アプリケーションの使用 using-external-jmx-applications-for-monitoring

CRX を使用すると、外部アプリケーションと Managed Bean（MBean）が Java Management Extensions（JMX）経由でやり取りできます。JConsole のような汎用コンソールやドメイン専用の監視アプリケーションを使用すると、CRX の設定やプロパティを取得および設定したり、パフォーマンスやリソース使用状況を監視したりできます。

JConsole を使用した CRX への接続 using-jconsole-to-connect-to-crx

JConsole を使用して CRX に接続するには、次の手順に従います。

JConsole が起動して、JConsole ウィンドウが表示されます。

ローカルの CRX プロセスへの接続 connecting-to-a-local-crx-process

JConsole には、ローカルの Java 仮想マシンプロセスのリストが表示されます。このリストには 2 つのクイックスタートプロセスが含まれます。ローカルプロセスのリストから、クイックスタート「CHILD」プロセス（通常は PID が大きいほうのプロセス）を選択します。

リモートの CRX プロセスへの接続 connecting-to-a-remote-crx-process

リモート CRX プロセスに接続するには、リモート CRX プロセスをホストする JVM で、リモート JMX 接続を受け入れるように有効にする必要があります。

リモート JMX 接続を有効にするには、JVM の起動時に以下のシステムプロパティを設定する必要があります。

com.sun.management.jmxremote.port=portNum

上記のプロパティで、portNum は、JMX RMI 接続を有効にするポート番号です。未使用のポート番号を必ず指定してください。ローカルアクセス用の RMI コネクターを公開する以外に、このプロパティを設定すると、既知の名前「jmxrmi」を使用して、指定したポートのプライベート読み取り専用レジストリに追加の RMI コネクターが公開されます。

デフォルトでは、リモート監視用に JMX エージェントを有効にすると、パスワードファイルに基づいたパスワード認証が使用されます。パスワードファイルは、Java VM 起動時に以下のシステムプロパティを使用して指定する必要があります。

com.sun.management.jmxremote.password.file=pwFilePath

パスワードファイルの設定について詳しくは、関連する JMX のドキュメントを参照してください。

例：

$ java
  -Dcom.sun.management.jmxremote.password.file=pwFilePath
  -Dcom.sun.management.jmxremote.port=8463
  -jar ./cq-quickstart.jar

CRX で提供される MBean の使用 using-the-mbeans-provided-by-crx

クイックスタートプロセスに接続後、JConsole では、CRX が実行されている JVM に対して、様々な一般的監視ツールが提供されます。

CRX の内部監視および設定オプションにアクセスするには、「MBean」タブに移動して、左側にある階層型のコンテンツツリーから、属性または操作の関心のあるセクションを選択します。例えば、com.adobe.granite/Repository/Operations セクションなどです。

そのセクション内で、必要な属性または操作を左パネルから選択します。