AEM의 색인화 모범 사례

검색 요구 사항을 이해하고 OOTB 인덱스가 검색 요구 사항을 지원할 수 있는지 확인합니다. Developer Console 또는 을(를) 통해 ​로컬 SDK 및 AEMCS에서 사용할 수 있는쿼리 성능 도구https://author-pXXXX-eYYYY.adobeaemcloud.com/ui#/aem/libs/granite/operations/content/diagnosistools/queryPerformance.html?appId=aemshell를 사용합니다.

최적의 쿼리를 정의하고 쿼리 최적화 순서도와 JCR 쿼리 치트 시트를 참조하십시오.

OOTB 인덱스가 검색 요구 사항을 지원할 수 없는 경우 두 가지 옵션이 있습니다. 그러나 효율적인 색인을 만들기 위한 팁을 검토하십시오.

• OOTB 인덱스 사용자 정의: 유지 관리 및 업그레이드가 용이하여 선호하는 옵션.
• 완전히 맞춤화된 색인: 위의 옵션이 작동하지 않는 경우에만 해당됩니다.

AEMCS ​에서 OOTB 인덱스를 사용자 지정할 때 <OOTBIndexName>-<productVersion>-custom-<customVersion> 명명 규칙을 사용합니다. 예: cqPageLucene-custom-1 또는 damAssetLucene-8-custom-1. 이렇게 하면 OOTB 색인이 업데이트될 때마다 사용자 지정된 색인 정의를 병합하는 데 도움이 됩니다. 자세한 내용은 기본 제공 색인에 대한 변경 내용을 참조하세요.

AEM 6.X ​에서 위의 이름 지정 이(가) 작동하지 않습니다. 그러나 indexRules 노드에서 필요한 속성으로 OOTB 인덱스를 업데이트하기만 하면 됩니다.

항상 CRX DE 패키지 관리자(https://experienceleague.adobe.com/crx/packmgr/?lang=ko)를 사용하여 AEM 인스턴스에서 최신 OOTB 인덱스 정의를 복사하고 이름을 변경한 다음 XML 파일 내에 사용자 지정을 추가합니다.

인덱스 정의를 ui.apps/src/main/content/jcr_root/_oak_index의 AEM 프로젝트에 저장하고 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 인덱스를 사용자 지정하십시오. 성능 및 기능 문제의 일반적인 근본 원인입니다.

또한 인덱싱 규칙(cq:Page) 노드 아래에 cq:Tag 및 indexRules과 같은 여러 노드 형식을 추가하지 마십시오. 대신 각 노드 유형에 대해 별도의 인덱스를 만듭니다.

위의 섹션에서 설명한 대로 인덱스 정의를 ui.apps/src/main/content/jcr_root/_oak_index의 AEM 프로젝트에 저장하고 Cloud Manager CI/CD 파이프라인을 사용하여 배포합니다. 자세한 내용은 사용자 지정 인덱스 정의 배포를 참조하십시오.

색인 정의 지침은 다음과 같습니다.

• 노드 형식(jcr:primaryType)은 oak:QueryIndexDefinition이어야 합니다.
• 인덱스 유형(type)은 lucene이어야 합니다.
• 비동기 속성(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에서 사용 가능한 색인 관리자를 사용하여 유형, 마지막 업데이트, 크기 등의 색인 정보를 가져올 수 있습니다.

문제 해결을 위해 org.apache.jackrabbit.oak.plugins.index을(를) 통해 Oak 쿼리 및 org.apache.jackrabbit.oak.query, com.day.cq.search, http://host:port/system/console/slinglog과(와) 같은 인덱싱 관련 Java™ 패키지를 자세히 로깅합니다.

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은 쿼리, 실행 시간 등 세부 정보가 포함된 느리고 인기 있는 쿼리를 포함하여 Oak 쿼리 통계에 대해 http://host:port/system/console/jmx에서 사용할 수 있습니다.