oak-run.jar でのインデックス作成の使用例 oak-run-jar-indexing-use-cases

Oak-run は、コマンドラインでインデックス作成のユースケースをサポートします。AEM の JMX コンソールを使用したこれらのユースケースの実行は必要はありません。

oak-run.jar インデックスコマンドの方法を使用して Oak インデックスを管理する全般的なメリットは次のとおりです。

以下の節では、コマンドの例を示します。Oak-run インデックスコマンドは、すべての NodeStore および BlobStore 設定をサポートしています。以下では、FileDataStore および SegmentNodeStore を使用した設定の例を紹介します。

ユースケース 1 - インデックスの整合性チェック usercase1indexconsistencycheck

これは、インデックスの破損に関連するユースケースです。以前は、破損しているインデックスを特定できない場合もありました。このため、次の特長を持つツールが用意されています。

破損しているインデックスのチェックは、--index-consistency-check 操作を使用して実行できます。

java -jar oak-run*.jar index --fds-path=/path/to/datastore  /path/to/segmentstore/ --index-consistency-check

これにより、indexing-result/index-consistency-check-report.txt にレポートが生成されます。サンプルレポートについては、以下を参照してください。

Valid indexes :
        - /content/oak:index/enablementResourceName
        - /oak:index/cqProjectLucene
        - /oak:index/cqTagLucene
        - /oak:index/lucene
        - /oak:index/ntBaseLucene
        - /oak:index/socialLucene
    Invalid indexes :
        - /oak:index/atDamIndex
        - /oak:index/atIndex
        - /oak:index/cqPageLucene
        - /oak:index/damAssetLucene
        - /oak:index/groups
        - /oak:index/slingeventJob
        - /oak:index/users
        - /oak:index/workflowDataLucene
    Ignored indexes as these are not of type lucene:
        - /oak:index/acPrincipalName
        - /oak:index/active

メリット uc1benefits

このツールを使用することにより、サポートおよびシステム管理者は、破損しているインデックスをすばやく特定し、これらのインデックスを再作成できるようになりました。

ユースケース 2 - インデックス統計 usecase2indexstatistics

以前は、クエリパフォーマンスに関して診断する場合、一部のケースで、顧客の設定の既存のインデックス定義やインデックス関連統計が必要になることがありました。これらの情報は、これまで複数のリソースに散在していました。より簡単にトラブルシューティングできるように、次の特長を持つツールが用意されています。

前述の操作は、次の操作用のインデックスコマンドを使用して実行できるようになりました。

コマンドが実際にどのように機能するかについての例は、次を参照してください。

java -jar oak-run*.jar index --fds-path=/path/to/datastore  /path/to/segmentstore/ --index-info --index-definitions --index-dump

これらのレポートは、indexing-result/index-info.txt および indexing-result/index-definitions.json に生成されます。

また、同じ詳細が web コンソール経由でも提供され、設定のダンプ zip にも含まれます。この詳細には、次の場所からアクセスできます。

https://serverhost:serverport/system/console/status-oak-index-defn

メリット uc2benefits

このツールを使用すると、インデックス作成またはクエリの問題に関連するすべての必要な詳細をすばやく収集できるので、この情報の抽出にかかる時間を短縮できます。

ユースケース 3 - インデックス再作成 usecase3reindexing

シナリオによっては、インデックス再作成の実行が必要な場合があります。現在、インデックス再作成を行うには、CRXDE またはインデックスマネージャーのユーザーインターフェイスを使用して、インデックス定義ノードで reindex フラグを true に設定します。このフラグが設定されると、インデックス再作成が非同期的に行われます。

次に、インデックス再作成に関するいくつかの注意点を示します。

これらの目的を満たすために、oak-run インデックスツールでは、必要に応じて使用できるインデックス再作成の様々なモードをサポートしています。oak-run インデックスコマンドには、次のメリットがあります。

インデックス再作成 - DocumentNodeStore reindexdocumentnodestore

DocumentNodeStore インストールでは、単一の oak-run コマンドを使用してインデックス再作成を行うことができます。

java -jar oak-run*.jar index --reindex --index-paths=/oak:index/lucene --read-write --fds-path=/path/to/datastore mongodb://server:port/aem

これには次のメリットがあります。

インデックス再作成 - SegmentNodeStore reindexsegmentnodestore

SegmentNodeStore インストールでは、次のいずれかの方法でインデックス再作成を行うことができます。

オンラインのインデックス再作成 - SegmentNodeStore onlinereindexsegmentnodestore

既定の方法に従い、reindex フラグを設定してインデックス再作成を行います。

オンラインのインデックス再作成 - SegmentNodeStore - AEM インスタンス実行中 onlinereindexsegmentnodestoretheaeminstanceisrunning

SegmentNodeStore インストールでは、セグメントファイルに読み取り／書き込みモードでアクセスできるのは 1 つのプロセスのみです。このため、oak-run のインデックス作成の一部の操作では、手動による追加の手順が必要です。

これには、次のものが含まれます。

このシナリオでは、AEM サーバーを停止したり、新しいインスタンスをプロビジョニングしたりする必要はありません。ただし、インデックス作成にはリポジトリ全体のトラバーサルが伴うので、インストールへの I/O 負荷が増加し、実行時のパフォーマンスに悪影響があります。

オンラインのインデックス再作成 - SegmentNodeStore - AEM インスタンスのシャットダウン onlinereindexsegmentnodestoreaeminstanceisdown

SegmentNodeStore インストールでは、単一の oak-run コマンドを使用してインデックス再作成を行うことができます。ただし、AEM インスタンスをシャットダウンする必要があります。

次のコマンドを使用して、インデックス再作成を開始できます。

java -jar oak-run*.jar index --reindex --index-paths=/oak:index/lucene --read-write --fds-path=/path/to/datastore  /path/to/segmentstore/

この方法と前述の方法の違いは、チェックポイントの作成とインデックスの読み込みが自動的に行われることです。欠点は、処理中に AEM を終了する必要があることです。

Out of Band のインデックス再作成 - SegmentNodeStore outofbandreindexsegmentnodestore

この使用例では、クローン作成された設定でインデックスを再作成して、実行中の AEM インスタンスへの影響を最小限に抑えることができます。

この使用例では、別のインスタンスのデータストアにアクセスできることを前提としています。FileDataStore が EBS などのクラウドベースのストレージソリューションに配置されている場合は、このデータストアにアクセスできないことがあります。この場合、FileDataStore のクローンも作成されるシナリオは除外されます。インデックス定義でフルテキストのインデックス作成が実行されない場合は、DataStore へのアクセスは必要ありません。

使用例 4 - インデックス定義の更新 usecase4updatingindexdefinitions

現在、インデックス定義の変更は、ACS Ensure Index パッケージ経由で送信できます。これにより、コンテンツパッケージ経由でインデックス定義の送信が可能になります。コンテンツパッケージは後で、reindex フラグを true に設定してインデックスを再作成する必要があります。

これは、インデックス再作成に時間がかからない小規模なインストールに適しています。ただし、大きいリポジトリでは、インデックス再作成にかなりの時間がかかります。このような場合は、oak-run インデックスツールを使用できます。

oak-run では、インデックス定義を JSON 形式で提供したり、out-of-band モードでインデックスを作成したりすることができます。out-of-band モードの場合、ライブインスタンスでは変更が行われません。

この使用例を検討するプロセスは次のとおりです。