Oak-run.jar Användningsexempel för indexering

Oak-run har stöd för indexering av användningsfall på kommandoraden utan att du behöver utföra dessa användningsfall via AEM JMX-konsol.

De största fördelarna med att använda indexkommandot oak-run.jar för att hantera Oak-index är:

  1. Kommandot för index som körs på baksidan innehåller en ny indexverktygsuppsättning för AEM 6.4.
  2. Oak-run minskar tiden för omindexering vilket minskar omindexeringstiden för större databaser.
  3. Oak-run minskar resursförbrukningen vid omindexering av AEM, vilket ger bättre systemprestanda.
  4. Oak-run ger omindexering utan band, stöd för situationer där produktionen måste vara tillgänglig och klarar inte underhåll eller driftavbrott som annars krävs för omindexering.

I avsnitten nedan finns exempelkommandon. Oak-run index-kommandot stöder alla NodeStore- och BlobStore-inställningar. Exemplen nedan handlar om inställningar som har FileDataStore och SegmentNodeStore.

Användningsfall 1 - Kontroll av indexöverensstämmelse

Det här är ett användningsexempel som rör skadade index. I vissa fall gick det inte att avgöra vilken av indexen som är skadad. Adobe har därför tillhandahållit verktyg som

  1. Utför konsekvenskontroller av index för alla index och tillhandahåller en rapport om vilka index som är giltiga och vilka som inte är giltiga.
  2. Verktygen är användbara även om AEM inte är åtkomliga.
  3. Den är lätt att använda.

Kontroll av skadade index kan göras via --index-consistency-check-åtgärd:

java -jar oak-run*.jar index --fds-path=/path/to/datastore  /path/to/segmentstore/ --index-consistency-check

Detta skapar en rapport i indexing-result/index-consistency-check-report.txt. Nedan finns en exempelrapport:

Valid indexes :
        - /content/oak:index/enablementResourceName
        - /oak:index/cqProjectLucene
        - /oak:index/cqTagLucene
        - /oak:index/lucene
        - /oak:index/ntBaseLucene
        - /oak:index/socialLucene
    Invalid indexes :
        - /oak:index/atDamIndex
        - /oak:index/atIndex
        - /oak:index/cqPageLucene
        - /oak:index/damAssetLucene
        - /oak:index/groups
        - /oak:index/slingeventJob
        - /oak:index/users
        - /oak:index/workflowDataLucene
    Ignored indexes as these are not of type lucene:
        - /oak:index/acPrincipalName
        - /oak:index/active

Fördelar

Den här verktygen kan nu användas av supporten och systemadministratören för att snabbt avgöra vilka index som är skadade och sedan indexera om dem.

Användningsfall 2 - Indexstatistik

För diagnostisering av vissa fall kring frågeprestanda behövde Adobe ofta en befintlig indexdefinition, indexrelaterad statistik från kundinställningarna. Hittills har denna information spridits över flera resurser. För att underlätta felsökningen har Adobe skapat verktyg som gör att:

  1. Dumpa alla indexdefinitioner som finns i systemet i en enda JSON-fil.

  2. Dumpa viktig statistik från befintliga index,

  3. Dumpa indexinnehåll för offlineanalys.

  4. Kan användas även om AEM inte är tillgänglig

Ovanstående åtgärder kan nu utföras med följande kommandon för åtgärdsindex:

  • --index-info - Samlar in och dumpar diverse statistik som hör till index

  • --index-definitions - Samlar in och dumpar indexdefinitioner

  • --index-dump - Dumpar indexinnehåll

Nedan visas ett exempel på hur kommandona fungerar i praktiken:

java -jar oak-run*.jar index --fds-path=/path/to/datastore  /path/to/segmentstore/ --index-info --index-definitions --index-dump

Rapporterna genereras i indexing-result/index-info.txt och indexing-result/index-definitions.json

Dessutom tillhandahålls samma information via webbkonsolen och ingår i konfigurationsdumpens zip. De kan nås på följande plats:

https://serverhost:serverport/system/console/status-oak-index-defn

Fördelar

Med det här verktyget kan du snabbt samla in all information som behövs för indexering eller frågeproblem och minska tiden för extrahering av informationen.

Användningsfall 3 - omindexering

Beroende på scenarierna måste i vissa fall omindexering göras. Omindexeringen görs för närvarande genom att flaggan reindex ställs in på true i indexdefinitionsnoden via CRXDE eller via användargränssnittet i Indexhanteraren. När flaggan har angetts utförs omindexering asynkront.

Några punkter att tänka på när det gäller omindexering:

  • Omindexering är mycket långsammare i DocumentNodeStore-uppsättningar jämfört med SegmentNodeStore-uppsättningar där allt innehåll är lokalt.

  • I den aktuella designen blockeras den asynkrona indexeraren medan omindexering sker och alla andra asynkrona index blir inaktuella och uppdateras inte under indexeringstiden. På grund av detta kanske användarna inte ser aktuella resultat om systemet används.

  • Omindexering innebär att hela databasen gås igenom, vilket kan göra AEM mycket belastad och därmed påverka slutanvändarens upplevelse.

  • För en DocumentNodeStore-installation där omindexering kan ta lång tid, måste indexeringen startas om från början om anslutningen till Mongo-databasen misslyckas under operationen.

  • I vissa fall kan omindexering ta lång tid på grund av textrahering. Detta gäller främst för inställningar med många PDF-filer, där den tid som går åt för textrahering kan påverka indexeringstiden.

För att uppnå dessa mål har indexverktygen för ekningskörning stöd för olika omindexeringslägen som kan användas efter behov. Indexkommandot för ekning ger följande fördelar:

  • omindexering utanför band - omindexering vid ekning kan göras separat från en AEM som körs och minimerar därmed påverkan på den AEM instansen som används.

  • omindexering utanför tillåtet intervall - Omindexeringen utförs utan att indexeringen påverkas. Detta innebär att den asynkrona indexeraren kan fortsätta att indexera andra index.

  • Förenklad omindexering för DocumentNodeStore-installationer - För DocumentNodeStore installationer kan omindexering göras med ett enda kommando som ser till att omindexering görs på det optimala sättet.

  • Stöder uppdatering av indexdefinitioner och introduktion av nya indexdefinitioner

Indexera om - DocumentNodeStore

För DocumentNodeStore-installationer kan omindexering göras via ett enda ekrun-kommando:

java -jar oak-run*.jar index --reindex --index-paths=/oak:index/lucene --read-write --fds-path=/path/to/datastore mongodb://server:port/aem

Detta ger följande fördelar

  • Minimal påverkan på pågående AEM. De flesta läsningar kan göras från sekundära servrar och AEM som körs påverkas inte negativt på grund av all den genomgång som krävs för omindexering.
  • Användare kan också tillhandahålla en JSON för ett nytt eller uppdaterat index via alternativet --index-definitions-file.

Indexera om - SegmentNodeStore

För SegmentNodeStore-installationer kan omindexering göras på något av följande sätt:

Online-omindexering - SegmentNodeStore

Följ det etablerade sättet som omindexering görs på genom att ange flaggan reindex.

Online Reindex - SegmentNodeStore - Den AEM instansen körs

För SegmentNodeStore-installationer kan bara en process komma åt segmentfiler i skrivskyddat läge. På grund av detta måste ytterligare manuella åtgärder vidtas för att vissa åtgärder i körning ska kunna utföras.

Detta skulle innebära följande:

  1. Stega text

  2. Anslut oak-run till samma databas som används av AEM i skrivskyddat läge och utför indexering. Ett exempel på hur du kan uppnå detta:

    java -jar oak-run-1.7.6.jar index --fds-path=/Users/dhasler/dev/cq/quickstart/target/crx-quickstart/repository/datastore/ --checkpoint 26b7da38-a699-45b2-82fb-73aa2f9af0e2 --reindex --index-paths=/oak:index/lucene /Users/dhasler/dev/cq/quickstart/target/crx-quickstart/repository/segmentstore/

  3. Importera slutligen de skapade indexfilerna via IndexerMBean#importIndex-åtgärden från den sökväg där körningen sparade indexfilerna när ovanstående kommando kördes.

I det här fallet behöver du inte stoppa AEM eller etablera någon ny instans. När indexering innefattar genomgång av hela databasen skulle dock I/O-belastningen på installationen öka, vilket påverkar körningens prestanda negativt.

Online Reindex - SegmentNodeStore - Den AEM instansen är avstängd

För SegmentNodeStore-installationer kan omindexering göras via ett enda ekrun-kommando. AEM måste dock stängas av.

Du kan aktivera omindexering med följande kommando:

java -jar oak-run*.jar index --reindex --index-paths=/oak:index/lucene --read-write --fds-path=/path/to/datastore  /path/to/segmentstore/

Skillnaden mellan det här sättet och det som förklaras ovan är att skapande av kontrollpunkter och indeximport sker automatiskt. Nackdelen är att AEM måste vara nere under processen.

Indexering utanför intervall - SegmentNodeStore

I det här fallet kan du indexera om en klonad installation för att minimera påverkan på den AEM som körs:

  1. Skapa en kontrollpunkt via en JMX-åtgärd. Du kan göra detta genom att gå till JMX-konsolen och söka efter CheckpointManager. Klicka sedan på createCheckpoint(long p1)-åtgärden med ett högt värde för förfallotid i sekunder (till exempel 2592000).

  2. Kopiera mappen crx-quickstart till en ny dator

  3. Indexera om via indexkommandot för ekvering

  4. Kopiera de genererade indexfilerna till AEM server

  5. Importera indexfilerna via JMX.

I det här fallet antas det att datalagret är tillgängligt i en annan instans, vilket kanske inte är möjligt om FileDataStore placeras i en molnbaserad lagringslösning som EBS. Detta utesluter scenariot där FileDataStore också klonas. Om indexdefinitionen inte utför fulltextindexering behövs ingen åtkomst till DataStore.

Användningsfall 4 - Uppdaterar indexdefinitioner

För närvarande kan du överföra indexdefinitionsändringar via ACS-paketet Kontrollera index. Detta gör att indexdefinitioner kan levereras via innehållspaket, vilket senare kräver omindexering via att flaggan reindex ställs in på true.

Detta fungerar bra för mindre installationer där omindexering inte tar lång tid. För mycket stora databaser kommer dock omindexering att göras på betydligt längre tid. I sådana fall kan vi nu använda indexverktygen för ekakning.

Funktionen Oak-run har nu stöd för att tillhandahålla indexdefinitioner i JSON-format och att skapa index i out-of-band-läge där inga ändringar görs i en live-instans.

Den process du behöver tänka på för detta ändamål är:

  1. En utvecklare uppdaterar indexdefinitionerna på en lokal instans och genererar sedan en JSON-fil för indexdefinitioner via alternativet --index-definitions

  2. Den uppdaterade JSON-versionen ges sedan till systemadministratören

  3. Systemadministratören följer out-of-band-metoden och förbereder indexet för en annan installation

  4. När detta är klart importeras de genererade indexfilerna till en AEM som körs.

På denna sida