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

Adobe Experience Manager(AEM)でのインデックス作成のベストプラクティスについて説明します。Apache Jackrabbit Oak は、AEM のコンテンツ検索を強化します。重要なポイントは次のとおりです。

  • 標準では、AEM は、検索やクエリ機能をサポートする様々なインデックスを提供します。例えば、damAssetLucenecqPageLucene などです。
  • すべてのインデックス定義は、/oak:index ノード下にあるリポジトリーに保存されます。
  • AEM as a Cloud Service は Oak Lucene インデックスのみをサポートします。
  • インデックスの設定は、AEM プロジェクトコードベースで管理し、Cloud Manager CI/CD パイプラインを使用してデプロイする必要があります。
  • 特定のクエリに対して複数のインデックスが使用可能な場合、推定コストが最も低い指標を使用 ​します。
  • 特定のクエリに使用できるインデックスがない場合、一致するコンテンツを見つけるためにコンテンツツリが走査されます。ただし、org.apache.jackrabbit.oak.query.QueryEngineSettingsService はデフォルトで、10,000 個のノードをトラバースするだけです。
  • 現在のユーザーが読み取りアクセス権を持っていることを確認するため、クエリの結果は​ 最終的にフィルタリングされ ​ます。つまり、クエリ結果は、インデックスで指定されたノードの数よりも少なくなる場合があります。
  • インデックス定義を変更した後にリポジトリーのインデックスを再作成するには時間が必要で、リポジトリーのサイズに応じて異なります。

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

OOTB インデックスのカスタマイズ

  • AEMCS では、OOTB インデックスをカスタマイズするときに、<OOTBIndexName>-<productVersion>-custom-<customVersion> 命名規則を使用します。 例えば、cqPageLucene-custom-1damAssetLucene-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:Pagecq: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>) です。
    code language-xml
    /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"]
    ...
    

ベストプラクティスを理解するために、いくつかの例を確認します。

タグプロパティの不適切な使用方法

以下の図は、カスタムおよび OOTB のインデックス定義を示し、tags プロパティがハイライトされています。両方のインデックスで同じ visualSimilaritySearch の値が使用されています。

タグプロパティの不適切な使用方法

分析

これはカスタムインデックスの tags プロパティの不適切な使用です。Oak クエリエンジンは、推定コストが最も低い原因となる OOTB インデックスを超えるカスタムインデックスを選択します。

正しい方法は、OOTB インデックスをカスタマイズし、indexRules ノードにプロパティを追加することです。詳しくは、OOTB インデックスのカスタマイズを参照してください。

dam:Asset ノードタイプのインデックス

以下の画像は、includedPaths プロパティが特定のパスに設定された dam:Asset ノードタイプのカスタムインデックスを示しています。

dam:Asset ノードタイプのインデックス

分析

Assets に対してオムニサーチを実行すると、誤った結果が返されるので、カスタムインデックスの推定コストが下がります。

dam:Asset ノードタイプにカスタムインデックスを作成せず、indexRules ノードの追加プロパティを使用して OOTB damAssetLucene インデックスをカスタマイズします。

インデックス作成ルールの下の複数のノードタイプ

下の画像は、indexRules ノードの下に複数のノードタイプがあるカスタムインデックスを示しています。

インデックス作成ルールの下の複数のノードタイプ

分析

1 つのインデックスに複数のノードタイプを追加することは推奨されませんが、cq:Pagecq:PageContent など、ノードタイプが密接に関連している場合は、同じインデックスに複数のノードタイプをインデックス化しても問題ありません。

有効な解決策は、OOTB の cqPageLucenedamAssetLucene インデックスをカスタマイズし、既存の indexRules ノードの下にプロパティを追加することです。

queryPaths プロパティがない

以下の画像は、queryPaths プロパティがない(命名規則にも従っていない)カスタムインデックスを示しています。

queryPaths プロパティがない

分析

常に queryPaths の値を includedPaths と同じ値に設定します。また、パスの制限を適用するには、evaluatePathRestrictions プロパティを true に設定します。

インデックスタグを使用したクエリ

以下の画像は、tags プロパティを持つカスタムインデックスと、クエリ時にそれを使用する方法が示されています。

インデックスタグを使用したクエリ

/jcr:root/content/dam//element(*,dam:Asset)[(jcr:content/@contentFragment = 'true' and jcr:contains(., '/content/sitebuilder/test/mysite/live/ja-jp/mypage'))]order by @jcr:created descending option (index tag assetPrefixNodeNameSearch)
分析

インデックスに矛盾のない正しい tags プロパティ値を設定し、クエリ時に使用する方法を示しています。一般的なクエリ構文は <query> option(index tag <tagName>) です。クエリオプションのインデックスタグも参照してください。

カスタムインデックス

以下の画像は、詳細検索機能を実現するための suggestion ノードを持つカスタムインデックスを示しています。

カスタムインデックス

分析

これは、詳細検索機能のためにカスタムインデックスを作成する、有効なユースケースです。ただし、インデックス名は &lt;prefix>.&lt;customIndexName>-&lt;version>-custom-&lt;customVersion> の命名規則に従う必要があります。

便利なツール

インデックスの定義、分析、最適化に役立つツールをいくつか見てみましょう。

インデックス作成ツール

Oak Index Definition Generator ツールは、入力クエリに基づいて​ インデックス定義を生成する ​のに役立ちます。カスタムインデックスを作成するための良い出発点となります。

インデックス分析ツール

Index Definition Analyzer は、インデックス定義を分析する ​のに役立つツールで、インデックス定義を改善するための推奨事項を提供します。

クエリパフォーマンスツール

OOTB の​ クエリパフォーマンスツール ​は、ローカル SDK および AEMCS のDeveloper Console または https://author-pXXXX-eYYYY.adobeaemcloud.com/ui#/aem/libs/granite/operations/content/diagnosistools/queryPerformance.html?appId=aemshell から入手でき、クエリのパフォーマンスを分析する ​のに役立ちます。JCR クエリチートシートは最適なクエリの定義に役立ちます。

トラブルシューティングのツールとヒント

以下のほとんどが、AEM 6.X およびローカルのトラブルシューティングの目的で適用できます。

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

  • Oak クエリの詳細なログと、インデックス作成に関連する Java™ パッケージ(org.apache.jackrabbit.oak.plugins.indexorg.apache.jackrabbit.oak.querycom.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 クエリの統計を取得できます。

その他のリソース

詳しくは、次のドキュメントを参照してください。

recommendation-more-help
c92bdb17-1e49-4e76-bcdd-89e4f85f45e6