Best practice per l’indicizzazione in AEM

Comprendi i requisiti di ricerca e verifica se gli indici OOTB possono supportare i requisiti di ricerca. Utilizza Strumento Prestazioni query, disponibile in SDK locale e AEMCS tramite Developer Console o https://author-pXXXX-eYYYY.adobeaemcloud.com/ui#/aem/libs/granite/operations/content/diagnosistools/queryPerformance.html?appId=aemshell.

Definisci una query ottimale, utilizza il diagramma di flusso dell'ottimizzazione delle query e Scheda di riferimento rapido per le query JCR per riferimento.

Se gli indici OOTB non supportano i requisiti di ricerca, sono disponibili due opzioni. Tuttavia, consulta i suggerimenti per la creazione di indici efficienti

• Personalizza l’indice OOTB: opzione preferita in quanto è facile da mantenere e aggiornare.
• Indice completamente personalizzato: solo se l’opzione precedente non funziona.

In AEMCS, per personalizzare l'indice OOTB, utilizzare la convenzione di denominazione <NomeIndiceOOTBI>-<VersioneProdotto>-custom-<VersionePersonalizzata>. Ad esempio, cqPageLucene-custom-1 o damAssetLucene-8-custom-1. Questo consente di unire la definizione dell’indice personalizzato ogni volta che l’indice OOTB viene aggiornato. Per ulteriori dettagli, vedi Modifiche agli indici predefiniti.

In AEM 6.X, la denominazione indicata sopra non funziona, ma è sufficiente aggiornare l'indice OOTB con le proprietà necessarie nel nodo indexRules.

Copia sempre la definizione più recente dell’indice OOTB dall’istanza di AEM utilizzando Gestione pacchetti di CRX DE (https://experienceleague.adobe.com/crx/packmgr/?lang=it), rinominala e aggiungi personalizzazioni all’interno del file XML.

Archivia la definizione dell'indice nel progetto AEM in ui.apps/src/main/content/jcr_root/_oak_index e distribuiscila con le pipeline CI/CD di Cloud Manager. Per ulteriori dettagli, vedere Distribuzione delle definizioni di indice personalizzato.

Per creare un indice completamente personalizzato, utilizzare <prefisso>.Convenzione di denominazione <customIndexName>-<version>-custom-<customVersion>. Ad esempio, wknd.adventures-1-custom-1. Questo consente di evitare conflitti di denominazione. wknd è il prefisso e adventures è il nome di indice personalizzato. Questa convenzione è applicabile sia per AEM 6.X che per AEMCS e aiuta a preparare la futura migrazione ad AEMCS.

AEMCS supporta solo gli indici Lucene; pertanto, per prepararsi alla futura migrazione ad AEMCS, utilizza sempre gli indici Lucene. Per ulteriori dettagli, vedi Indici Lucene vs Indici proprietà.

Evita di creare un indice personalizzato sullo stesso tipo di nodo dell’indice OOTB. Personalizzare invece l'indice OOTB con le proprietà necessarie nel nodo indexRules. Ad esempio, non creare un indice personalizzato sul tipo di nodo dam:Asset, ma personalizzare l'indice damAssetLucene OOTB. È stata una causa comune di problemi funzionali e di prestazioni.

Evitare inoltre di aggiungere più tipi di nodo, ad esempio cq:Page e cq:Tag, nel nodo delle regole di indicizzazione (indexRules). È invece possibile creare indici separati per ogni tipo di nodo.

Come indicato nella sezione precedente, archivia la definizione dell’indice nel progetto AEM in ui.apps/src/main/content/jcr_root/_oak_index e distribuiscila con le pipeline CI/CD di Cloud Manager. Per ulteriori dettagli, vedere Distribuzione delle definizioni di indice personalizzato.

Le linee guida per la definizione dell’indice sono:

• Il tipo di nodo (jcr:primaryType) deve essere oak:QueryIndexDefinition
• Il tipo di indice (type) deve essere lucene
• La proprietà asincrona (async) deve essere async,nrt
• Usa includedPaths ed evita la proprietà excludedPaths. Imposta sempre il valore queryPaths sullo stesso valore del valore includedPaths.
• Per applicare la restrizione del percorso, utilizzare la proprietà evaluatePathRestrictions e impostarla su true.
• Utilizzare la proprietà tags per assegnare tag all'indice e durante la query specificare il valore dei tag per utilizzare l'indice. La sintassi generale della query è <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"]
...

Gestione indici disponibile in http://host:port/libs/granite/operations/content/diagnosistools/indexManager.html per ottenere informazioni sull'indice come tipo, ultimo aggiornamento, dimensione.

Registrazione dettagliata della query Oak e dei pacchetti Java™ correlati all'indicizzazione come org.apache.jackrabbit.oak.plugins.index, org.apache.jackrabbit.oak.query e com.day.cq.search tramite http://host:port/system/console/slinglog per la risoluzione dei problemi.

MBean JMX di tipo IndexStats disponibile in http://host:port/system/console/jmx per ottenere informazioni sull'indice come stato, avanzamento o statistiche relative all'indicizzazione asincrona. Fornisce anche FailingIndexStats. Se non sono presenti risultati, significa che nessun indice è danneggiato. AsyncIndexerService contrassegna qualsiasi indice che non viene aggiornato per 30 minuti (configurabile) come danneggiato e interrompe l’indicizzazione. Se una query non fornisce i risultati previsti, è utile che gli sviluppatori la verifichino prima di procedere con la reindicizzazione, in quanto è computazionalmente costosa e richiede tempo.

MBean JMX di tipo LuceneIndex disponibile alle http://host:port/system/console/jmx per le statistiche dell'indice Lucene come dimensione, numero di documenti per definizione dell'indice.

MBean JMX di tipo QueryStat disponibile in http://host:port/system/console/jmx per le statistiche delle query di Oak, incluse query lente e popolari con dettagli quali query e tempo di esecuzione.