Query e indicizzazione Oak

Introduzione

A differenza di Jackrabbit 2, Oak non indicizza il contenuto per impostazione predefinita. Gli indici personalizzati devono essere creati quando necessario, proprio come con i database relazionali tradizionali. Se non è presente un indice per una query specifica, è possibile che molti nodi vengano attraversati. La query può ancora funzionare ma probabilmente è molto lenta.

Se Oak incontra una query senza un indice, viene stampato un messaggio di log a livello WARN:

*WARN* Traversed 1000 nodes with filter Filter(query=select ...) consider creating an index or changing the query

Lingue di query supportate

Il motore di query Oak supporta le seguenti lingue:

• XPath (consigliato)
• SQL-2
• SQL (obsoleto)
• JQOM

Tipi di indicizzatore e calcolo dei costi

Il backend basato su Apache Oak consente di collegare diversi indicizzatori nell’archivio.

Un indicizzatore è l' Indice proprietà, per il quale la definizione dell'indice è memorizzata nell'archivio stesso.

Per impostazione predefinita sono disponibili anche le implementazioni per Apache Lucene e Solr , che supportano entrambe l’indicizzazione full-text.

Se non è disponibile nessun altro indicizzatore, viene utilizzato Indice trasversale . Ciò significa che il contenuto non è indicizzato e che i nodi di contenuto vengono attraversati per trovare corrispondenze alla query.

Se per una query sono disponibili più indicizzatori, ogni indicizzatore disponibile stima il costo di esecuzione della query. Oak sceglie quindi l'indicizzatore con il costo stimato più basso.

Il diagramma di cui sopra è una rappresentazione di alto livello del meccanismo di esecuzione delle query di Apache Oak.

Innanzitutto, la query viene analizzata in un albero di sintassi astratto. Quindi, la query viene controllata e trasformata in SQL-2 che è la lingua nativa per le query Oak.

Successivamente, ogni indice viene consultato per stimare il costo della query. Una volta completato, vengono recuperati i risultati dell'indice più economico. Infine, i risultati vengono filtrati, sia per garantire che l’utente corrente abbia accesso in lettura al risultato che il risultato corrisponda alla query completa.

Configurazione degli indici

Se la reindicizzazione è necessaria in archivi molto grandi, specialmente quando si utilizza MongoDB e per indici full-text, considera la preestrazione del testo e utilizza oak-run per generare l'indice iniziale e reindicizzarlo.

Gli indici sono configurati come nodi nel repository sotto il nodo oak:index .

Il tipo del nodo di indice deve essere oak:QueryIndexDefinition. Sono disponibili diverse opzioni di configurazione per ogni indicizzatore come proprietà del nodo. Per ulteriori informazioni, consulta i dettagli di configurazione per ogni tipo di indicizzatore qui sotto.

Indice proprietà

L'indice delle proprietà è generalmente utile per le query con vincoli di proprietà ma non con testo completo. Può essere configurato seguendo la procedura seguente:

1. Apri CRXDE andando su http://localhost:4502/crx/de/index.jsp

2. Crea un nuovo nodo sotto oak:index

3. Denomina il nodo PropertyIndex e imposta il tipo di nodo su oak:QueryIndexDefinition

4. Imposta le seguenti proprietà per il nuovo nodo:

   • type: property (di tipo String)
   • propertyNames: jcr:uuid (di tipo Name)

   In questo esempio specifico viene indicizzata la proprietà jcr:uuid , il cui lavoro consiste nell'esporre l'identificatore univoco universale (UUID) del nodo a cui è associato.

5. Salva le modifiche.

L'indice delle proprietà dispone delle seguenti opzioni di configurazione:

• La proprietà type specifica il tipo di indice e in questo caso deve essere impostata su property

• La proprietà propertyNames indica l'elenco delle proprietà che verranno memorizzate nell'indice. Se manca, il nome del nodo verrà utilizzato come valore di riferimento del nome della proprietà. In questo esempio, viene aggiunta all'indice la proprietà jcr:uuid il cui lavoro consiste nell'esporre l'identificatore univoco (UUID) del proprio nodo.

• Il flag univoco che, se impostato su true aggiunge un vincolo di univocità all'indice della proprietà.

• La proprietà declaringNodeTypes consente di specificare un determinato tipo di nodo a cui l'indice si applica solo.

• Il flag reindex che, se impostato su true, attiverà una reindicizzazione completa del contenuto.

Indice ordinato

L'indice ordinato è un'estensione dell'indice Property. Tuttavia, è stato dichiarato obsoleto. Gli indici di questo tipo devono essere sostituiti con Indice proprietà Lucene.

Indice di testo completo Lucene

Un indicizzatore full text basato su Apache Lucene è disponibile in AEM 6.

Se è configurato un indice full-text, tutte le query con una condizione full-text utilizzano l'indice full-text, indipendentemente dal fatto che vi siano altre condizioni indicizzate e indipendentemente da eventuali restrizioni del percorso.

Se non è configurato alcun indice full-text, le query con condizioni full-text non funzioneranno come previsto.

Poiché l’indice viene aggiornato tramite un thread in background asincrono, alcune ricerche full-text non saranno disponibili per una piccola finestra di tempo fino al completamento dei processi in background.

Puoi configurare un indice full-text Lucene seguendo la procedura seguente:

1. Apri CRXDE e crea un nuovo nodo sotto oak:index.

2. Denomina il nodo LuceneIndex e imposta il tipo di nodo su oak:QueryIndexDefinition

3. Aggiungi le seguenti proprietà al nodo :

   • type: lucene (di tipo String)
   • async: async (di tipo String)

4. Salva le modifiche.

L'indice Lucene dispone delle seguenti opzioni di configurazione:

• La proprietà type che specificherà il tipo di indice deve essere impostata su lucene
• La proprietà async che deve essere impostata su async. Questo invierà il processo di aggiornamento dell'indice a un thread in background.
• La proprietà includePropertyTypes, che definirà quale sottoinsieme di tipi di proprietà verrà incluso nell'indice.
• La proprietà excludePropertyNames che definirà un elenco di nomi di proprietà - proprietà che devono essere escluse dall'indice.
• Il flag reindex che, se impostato su true, attiva un reindice completo del contenuto.

Indice delle proprietà Lucene

A partire da Oak 1.0.8, Lucene può essere utilizzato per creare indici che coinvolgono vincoli di proprietà che non sono full-text.

Per ottenere un indice delle proprietà Lucene, la proprietà fulltextEnabled deve sempre essere impostata su false.

Prendi la seguente query di esempio:

select * from [nt:base] where [alias] = '/admin'

Per definire un indice delle proprietà Lucene per la query precedente, puoi aggiungere la seguente definizione creando un nuovo nodo sotto oak:index:

• Nome: LucenePropertyIndex
• Tipo: oak:QueryIndexDefinition

Una volta creato il nodo, aggiungi le seguenti proprietà:

• tipo:

  lucene (of type String)
  

• asincrono:

  async (of type String)
  

• fulltextEnabled:

  false (of type Boolean)
  

• includePropertyNames: ["alias"] (of type String)

Analisi Lucene

A partire dalla versione 1.2.0, Oak supporta gli analizzatori Lucene.

Gli analisti vengono utilizzati sia quando un documento è indicizzato sia in fase di query. Un analizzatore esamina il testo dei campi e genera un flusso di token. Gli analizzatori Lucene sono composti da una serie di classi di tokenizer e filtri.

Gli analizzatori possono essere configurati tramite il nodo analyzers (di tipo nt:unstructured) all'interno della definizione oak:index.

L'analizzatore predefinito per un indice è configurato nel default secondario del nodo analizzatore.

Specifica della classe dell'analizzatore direttamente

Se desideri utilizzare un analizzatore preconfigurato, puoi configurarlo seguendo la procedura seguente:

1. Individua l'indice con cui desideri utilizzare l'analizzatore sotto il nodo oak:index.

2. Sotto l'indice, crea un nodo figlio denominato default di tipo nt:unstructured.

3. Aggiungi una proprietà al nodo predefinito con le seguenti proprietà:

   • Nome: class
   • Tipo: String
   • Valore: org.apache.lucene.analysis.standard.StandardAnalyzer

   Il valore è il nome della classe analizzatore che si desidera utilizzare.

   È inoltre possibile impostare l'analizzatore da utilizzare con una versione lucene specifica utilizzando la proprietà della stringa opzionale luceneMatchVersion . Una sintassi valida per utilizzarla con Lucene 4.7 sarebbe:

   • Nome: luceneMatchVersion
   • Tipo: String
   • Valore: LUCENE_47

   Se luceneMatchVersion non viene fornito, Oak utilizzerà la versione di Lucene con cui viene spedito.

4. Se desideri aggiungere un file stopwords alle configurazioni dell'analizzatore, puoi creare un nuovo nodo sotto default con le seguenti proprietà:

   • Nome: stopwords
   • Tipo: nt:file

Creazione di analisi tramite Composizione

Gli analisti possono anche essere composti in base a Tokenizers, TokenFilters e CharFilters. A tale scopo, puoi specificare un analizzatore e creare nodi figlio dei relativi token e filtri facoltativi che verranno applicati nell’ordine elencato. Vedere anche https://wiki.apache.org/solr/AnalyzersTokenizersTokenFilters#Specifying_an_Analyzer_in_the_schema

Considera questa struttura del nodo come esempio:

• Nome: analyzers

  • Nome: default

    • Nome: charFilters

    • Tipo: nt:unstructured

      • Nome: HTMLStrip
      • Nome: Mapping

    • Nome: tokenizer

      • Nome proprietà: name

        • Tipo: String
        • Valore: Standard

    • Nome: filters

    • Tipo: nt:unstructured

      • Nome: LowerCase

      • Nome: Stop

        • Nome proprietà: words

          • Tipo: String
          • Valore: stop1.txt, stop2.txt

        • Nome: stop1.txt

          • Tipo: nt:file

        • Nome: stop2.txt

          • Tipo: nt:file

Il nome dei filtri, charFilters e token viene creato rimuovendo i suffissi di fabbrica. Pertanto:

• org.apache.lucene.analysis.standard.StandardTokenizerFactory diventa standard

• org.apache.lucene.analysis.charfilter.MappingCharFilterFactory diventa Mapping

• org.apache.lucene.analysis.core.StopFilterFactory diventa Stop

Qualsiasi parametro di configurazione richiesto per la fabbrica è specificato come proprietà di questo codice.

Per casi come il caricamento di parole di arresto in cui è necessario caricare il contenuto da file esterni, il contenuto può essere fornito creando un nodo figlio di tipo nt:file per il file in questione.

Indice solare

Lo scopo dell'indice Solr è principalmente ricerca full-text ma può anche essere utilizzato per indicizzare la ricerca per percorso, restrizioni di proprietà e restrizioni di tipo primario. Questo significa che l'indice Solr in Oak può essere utilizzato per qualsiasi tipo di query JCR.

L’integrazione in AEM avviene a livello di archivio in modo che Solr sia uno dei possibili indici che possono essere utilizzati in Oak, la nuova implementazione dell’archivio fornita con AEM.

Può essere configurato per funzionare come server incorporato con l'istanza AEM o come server remoto.

Configurazione di AEM con un server Solr incorporato

AEM può essere utilizzato con un server Solr incorporato che può essere configurato tramite la console Web. In questo caso, il server Solr verrà eseguito nella stessa JVM dell'istanza AEM a cui è incorporato.

Puoi configurare il server Solr incorporato nei seguenti modi:

1. Andando alla console Web all'indirizzo https://serveraddress:4502/system/console/configMgr

2. Cerca "Oak Solr server provider".

3. Premere il pulsante di modifica e nella finestra seguente impostare il tipo di server su Embedded Solr nell'elenco a discesa.

4. Quindi, modifica "Oak Solr embedded server configuration" e crea una configurazione. Per ulteriori informazioni sulle opzioni di configurazione, visita il sito web Apache Solr.

   NOTA

   La configurazione della directory principale Solr (solr.home.path) cercherà una cartella con lo stesso nome nella cartella di installazione AEM.

5. Apri CRXDE e accedi come amministratore.

6. Aggiungi un nodo chiamato solrlndex di tipo oak:QueryIndexDefinition in oak:index con le seguenti proprietà:

   • type: solr (di tipo String)
   • async: async (di tipo String)
   • reindicizzazione: true (di tipo booleano)

7. Salva le modifiche.

Configurazione di AEM con un singolo server Solr remoto

AEM può anche essere configurato per lavorare con un'istanza remota del server Solr:

1. Scarica ed estrai la versione più recente di Solr. Per ulteriori informazioni su come eseguire questa operazione, consulta la documentazione di installazione di Apache Solr.

2. Ora, crea due truffe Solr. Per farlo, crea cartelle per ogni frammento nella cartella in cui Solr è stato sovrapposto:

   • Per la prima condivisione, crea la cartella:

   <solrunpackdirectory>\aemsolr1\node1

   • Per la seconda parte, crea la cartella:

   <solrunpackdirectory>\aemsolr2\node2

3. Individua l'istanza di esempio nel pacchetto Solr. In genere si trova in una cartella denominata " example" nella directory principale del pacchetto.

4. Copia le seguenti cartelle dall'istanza di esempio nelle due cartelle condivise ( aemsolr1\node1 e aemsolr2\node2):

   • contexts
   • etc
   • lib
   • resources
   • scripts
   • solr-webapp
   • webapps
   • start.jar

5. Crea una nuova cartella denominata " cfg" in ciascuna delle due cartelle condivise.

6. Posiziona i file di configurazione Solr e Zookeeper nelle cartelle cfg appena create.

   NOTA

   Per ulteriori informazioni sulla configurazione Solr e ZooKeeper, consulta la documentazione sulla configurazione Solr e la Guida introduttiva ZooKeeper.

7. Avvia la prima condivisione con il supporto di ZooKeeper andando su aemsolr1\node1 ed eseguendo il seguente comando:

   java -Xmx2g -Dbootstrap_confdir=./cfg/oak/conf -Dcollection.configName=myconf -DzkRun -DnumShards=2 -jar start.jar
   

8. Avvia la seconda parte andando su aemsolr2\node2 ed eseguendo il seguente comando:

   java -Xmx2g -Djetty.port=7574 -DzkHost=localhost:9983 -jar start.jar
   

9. Dopo aver avviato entrambe le condivisioni, verifica che tutto sia pronto e funzionante connettendosi all'interfaccia Solr in http://localhost:8983/solr/#/

10. Avvia AEM e passa alla console Web all'indirizzo http://localhost:4502/system/console/configMgr

11. Imposta la seguente configurazione in Configurazione del server remoto Oak Solr:

    • URL HTTP solr: http://localhost:8983/solr/

12. Scegliere Solr remoto nell'elenco a discesa in Oak Solr provider di server.

13. Vai a CRXDE e accedi come amministratore.

14. Crea un nuovo nodo chiamato solrIndex in oak:index e imposta le seguenti proprietà:

    • type: solr (di tipo String)
    • async: async (di tipo String)
    • reindex: true (di tipo booleano)

15. Salva le modifiche.

Configurazione consigliata per Solr

Di seguito è riportato un esempio di configurazione di base che può essere utilizzata con tutte e tre le distribuzioni Solr descritte in questo articolo. Consentono di gestire gli indici di proprietà dedicati già presenti in AEM e non devono essere utilizzati con altre applicazioni.

Per utilizzarlo correttamente, è necessario inserire il contenuto dell'archivio direttamente nella directory principale Solr. Nel caso di implementazioni con più nodi, deve trovarsi direttamente nella cartella principale di ciascun nodo.

File di configurazione Solr consigliati

Ottieni file

Strumenti di indicizzazione AEM

AEM 6.1 integra anche due strumenti di indicizzazione presenti in AEM 6.0 come parte degli strumenti di Adobe Consulting Services Commons:

1. Spiega query, uno strumento progettato per aiutare gli amministratori a comprendere come vengono eseguite le query;
2. Oak Index Manager, un'interfaccia utente web per la manutenzione degli indici esistenti.

È ora possibile raggiungerli andando in Strumenti - Operazioni - Dashboard - Diagnosi dalla schermata di benvenuto AEM.

Per ulteriori informazioni su come utilizzarli, consulta la documentazione del dashboard delle operazioni.

Creazione di indici di proprietà tramite OSGi

Il pacchetto ACS Commons espone anche le configurazioni OSGi che possono essere utilizzate per creare indici di proprietà.

Puoi accedervi dalla console Web cercando "Assicurati che Oak Property Index".

Risoluzione dei problemi di indicizzazione

Potrebbero verificarsi situazioni in cui l’esecuzione delle query richiede molto tempo e il tempo di risposta generale del sistema è lento.

Questa sezione presenta una serie di raccomandazioni su ciò che è necessario fare per individuare la causa di tali problemi e consigli su come risolverli.

Preparazione delle informazioni di debug per l’analisi

Il modo più semplice per ottenere le informazioni richieste per la query eseguita è tramite lo strumento di query di spiegazione. Questo ti consente di raccogliere le informazioni precise necessarie per eseguire il debug di una query lenta senza la necessità di consultare le informazioni sul livello di log. Questa opzione è utile se si conosce la query di cui si sta eseguendo il debug.

Se questo non è possibile per alcun motivo, è possibile raccogliere i registri di indicizzazione in un singolo file e usarlo per risolvere il problema specifico.

Abilita registrazione

Per abilitare la registrazione, devi abilitare i registri a livello di DEBUG per le categorie relative all'indicizzazione e alle query Oak. Queste categorie sono:

• org.apache.jackrabbit.oak.plugins.index
• org.apache.jackrabbit.oak.query
• com.day.cq.search

La categoria com.day.cq.search è applicabile solo se si utilizza l'utility QueryBuilder AEM fornita.

È possibile abilitare la registrazione seguendo questa procedura:

1. Posiziona il browser su https://serveraddress:port/system/console/slinglog
2. Fai clic sul pulsante Aggiungi nuovo logger nella parte inferiore della console.
3. Nella riga appena creata, aggiungi le categorie sopra menzionate. Puoi usare il segno + per aggiungere più di una categoria a un singolo logger.
4. Scegli DEBUG dall'elenco a discesa Livello di log.
5. Imposta il file di output su logs/queryDebug.log. In questo modo tutti gli eventi DEBUG verranno correlati in un unico file di registro.
6. Esegui la query o esegui il rendering della pagina che utilizza la query di cui desideri eseguire il debug.
7. Dopo aver eseguito la query, torna alla console di registrazione e modifica il livello di registro del logger appena creato in INFO.

Configurazione indice

Il modo in cui la query viene valutata è in gran parte influenzato dalla configurazione dell'indice. È importante ottenere la configurazione dell'indice per essere analizzata o inviata al supporto. Puoi ottenere la configurazione come pacchetto di contenuti o una rappresentazione JSON.

Poiché nella maggior parte dei casi, la configurazione di indicizzazione è memorizzata sotto il nodo /oak:index in CRXDE, puoi ottenere la versione JSON in:

https://serveraddress:port/oak:index.tidy.-1.json

Se l'indice è configurato in una posizione diversa, cambia di conseguenza il percorso.

Uscita MBean

In alcuni casi è utile fornire l'output di MBeans relativi all'indice per il debug. Puoi eseguire questa operazione:

1. Andando alla console JMX in:
   https://serveraddress:port/system/console/jmx

2. Cerca i seguenti MBeans:

   • Statistiche dell'indice di Lucene
   • Statistiche di supporto di CopyOnRead
   • Statistiche query Oak
   • IndexStats

3. Fai clic su ciascuno dei MBeans per ottenere le statistiche sulle prestazioni. Crea uno screenshot o annotiamoli nel caso in cui sia necessario inviarli al supporto.

Puoi anche ottenere la variante JSON di queste statistiche ai seguenti URL:

• https://serveraddress:port/system/sling/monitoring/mbeans/org/apache/jackrabbit/oak/%2522LuceneIndex%2522.tidy.-1.json
• https://serveraddress:port/system/sling/monitoring/mbeans/org/apache/jackrabbit/oak/%2522LuceneIndex%2522.tidy.-1.json
• https://serveraddress:port/system/sling/monitoring/mbeans/org/apache/jackrabbit/oak/%2522LuceneIndex%2522.tidy.-1.json
• https://serveraddress:port/system/sling/monitoring/mbeans/org/apache/jackrabbit/oak/%2522LuceneIndex%2522.tidy.-1.json

Puoi anche fornire un output JMX consolidato tramite https://serveraddress:port/system/sling/monitoring/mbeans/org/apache/jackrabbit/oak.tidy.3.json. Questo includerebbe tutti i dettagli MBean relativi a Oak nel formato JSON.

Altri dettagli

Puoi raccogliere ulteriori dettagli per aiutarti a risolvere il problema, ad esempio:

1. Versione Oak su cui l'istanza è in esecuzione. Per visualizzarlo, apri CRXDE e osserva la versione nell’angolo in basso a destra della pagina di benvenuto, oppure controlla la versione del bundle org.apache.jackrabbit.oak-core.
2. L'output del debugger di QueryBuilder della query del problema. È possibile accedere al debugger all'indirizzo: https://serveraddress:port/libs/cq/search/content/querydebug.html