Práticas recomendadas de indexação no AEM

Entenda os requisitos de pesquisa e verifique se os índices OOTB podem dar suporte aos requisitos de pesquisa. Use a Ferramenta de Desempenho de Consulta, disponível em SDK local e AEMCS via Developer Console ou https://author-pXXXX-eYYYY.adobeaemcloud.com/ui#/aem/libs/granite/operations/content/diagnosistools/queryPerformance.html?appId=aemshell.

Defina uma consulta ideal, use o fluxograma de otimização de consultas e a Folha de características de consulta JCR como referência.

Se os índices OOTB não forem compatíveis com os requisitos de pesquisa, você terá duas opções. No entanto, examine as Dicas para Criar Índices Eficientes

• Personalizar o índice OOTB: opção preferencial, pois é fácil de manter e atualizar.
• Índice totalmente personalizado: somente se a opção acima não funcionar.

No AEMCS, ao personalizar o índice OOTB, use a convenção de nomenclatura <OOTBIndexName>-<productVersion>-custom-<customVersion>. Por exemplo, cqPageLucene-custom-1 ou damAssetLucene-8-custom-1. Isso ajuda a mesclar a definição de índice personalizado sempre que o índice OOTB é atualizado. Consulte Alterações em índices prontos para uso para obter mais detalhes.

No AEM 6.X, a nomenclatura acima não funciona. No entanto, basta atualizar o índice OOTB com as propriedades necessárias no nó indexRules.

Sempre copie a definição de índice OOTB mais recente da instância do AEM usando o Gerenciador de pacotes do CRX DE (https://experienceleague.adobe.com/crx/packmgr/?lang=pt-BR), renomeie-a e adicione personalizações dentro do arquivo XML.

Armazene a definição de índice no projeto do AEM em ui.apps/src/main/content/jcr_root/_oak_index e implante-a usando os pipelines de CI/CD do Cloud Manager. Consulte Implantando Definições de Índice Personalizadas para obter mais detalhes.

Ao criar um índice totalmente personalizado, use <prefix>.<customIndexName>-<version>-custom-<customVersion> convenção de nomenclatura. Por exemplo, wknd.adventures-1-custom-1. Isso ajuda a evitar conflitos de nomenclatura. Aqui, wknd é o prefixo e adventures é o nome de índice personalizado. Essa convenção é aplicável ao AEM 6.X e AEMCS e ajuda a preparar a migração futura para o AEMCS.

O AEM CS é compatível apenas com os índices Lucene, portanto, para se preparar para a migração futura para o AEM, sempre use os índices Lucene. Consulte Índices Lucene versus Índices de propriedades para obter mais detalhes.

Evite criar um índice personalizado no mesmo tipo de nó do índice OOTB. Em vez disso, personalize o índice OOTB com as propriedades necessárias no nó indexRules. Por exemplo, não crie um índice personalizado no tipo de nó dam:Asset, mas personalize o índice damAssetLucene OOTB. Foi uma causa raiz comum de problemas de desempenho e funcionais.

Além disso, evite adicionar vários tipos de nó, por exemplo cq:Page e cq:Tag, sob o nó de regras de indexação (indexRules). Em vez disso, crie índices separados para cada tipo de nó.

Como mencionado na seção acima, armazene a definição do índice no projeto do AEM em ui.apps/src/main/content/jcr_root/_oak_index e implante-a usando os pipelines de CI/CD do Cloud Manager. Consulte Implantando Definições de Índice Personalizadas para obter mais detalhes.

As diretrizes de definição do índice são:

• O tipo de nó (jcr:primaryType) deve ser oak:QueryIndexDefinition
• O tipo de índice (type) deve ser lucene
• A propriedade assíncrona (async) deve ser async,nrt
• Use includedPaths e evite a propriedade excludedPaths. Sempre defina o valor queryPaths com o mesmo valor que o valor includedPaths.
• Para impor a restrição de caminho, use a propriedade evaluatePathRestrictions e defina-a como true.
• Use a propriedade tags para marcar o índice e, durante a consulta, especifique esse valor de marcas para usar o índice. A sintaxe de consulta geral é <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"]
...

Gerenciador de Índice disponível em http://host:port/libs/granite/operations/content/diagnosistools/indexManager.html para obter informações de índice, como tipo, última atualização, tamanho.

Registro detalhado de pacotes Java™ relacionados à consulta e indexação do Oak, como org.apache.jackrabbit.oak.plugins.index, org.apache.jackrabbit.oak.query e com.day.cq.search via http://host:port/system/console/slinglog, para solução de problemas.

MBean JMX do tipo IndexStats disponível em http://host:port/system/console/jmx para obter informações de índice, como status, progresso ou estatísticas relacionadas à indexação assíncrona. Também fornece FailingIndexStats, se não houver resultados aqui, significa que nenhum índice está corrompido. AsyncIndexerService marca qualquer índice que não seja atualizado por 30 minutos (configurável) como corrompido e interrompe a indexação. Se uma consulta não estiver fornecendo os resultados esperados, é útil que os desenvolvedores verifiquem isso antes de prosseguir com a reindexação, pois a reindexação é computacionalmente cara e demorada.

MBean JMX do tipo LuceneIndex disponível em http://host:port/system/console/jmx para estatísticas do Índice Lucene, como tamanho, número de documentos por definição de índice.

MBean JMX do tipo QueryStat disponível em http://host:port/system/console/jmx para Estatísticas de consulta do Oak, incluindo consultas lentas e populares com detalhes como consulta, tempo de execução.