Fråga och indexering

Senaste uppdatering: 2023-11-07
OBSERVERA

Den här artikeln handlar om att konfigurera index i AEM 6. De bästa sätten att optimera fråga- och indexeringsprestanda finns i Metodtips för frågor och indexering.

Introduktion

Till skillnad från Jackrabbit 2 indexerar inte Oak innehållet som standard. Anpassade index måste skapas när det behövs, ungefär som med traditionella relationsdatabaser. Om det inte finns något index för en viss fråga kan många noder gå igenom. Frågan kanske fortfarande fungerar, men den är förmodligen långsam.

Om Oak stöter på en fråga utan index skrivs ett loggmeddelande på WARN-nivå ut:

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

Frågespråk som stöds

Oak-frågemotorn stöder följande språk:

  • XPath (rekommenderas)
  • SQL-2
  • SQL (utgått)
  • JQOM

Indexerartyper och kostnadsberäkning

Med Apache Oak-baserad backend kan olika indexerare kopplas in i databasen.

En indexerare är Egenskapsindex som indexdefinitionen lagras i själva databasen.

Implementeringar för Apache Lucene och Solr är också tillgängliga som standard, som båda stöder fulltextindexering.

The Traversal Index används om ingen annan indexerare är tillgänglig. Det innebär att innehållet inte är indexerat och att innehållsnoderna gås igenom för att hitta matchningar med frågan.

Om det finns flera tillgängliga indexerare för en fråga beräknar varje tillgänglig indexerare kostnaden för att köra frågan. Därefter väljer Oak indexeraren med den lägsta uppskattade kostnaden.

chlimage_1-148

Diagrammet ovan är en högnivårepresentation av frågekörningsmekanismen i Apache Oak.

Först tolkas frågan i ett abstrakt syntaxträd. Sedan kontrolleras frågan och omvandlas till SQL-2, som är det ursprungliga språket för Oak-frågor.

Därefter används varje index för att beräkna kostnaden för frågan. När det är klart hämtas resultaten från det lägsta indexvärdet. Slutligen filtreras resultaten, både för att säkerställa att den aktuella användaren har läsåtkomst till resultatet och att resultatet matchar hela frågan.

Konfigurera index

OBSERVERA

För en stor databas är det tidskrävande att skapa ett index. Detta gäller både när ett index skapas första gången och när ett index indexeras om (när definitionen ändrats). Se även Felsökning av aktivitetsindex och Förhindra långsam omindexering.

Om omindexering behövs i stora databaser, särskilt när du använder MongoDB och fulltextindex, bör du överväga att extrahera text och använda eko-run för att skapa det ursprungliga indexet och indexera om.

Index konfigureras som noder i databasen under Oak:index nod.

Indexnodens typ måste vara oak:QueryIndexDefinition. Det finns flera konfigurationsalternativ tillgängliga för varje indexerare som nodegenskaper. Mer information finns i konfigurationsinformationen för varje indexerartyp nedan.

Egenskapsindexet

Egenskapsindexet är användbart för frågor som har egenskapsbegränsningar men inte är fulltextfrågor. Den kan konfigureras genom att följa proceduren nedan:

  1. Öppna CRXDE genom att http://localhost:4502/crx/de/index.jsp

  2. Skapa en nod under oak:index

  3. Namnge noden PropertyIndex och ange nodtypen till oak:QueryIndexDefinition

  4. Ange följande egenskaper för den nya noden:

    • typ: property (av typen String)
    • propertyNames: jcr:uuid (av typen Namn)

    Det här exemplet indexerar jcr:uuid egenskapen, vars jobb är att visa den universellt unika identifieraren (UUID) för noden som den är kopplad till.

  5. Spara ändringarna.

Egenskapsindexet har följande konfigurationsalternativ:

  • The type egenskapen anger typen av index, och i det här fallet måste den anges till property

  • The propertyNames anger listan med egenskaper som lagras i indexet. Om det saknas används nodnamnet som referensvärde för egenskapsnamnet. I det här exemplet jcr:uuid egenskapen vars jobb är att visa den unika identifieraren (UUID) för noden läggs till i indexet.

  • The unik flagga som, om den är inställd på true lägger till en unikhetsbegränsning i egenskapsindexet.

  • The declareNodeTypes kan du ange en viss nodtyp som indexet bara gäller för.

  • The reindex flagga som true, utlöser en omindexering av fullständigt innehåll.

Orderat index

Det sorterade indexet är ett tillägg till egenskapsindexet. Den har dock tagits bort. Index av den här typen måste ersättas med Lucene-egenskapsindex.

Fullständigt Lucene-textindex

En fulltextindexerare baserad på Apache Lucene finns i AEM 6.

Om ett fulltextindex är konfigurerat kommer alla frågor som har ett fulltextvillkor att använda fulltextindexet, oavsett om det finns andra villkor som är indexerade eller oavsett om det finns en sökvägsbegränsning.

Om inget fulltextindex är konfigurerat fungerar inte frågor med fulltextvillkor som förväntat.

Eftersom indexet uppdateras med hjälp av en asynkron bakgrundstråd är vissa textsökningar inte tillgängliga för ett litet tidsfönster förrän bakgrundsprocesserna har slutförts.

Du kan konfigurera ett fulltextindex för Lucene enligt följande procedur:

  1. Öppna CRXDE och skapa en nod under oak:index.

  2. Namnge noden LuceneIndex och ange nodtypen till oak:QueryIndexDefinition

  3. Lägg till följande egenskaper i noden:

    • typ: lucene (av typen String)
    • asynk: async (av typen String)
  4. Spara ändringarna.

Lucene-indexet har följande konfigurationsalternativ:

  • The type egenskap som anger typen av index måste anges till lucen
  • The async egenskap som måste anges till async. Detta skickar indexuppdateringsprocessen till en bakgrundstråd.
  • The includePropertyTypes som definierar vilken deluppsättning av egenskapstyper som ingår i indexet.
  • The excludePropertyNames som definierar en lista med egenskapsnamn - egenskaper som ska uteslutas från indexet.
  • The reindex flagga som true, utlöser en omindexering av fullständigt innehåll.

Dokumentationen i det här avsnittet gäller till exempel Apache Lucene, Elasticsearch och fulltextindex för PostgreSQL, SQLite och MySQL. Följande exempel är för AEM / Oak / Lucene.

Data som ska indexeras

Startpunkten är de data som måste indexeras. Ta följande dokument som exempel:

Dokument-ID Bana Fulltext
100 /content/rubik "Rubik är ett finskt varumärke."
200 /content/rubiksCube "Rubiks kub uppfanns 1974."
300 /content/cube "En kub är ett tredimensionellt objekt."

Inverterat index

Indexeringsfunktionen delar upp fulltexten i ord som kallas "tokens" och skapar ett index som kallas "inverterat index". Indexet innehåller en lista med dokument där det finns för varje ord.

Korta, vanliga ord (kallas även"stopwords") indexeras inte. Alla variabler konverteras till gemener och ordstam används.

Specialtecken som "-" är inte indexerade.

Token Dokument-ID
194 …, 200,…
varumärke …, 100,…
kub …, 200, 300,…
dimension 300
avsluta …, 100,…
uppfinna 200
object …, 300,…
rubik …, 100, 200,…

Listan med dokument sorteras. Det här är praktiskt när du frågar.

Söker

Nedan visas ett exempel på en fråga. Observera att alla specialtecken (som ') ersattes med ett blanksteg:

/jcr:root/content//element(\*; cq:Page)`[` jcr:contains('Rubik s Cube')`]`

Orden tokeniseras och filtreras på samma sätt som vid indexering (enstaka teckenord tas till exempel bort). Så i det här fallet är sökningen för:

+:fulltext:rubik +:fulltext:cube

Indexet läser listan med dokument för dessa ord. Om det finns många dokument kan listan vara stor. Anta att de innehåller följande:

Token Dokument-ID
rubik 10, 100, 200, 1000
kub 30, 200, 300, 2000

Lucene vänds fram och tillbaka mellan de två listorna (eller rund-robin) n listor, vid sökning efter n ord):

  • Läs in"rubik" hämtar den första posten: hittar 10
  • Läs i "cube" hämtar den första posten > = 10. 10 hittas inte och nästa är 30.
  • Läs in "rubik" som hämtar den första posten > = 30: 100 hittas.
  • Läs i "cube" hämtar den första posten > = 100: 200 hittas.
  • Läs in "rubik" som hämtar den första posten > = 200. 200 hittades. Så dokument 200 är en matchning för båda villkoren. Det här kommer ihåg.
  • Läs in "rubik" hämtar nästa post: 1000.
  • Läs i "cube" hämtar den första posten > = 1000: 2000 hittas.
  • Läs in "rubik" som hämtar den första posten > = 2000: slut på listan.
  • Slutligen kan du sluta söka.

Det enda dokument som innehåller båda villkoren är 200, som i exemplet nedan:

200 /content/rubiksCube "Rubiks kub uppfanns 1974."

När flera poster hittas sorteras de sedan efter poäng.

Egenskapsindexet Lucene

Sedan ek 1.0.8, kan Lucene användas för att skapa index som innehåller egenskapsbegränsningar som inte är fulltext.

För att uppnå ett Lucene-egenskapsindex fulltextEnabled -egenskapen måste alltid anges till false.

Ta följande exempelfråga:

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

Om du vill definiera ett Lucene-egenskapsindex för frågan ovan kan du lägga till följande definition genom att skapa en nod under oak:index:

  • Namn: LucenePropertyIndex
  • Typ: oak:QueryIndexDefinition

När noden har skapats lägger du till följande egenskaper:

  • typ:

    lucene (of type String)
    
  • asynk:

    async (of type String)
    
  • fulltextEnabled:

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

OBSERVERA

Jämfört med det vanliga egenskapsindexet är Lucene-egenskapsindexet alltid konfigurerat i asynkront läge. Resultatet som returneras av indexet kanske därför inte alltid återspeglar databasens senaste status.

OBSERVERA

Mer information om egenskapsindexet Lucene finns i Dokumentationssida för Apache Jackrabbit Oak Lucene.

Lucene Analyzers

Sedan version 1.2.0 stöder Oak Lucene-analysatorer.

Analysatorer används både när ett dokument indexeras och vid frågetillfället. En analyserare undersöker texten i fälten och genererar en tokenström. Lucene-analysatorerna består av en serie tokeniserings- och filterklasser.

Analysatorerna kan konfigureras med analyzers nod (av typ nt:unstructured) i oak:index definition.

Standardanalysatorn för ett index är konfigurerad i default underordnad till analysatornoden.

chlimage_1-149

OBSERVERA

En lista över tillgängliga analysatorer finns i API-dokumentationen för Lucene-versionen som du använder.

Ange klassen Analyzer direkt

Om du vill använda någon av de färdiga analysverktygen kan du konfigurera den enligt följande procedur:

  1. Leta reda på indexet som du vill använda analysverktyget med under oak:index nod.

  2. Skapa en underordnad nod under indexet med namnet default av typen nt:unstructured.

  3. Lägg till en egenskap i standardnoden med följande egenskaper:

    • Namn: class
    • Typ: String
    • Värde: org.apache.lucene.analysis.standard.StandardAnalyzer

    Värdet är namnet på den analysklass som du vill använda.

    Du kan också ange att analysatorn ska användas med en specifik lucene-version genom att använda det valfria luceneMatchVersion string-egenskap. En giltig syntax för användning med Lucene 4.7 är:

    • Namn: luceneMatchVersion
    • Typ: String
    • Värde: LUCENE_47

    If luceneMatchVersion inte tillhandahålls, använder Oak den version av Lucene som det levereras med.

  4. Om du vill lägga till en stoppordsfil i analyskonfigurationerna kan du skapa en nod under default en med följande egenskaper:

    • Namn: stopwords
    • Typ: nt:file

Skapa analysatorer med hjälp av komposition

Analysprogram kan också sammanställas baserat på Tokenizers, TokenFiltersoch CharFilters. Du kan göra detta genom att ange en analysator och skapa underordnade noder till dess tillvalstokeniserare och filter som tillämpas i listordning. Se även https://cwiki.apache.org/confluence/display/solr/AnalyzersTokenizersTokenFilters#Specifying_an_Analyzer_in_the_schema

Se den här nodstrukturen som ett exempel:

  • Namn: analyzers

    • Namn: default

      • Namn: charFilters

      • Typ: nt:unstructured

        • Namn: HTMLStrip
        • Namn: Mapping
      • Namn: tokenizer

        • Egenskapsnamn: name

          • Typ: String
          • Värde: Standard
      • Namn: filters

      • Typ: nt:unstructured

        • Namn: LowerCase

        • Namn: Stop

          • Egenskapsnamn: words

            • Typ: String
            • Värde: stop1.txt, stop2.txt
          • Namn: stop1.txt

            • Typ: nt:file
          • Namn: stop2.txt

            • Typ: nt:file

Namnet på filtren, charFilters och tokenizers formas genom att fabrikssuffixen tas bort. Således

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

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

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

Alla konfigurationsparametrar som krävs för fabriken anges som egenskapen för noden i fråga.

I fall där t.ex. inläsning av stoppord där innehåll från externa filer måste läsas in, kan innehållet tillhandahållas genom att skapa en underordnad nod till nt:file filtyp.

Solr-index

Syftet med Solr-indexet är fulltextsökning, men det kan också användas för indexsökning efter sökväg, egenskapsbegränsningar och primära typbegränsningar. Det innebär att Solr-indexet i Oak kan användas för alla typer av JCR-frågor.

Integrationen i AEM sker på databasnivå så att Solr är ett av de möjliga index som kan användas i Oak, den nya databasimplementeringen som levererades med AEM.

Den kan konfigureras för att fungera som en fjärrserver med AEM.

Konfigurera AEM med en enda fjärr-Solr-server

AEM kan även konfigureras för att fungera med en fjärrserver för Solr:

  1. Hämta och extrahera den senaste versionen av Solr. Mer information om hur du gör detta finns i Installationsdokumentation för Apache Solr.

  2. Skapa nu två Solr-kort. Du kan göra detta genom att skapa mappar för varje delning i mappen där Solr har packats upp:

    • Skapa mappen för det första delfönstret:

    <solrunpackdirectory>\aemsolr1\node1

    • Skapa mappen för den andra delningen:

    <solrunpackdirectory>\aemsolr2\node2

  3. Leta reda på exempelinstansen i Solr-paketet. Den finns i en mapp som heter example" i paketets rot.

  4. Kopiera följande mappar från exempelinstansen till de två delade mapparna ( aemsolr1\node1 och aemsolr2\node2):

    • contexts
    • etc
    • lib
    • resources
    • scripts
    • solr-webapp
    • webapps
    • start.jar
  5. Skapa en mapp med namnet " cfg" i var och en av de två delade mapparna.

  6. Placera Solr- och Zookeeper-konfigurationsfilerna i den nya cfg mappar.

    OBSERVERA

    Mer information om Solr- och ZooKeeper-konfigurationen finns i Dokumentation för SolrConfiguration och Starthandbok för ZooKeeper.

  7. Starta den första delningen med stöd för ZooKeeper genom att gå till aemsolr1\node1 och köra följande kommando:

    java -Xmx2g -Dbootstrap_confdir=./cfg/oak/conf -Dcollection.configName=myconf -DzkRun -DnumShards=2 -jar start.jar
    
  8. Starta den andra delningen genom att gå till aemsolr2\node2 och köra följande kommando:

    java -Xmx2g -Djetty.port=7574 -DzkHost=localhost:9983 -jar start.jar
    
  9. När båda delarna har startats testar du att allt är igång genom att ansluta till Solr-gränssnittet på http://localhost:8983/solr/#/

  10. Starta AEM och gå till webbkonsolen på http://localhost:4502/system/console/configMgr

  11. Ange följande konfiguration under Konfiguration av Oak Solr-fjärrserver:

    • HTTP-URL för Solr: http://localhost:8983/solr/
  12. Välj Fjärrverktyg i listrutan under Oak Solr serverprovider.

  13. Gå till CRXDE och logga in som administratör.

  14. Skapa en nod med namnet solrIndex under oak:index och ange följande egenskaper:

    • typ: solr (av typen String)
    • asynk: async (av typen String)
    • omindexera: true (av typen Boolean)
  15. Spara ändringarna.

Nedan visas ett exempel på en baskonfiguration som kan användas med alla tre Solr-distributioner som beskrivs i den här artikeln. Den innehåller de dedikerade egenskapsindexen som redan finns i AEM. Använd inte med andra program.

Om du vill använda det på rätt sätt måste du placera innehållet i arkivet direkt i Solr Home Directory. Om det finns distributioner med flera noder bör den placeras direkt under rotmappen för varje nod.

Rekommenderade Solr-konfigurationsfiler

Hämta fil

AEM

AEM 6.1 integrerar även två indexeringsverktyg som finns i AEM 6.0 som en del av verktygsuppsättningen Adobe Consulting Services Commons:

  1. Förklara fråga, ett verktyg som hjälper administratörer att förstå hur frågor utförs.
  2. Oak Index Manager, ett webbanvändargränssnitt för att underhålla befintliga index.

Nu kan du nå dem genom att Verktyg - Åtgärder - Kontrollpanel - Diagnostik på AEM välkomstskärm.

Mer information om hur du använder dem finns i Dokumentation för instrumentpanelen för åtgärder.

Skapa egenskapsindex med OSGi

ACS Commons-paketet visar även OSGi-konfigurationer som kan användas för att skapa egenskapsindex.

Du kommer åt den från webbkonsolen genom att söka efter Se till att egenskapsindex för Oak".

chlimage_1-150

Felsöka indexeringsproblem

Det kan uppstå situationer när frågor tar lång tid att köra och den allmänna svarstiden för systemet är långsam.

I det här avsnittet ges rekommendationer om vad som måste göras för att spåra orsaken till sådana problem och råd om hur man löser dem.

Förbereder felsökningsinformation för analys

Det enklaste sättet att få den information som krävs för frågan som körs är via Förklara fråga, verktyg. På så sätt kan du samla in exakt den information som behövs för att felsöka en långsam fråga utan att behöva läsa loggnivåinformationen. Detta är önskvärt om du känner till frågan som felsöks.

Om detta inte är möjligt av någon anledning, kan du samla indexeringsloggarna i en enda fil och använda den för att felsöka just det problemet.

Aktivera loggning

Om du vill aktivera loggning måste du aktivera FELSÖKNING nivåloggar för de kategorier som gäller för ekindexering och frågor. Dessa kategorier är:

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

The com.day.cq.search -kategorin kan bara användas om du använder det AEM tillhandahållna QueryBuilder-verktyget.

OBSERVERA

Det är viktigt att loggarna bara är inställda på DEBUG så länge frågan som du vill felsöka körs. I annat fall genereras många händelser i loggarna över tid. På grund av detta växlar du tillbaka till INFO-nivåloggning för de kategorier som nämns ovan när de obligatoriska loggarna har samlats in.

Du kan aktivera loggning genom att följa den här proceduren:

  1. Peka webbläsaren till https://serveraddress:port/system/console/slinglog
  2. Klicka på Lägg till ny loggare i den nedre delen av konsolen.
  3. Lägg till de kategorier som nämns ovan på den nyligen skapade raden. Du kan använda + signera för att lägga till mer än en kategori i en enskild loggare.
  4. Välj FELSÖKNING från Loggnivå listruta.
  5. Ställ in utdatafilen på logs/queryDebug.log. Detta korrelerar alla DEBUG-händelser till en enda loggfil.
  6. Kör frågan eller återge sidan som använder frågan som du vill felsöka.
  7. När du har kört frågan går du tillbaka till loggningskonsolen och ändrar loggnivån för den nyligen skapade loggboken till INFORMATION.

Indexkonfiguration

Hur frågan utvärderas påverkas i hög grad av indexkonfigurationen. Det är viktigt att få indexkonfigurationen analyserad eller skickad till support. Du kan antingen hämta konfigurationen som ett innehållspaket eller hämta en JSON-återgivning.

Vanligtvis lagras indexkonfigurationen under /oak:index i CRXDE kan du hämta JSON-versionen på:

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

Om indexet är konfigurerat på en annan plats ändrar du sökvägen i enlighet med detta.

MBean output

Ibland kan det vara praktiskt att ange utdata för indexrelaterade MBeans för felsökning. Du kan göra detta genom att:

  1. Gå till JMX-konsolen på:
    https://serveraddress:port/system/console/jmx

  2. Sök efter följande MBeans:

    • Lucene-indexstatistik
    • CopyOnRead - supportstatistik
    • Oak Query-statistik
    • IndexStats
  3. Klicka på varje MBeans så att du kan få statistik över prestanda. Skapa en skärmbild eller anteckna dem om en supportanmälan behövs.

Du kan också hämta JSON-varianten av statistiken på följande URL:er:

  • 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

Du kan också tillhandahålla konsoliderade JMX-utdata via https://serveraddress:port/system/sling/monitoring/mbeans/org/apache/jackrabbit/oak.tidy.3.json. Detta inkluderar all Oak-relaterad MBean-information i JSON-format.

Annan information

Du kan samla in ytterligare information som kan hjälpa dig att felsöka problemet, till exempel:

  1. Den Oak-version som instansen körs på. Du kan se detta genom att öppna CRXDE och titta på versionen i det nedre högra hörnet av välkomstsidan, eller genom att kontrollera versionen av org.apache.jackrabbit.oak-core paket.
  2. Felsökningsutdata för QueryBuilder-felsökningsfrågan. Felsökaren finns på: https://serveraddress:port/libs/cq/search/content/querydebug.html

På denna sida