AEM でのインデックス作成のベストプラクティス

検索要件を理解し、OOTB インデックスが検索要件をサポートできるかどうかを確認します。 ローカル SDK および開発者コンソールまたは https://author-pXXXX-eYYYY.adobeaemcloud.com/ui#/aem/libs/granite/operations/content/diagnosistools/queryPerformance.html?appId=aemshell 経由の AEMCS で利用可能な​ クエリパフォーマンスツール ​を使用します。

最適なクエリを定義します。クエリの最適化フローチャートと JCR クエリチートシートを参考にしてください。

OOTB インデックスが検索要件をサポートしない場合は、2 つのオプションがあります。 ただし、効率的なインデックス作成のヒントを確認してください。

• OOTB インデックスのカスタマイズ：保守とアップグレードが簡単に行える、お勧めのオプション。
• 完全なカスタムインデックス：上記のオプションが機能しない場合のみ。

AEMCS では、OOTB インデックスをカスタマイズするときに、<OOTBIndexName>-<productVersion>-custom-<customVersion> 命名規則を使用します。 例えば、cqPageLucene-custom-1 や damAssetLucene-8-custom-1 です。 これは、OOTB インデックスが更新されるたびに、カスタマイズされたインデックス定義を結合するのに役立ちます。 詳しくは、標準提供のインデックスの変更を参照してください。

AEM 6.X では、上記の命名方法は​ 機能しません。indexRules ノードの必要なプロパティで OOTB インデックスを更新するだけです。

常に CRX DE Package Manager（/crx/packmgr/）を使用して AEM インスタンスから最新の OOTB インデックス定義をコピーし、名前を変更して XML ファイル内にカスタマイズを追加します。

インデックス定義を AEM プロジェクト（ui.apps/src/main/content/jcr_root/_oak_index）に格納して、Cloud Manager CI／CD パイプラインを使用してデプロイします。 詳しくは、カスタムインデックス定義のデプロイを参照してください。

完全なカスタムインデックスを作成する場合は、<prefix>.<customIndexName>-<version>-custom-<customVersion> 命名規則を使用します。 例えば、wknd.adventures-1-custom-1 のようになります。 これにより、名前の競合を回避できます。 ここで wknd はプレフィックスで、adventures は、カスタムインデックス名です。 この規則は、AEM 6.X と AEMCS の両方に適用され、AEMCS への将来の移行に備えるのに役立ちます。

AEMCS は Lucene インデックスのみをサポートしているので、AEMCS への今後の移行に備えて、常に Lucene インデックスを使用します。 詳しくは、Lucene インデックスとプロパティインデックスを参照してください。

OOTB インデックスと同じノードタイプでカスタムインデックスを作成しないでください。 代わりに、indexRules ノードの必要なプロパティを使用して OOTB インデックスをカスタマイズします。 例えば、dam:Asset ノードタイプにカスタムインデックスを作成せず、OOTB damAssetLucene インデックスをカスタマイズします。 このことは、パフォーマンスと機能の問題の一般的な根本原因でした。

また、インデックス作成ルール（indexRules）ノードの下に複数のノードタイプ（cq:Page や cq:Tag など）を追加することは避けてください。 代わりに、ノードタイプごとに別々のインデックスを作成します。

上記の節で説明したように、インデックス定義をAEMプロジェクト（ui.apps/src/main/content/jcr_root/_oak_index）に格納して、Cloud Manager CI／CD パイプラインを使用してデプロイします。 詳しくは、カスタムインデックス定義のデプロイを参照してください。

インデックス定義のガイドラインを次に示します。

• ノードタイプ（jcr:primaryType）は oak:QueryIndexDefinition
• インデックスのタイプ（type）は lucene
• async プロパティ（async）は async,nrt
• includedPaths を使用して excludedPaths プロパティを回避します。 常に queryPaths 値を includedPaths 値と同じ値に設定します。
• パスの制限を適用するには、evaluatePathRestrictions プロパティを使用して true に設定します。
• tags プロパティを使用してインデックスにタグを付け、クエリ時にこのタグ値を指定してインデックスを使用します。 一般的なクエリ構文は <query> option(index tag <tagName>) です。

/oak:index/wknd.adventures-1-custom-1
    - jcr:primaryType = "oak:QueryIndexDefinition"
    - type = "lucene"
    - compatVersion = 2
    - async = ["async", "nrt"]
    - includedPaths = ["/content/wknd"]
    - queryPaths = ["/content/wknd"]
    - evaluatePathRestrictions = true
    - tags = ["customAdvSearch"]
...

インデックスマネージャーが http://host:port/libs/granite/operations/content/diagnosistools/indexManager.html で入手でき、タイプ、最終更新日、サイズなどのインデックス情報を取得できます。

Oak クエリの詳細なログと、インデックス作成に関連する Java™ パッケージ（org.apache.jackrabbit.oak.plugins.index、org.apache.jackrabbit.oak.query、com.day.cq.search など）が http://host:port/system/console/slinglog から入手でき、トラブルシューティングに利用できます。

IndexStats タイプの JMX MBean が http://host:port/system/console/jmx で入手でき、非同期インデックス作成に関連するステータス、進行状況、統計などのインデックス情報を取得できます。 また、FailingIndexStats も提供されていて、ここに結果がない場合はインデックスが破損していないことを意味します。 AsyncIndexerService は、30 分間（設定可能）更新に失敗したインデックスを破損したものとしてマークし、インデックス作成を停止します。 クエリが期待した結果を返さない場合、インデックス再作成は計算コストが高く時間もかかるため、開発者はインデックス再作成を続行する前にこれを確認すると役に立ちます。

LuceneIndex タイプの JMX MBean が http://host:port/system/console/jmx で入手でき、サイズやインデックス定義ごとのドキュメント数などの Lucene インデックス統計を取得できます。

QueryStat タイプの JMX MBean が http://host:port/system/console/jmx で入手でき、遅いクエリや一般的なクエリを含む、クエリや実行時間などの詳細が付いた Oak クエリの統計を取得できます。