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

Oak-run は、コマンドラインで以下のようなインデックスに関する使用例をサポートします。AEM の JMX コンソールを使用する必要はありません。

oak-run.jar インデックスコマンドを使用して Oak インデックスを管理する全般的なメリットとして、以下のものがあります。

以下の節では、サンプルコマンドを示します。 oak-run index コマンドは、すべての NodeStore および BlobStore 設定をサポートします。 以下に示す例は、FileDataStore と SegmentNodeStore を持つ設定に関するものです。

使用例 1 — インデックスの整合性チェック usercase1indexconsistencycheck

これは、インデックスの破損に関連する使用例です。 場合によっては、破損しているインデックスを特定できないことがありました。 したがって、Adobeには次のようなツールが用意されています。

破損しているインデックスのチェックは、--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

クエリのパフォーマンスAdobeに関する事例の一部を診断するには、多くの場合、既存のインデックス定義、お客様の設定からのインデックス関連の統計が必要でした。 これまで、この情報は複数のリソースに分散されていました。 トラブルシューティングを容易にするために、Adobeは次のツールを作成しました。

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

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

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 index コマンドには次の利点があります。

インデックス再作成 - 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を停止させる必要があることです。

帯域外再インデックス — SegmentNodeStore outofbandreindexsegmentnodestore

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

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

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

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

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

Oak-run では、JSON 形式でのインデックス定義の提供と、ライブインスタンスで変更が実行されない帯域外モードでのインデックスの作成がサポートされるようになりました。

この使用例で考慮する必要があるプロセスは次のとおりです。