Analysator van best practices gebruiken using-best-practices-analyzer

Laatst bijgewerkt: 22 mei 2026

Van toepassing op:
Experience Manager as a Cloud Service

Onderwerpen:
Migration

Gemaakt voor:

Admin

Belangrijke overwegingen voor het Gebruiken van Analyzer van Beste praktijken imp-considerations

Volg de sectie hieronder om de belangrijke overwegingen voor het runnen van de Analysator van Beste praktijken (BPA) te begrijpen:

Het BPA- rapport wordt gebouwd gebruikend de output van de Detector van het Patroon van Adobe Experience Manager (AEM) . De versie van de Detector van het Patroon die door BPA wordt gebruikt is inbegrepen in het BPA installatiepakket.
BPA kan slechts door de admin gebruiker of een gebruiker in de beheerders groep worden in werking gesteld.

BPA wordt ondersteund op AEM-instanties met versie 6.1 en hoger.

note
NOTE
Zie Installerend op AEM 6.1 voor speciale vereisten voor het installeren van BPA op AEM 6.1.

BPA kan op om het even welk milieu in werking stellen, maar het heeft de voorkeur om het op het milieu van het a Stadium te hebben.

note
NOTE
Om een effect op bedrijfskritieke instanties te vermijden, adviseert men dat u BPA op een milieu van het Stadium in werking stelt dat zo dicht mogelijk aan het milieu van de Productie op de gebieden van aanpassingen, configuraties, inhoud en gebruikerstoepassingen is. Alternatief, kan het op een kloon van het milieu van de productie Auteur worden in werking gesteld.

Het genereren van de inhoud van het BPA-rapport kan een aanzienlijke hoeveelheid tijd in beslag nemen, van enkele minuten tot een paar uur. De hoeveelheid tijd die nodig is, is in hoge mate afhankelijk van de grootte en aard van de inhoud van de AEM-opslagplaats, de AEM-versie en andere factoren.
Wegens de significante tijd die kan worden vereist om de rapportinhoud te produceren, worden zij geproduceerd door een achtergrondproces en in een geheim voorgeheugen gehouden. Het bekijken van en het downloaden van het rapport zou vrij snel moeten zijn omdat het het inhoudsgeheime voorgeheugen tot het verloopt of het rapport uitdrukkelijk wordt verfrist. Tijdens de generatie van rapportinhoud kunt u uw browser lusje sluiten en in een recentere tijd terugkeren om het rapport te bekijken zodra zijn inhoud in het geheime voorgeheugen beschikbaar is.

Beschikbaarheid availability

De Analysator van Beste praktijken kan als zip dossier van het portaal van de Distributie van de Software worden gedownload. U kunt het pakket via Manager van het Pakket op uw bronAdobe Experience Manager (AEM) instantie installeren.

NOTE

Download de Analysator van Beste praktijken van het portaal van de Distributie van de Software .

Connectiviteit Source-omgeving source-environment-connectivity

De AEM-broninstantie wordt mogelijk achter een firewall uitgevoerd, waarbij deze alleen bepaalde hosts kan bereiken die aan een Lijst van gewenste personen zijn toegevoegd. Als u het BPA-gegenereerde rapport automatisch naar Cloud Acceleration Manager wilt uploaden, moeten de volgende eindpunten toegankelijk zijn vanaf de instantie waarop AEM wordt uitgevoerd:

De Azure blob-opslagservice: casstorageprod.blob.core.windows.net

Het Rapport van de Analysator van Beste praktijken bekijken viewing-report

Adobe Experience Manager 6.3.0 en hoger aem-later-versions

Volg deze sectie om te leren hoe te om het rapport van de Analysator van Beste praktijken te bekijken:

Selecteer Adobe Experience Manager en navigeer aan hulpmiddelen > Verrichtingen > Analysator van Beste praktijken.
Klik produceren Rapport om de Analysator van Beste praktijken uit te voeren.

NOTE

Vanaf BPA versie 2.1.54 is een nieuwe functie geïntroduceerd om de Lighthouse Score te verkrijgen.

Na het klikken produceer Rapport, zal een pop-up het verzoeken van de Openbare Plaats URL van AEM voor de Score van de Lichter verschijnen. De gebruiker moet een geldige URL invoeren in het opgegeven veld.
1. Als de URL geldig is, wordt een succesbericht weergegeven.
2. Als de URL ongeldig is, wordt een foutbericht weergegeven.
Verstrek BPA upload sleutel om het geproduceerde BPA- rapport aan Cloud Acceleration Manager (CAM) automatisch te uploaden. Om uploadt sleutel te krijgen, navigeer aan de Analyse van Beste praktijken in CAM

NOTE

U hebt de optie om automatisch over te slaan uploadt aan CAM door te selecteren overslaat rapport auto uploadt aan CAM. Als u verkiest om over te slaan, zult u het BPA- rapport als komma-gescheiden waardedossier manueel moeten downloaden en dan het dossier in CAM uploaden. Het wordt aanbevolen de optie Upload key te gebruiken omdat deze de bewerking stroomlijnt.

IMPORTANT

Wanneer het manueel uploaden aan CAM, zijn de rapportgrootte beperkt tot ongeveer 200MB. Voor grotere rapporten moet u de automatische upload gebruiken.

produceer knoop actief wordt wanneer een geldige sleutel wordt verstrekt. Klik op produceren om rapportgeneratie in werking te stellen.
Terwijl BPA het rapport produceert, kunt u de vooruitgang zien die door het hulpmiddel op het scherm wordt gemaakt. De voortgang wordt weergegeven in procenten dat is voltooid. Ook wordt het aantal geanalyseerde items weergegeven en wordt het aantal gevonden bevindingen weergegeven.

NOTE

De tijdstempel van de BPA-upload met sleutelvervaldatum wordt in de rechterbovenhoek weergegeven. U zou BPA moeten vernieuwen uploadt sleutel wanneer het bijna zijn vervaldatum is. Om de sleutel te vernieuwen, kunt u op klikken vernieuwt om aan CAM te navigeren om de sleutel te vernieuwen.

Nadat het BPA-rapport is gegenereerd, worden een samenvatting en het aantal bevindingen weergegeven in een tabelvorm die is ingedeeld op basis van het type bevinding en het belangrijkste niveau. Voor meer informatie over een bepaalde bevinding kunt u op het nummer klikken dat overeenkomt met het type bevinding in de tabel.
U hebt de optie om het rapport in een komma-gescheiden waarden (CSV) formaat te downloaden door op Uitvoer naar CSV te klikken. U hebt ook de optie om het rapport in CAM te bekijken door op te klikken gaat naar CAM. Dit zal u aan de pagina van de Analyse van Beste praktijken in CAM nemen.

U kunt BPA dwingen om zijn geheime voorgeheugen te ontruimen en het rapport opnieuw te produceren door te klikken verfrist Rapport.

verfrist rapport

Als het geheime voorgeheugen verloopt, hebt u de optie om het laatste geproduceerde rapport in CAM te bekijken door op te klikken Mening het laatste geproduceerde rapport in CAM of een nieuwe rapportgeneratie in werking te stellen door op te klikken produceert Nieuw Rapport.

Geen rapport

Het gebruiken van Filters in het Rapport van de Analysator van Beste praktijken bpa-filters

Om bevindingen met betrekking tot ACS Commons uit te filtreren, volg de stappen hieronder:

Klik op het linkerspoorpictogram aan de linkerkant van de pagina. Dit zal de filter van de Bevelen ACS tonen. Klik de filter van Bevelen ACS om interactieve checkbox zoals aangetoond in het hieronder beeld te tonen.

ACS Commons Filter

note
NOTE
Het linkerspoorpictogram zal verschijnen slechts als BPA het gebruik van ACSCommons ontdekt.

Schakel het selectievakje uit om alle bevindingen met betrekking tot ACS-opdrachten uit te filteren. U zou a Gefilterde het Vinden Aantal op het rapport zoals aangetoond in het beeld hieronder moeten zien. Het filter wordt ook toegepast op het rapport wanneer het in een komma-gescheiden-waarde (CSV) formaat wordt uitgevoerd.

Gefilterde het Vinden Telling

note
NOTE
De bevindingen van de ACS-Gemeenschappelijke Gemeenschap moeten niet worden genegeerd. Zie documentatie om verenigbaarheid met AEM as a Cloud Service te bepalen.

Het rapport met de analyse van best practices interpreteren cra-report

Wanneer het hulpmiddel van de Analysator van Beste praktijken in de instantie van AEM in werking wordt gesteld, wordt het rapport getoond als resultaten in het hulpmiddelvenster.

De vorm van het rapport is:

Overzicht van het Rapport: Informatie over het rapport zelf, die de volgende informatie bevat:
- Tijd van het Rapport: Wanneer de rapportinhoud is gegenereerd en voor het eerst beschikbaar is gesteld.
- Vervaltijd: Wanneer het geheime voorgeheugen van de rapportinhoud zal verlopen.
- Periode van de Tijd van de Generatie: De tijd die door het proces van de het genereren van de rapportinhoud wordt doorgebracht.
- het Vinden Telling: Het totale aantal bevindingen in het verslag.
Overzicht van het Systeem: Informatie over het AEM-systeem waarop de BPA werd uitgevoerd.
zoekend Categorieën: Meerdere secties waarin elk een of meer bevindingen van dezelfde categorie behandelt. Elk gedeelte bevat het volgende: Naam van categorie, subtypen, aantal en belang zoeken, overzicht, koppeling naar categoriedocumentatie en individuele zoekinformatie.

Aan elke bevinding wordt een belangrijk niveau toegewezen om een ruwe prioriteit voor actie aan te geven.

NOTE

Meer over elke het Vinden Categorie leren, zie {de Categorieën van de Detector van 0} Patroon 🔗.

Volg de onderstaande tabel om inzicht te krijgen in de belangrijkste niveaus:

Belang

Beschrijving

INFO

Deze bevinding wordt ter informatie verstrekt.

ADVISORY

Deze bevinding is mogelijk een upgradeprobleem. Verdere onderzoeken worden aanbevolen.

MAJOR

Deze bevinding is waarschijnlijk een upgradeprobleem dat moet worden aangepakt.

KRITIEK

Deze bevinding is waarschijnlijk een upgradeprobleem dat moet worden aangepakt om functieverlies of prestatieverlies te voorkomen.

Het CSV-rapport van de Analysator van best practices interpreteren cra-csv-report

Wanneer u de CSV optie van uw instantie van AEM klikt, wordt het formaat CSV van het rapport van de Analysator van Beste praktijken gebouwd van het inhoudsgeheime voorgeheugen en teruggekeerd aan uw browser. Afhankelijk van de browserinstellingen wordt dit rapport automatisch gedownload als een bestand met de standaardnaam results.csv .

Als het geheime voorgeheugen is verlopen, dan wordt het rapport opnieuw geproduceerd alvorens het Csv- dossier wordt gebouwd en gedownload.

De CSV-indeling van het rapport bevat informatie die wordt gegenereerd op basis van de uitvoer van de patroondetector, gesorteerd en ingedeeld op categorietype, subtype en belangrijkheidsniveau. De indeling is geschikt voor weergave en bewerking in een toepassing zoals Microsoft Excel. Het is bedoeld om alle vindingsinformatie in een herhaalbare formaat te verstrekken dat wanneer het vergelijken van rapporten in tijd kan nuttig zijn om vooruitgang te meten.

De kolommen van het CSV-indelingsrapport zijn:

code: de categoriecode
type: de categorienaam
subtype: het subtype categorie
belang: het belangrijkste niveau
herkenningsteken: de primaire identificator van de bevinding
andere: aanvullende informatie over de bevinding
bericht: het bericht voor de bevinding
moreInfo: een link die kan worden gebruikt om online hulp over de categorie te openen
context: een JSON-reeks voor het zoeken van gegevens

De waarde “\N” in een kolom voor een individuele bevinding geeft aan dat er geen gegevens zijn opgegeven.

HTTP-interface http-interface

BPA verstrekt een interface van HTTP die als alternatief voor zijn gebruikersinterface binnen AEM kan worden gebruikt. De interface ondersteunt zowel HEAD- als GET-opdrachten. Het kan worden gebruikt om het BPA- rapport te produceren en het in één van drie formaten terug te keren: JSON, CSV en door tabs gescheiden waarden (TSV).

De volgende URL’s zijn beschikbaar voor HTTP-toegang, waarbij <host> de hostnaam en poort is, indien nodig, van de server waarop de BPA is geïnstalleerd:

http://<host>/apps/best-practices-analyzer/analysis/report.json voor JSON-indeling
http://<host>/apps/best-practices-analyzer/analysis/report.csv voor CSV-indeling
http://<host>/apps/best-practices-analyzer/analysis/report.tsv voor TSV-indeling

Een HTTP-aanvraag uitvoeren executing-http-request

De HTTP-interface kan in verschillende methoden worden gebruikt.

Een eenvoudige manier is om een browsertabblad te openen in dezelfde browser waarin u zich al als beheerder bij AEM hebt aangemeld. U kunt de URL invoeren op het browsertabblad en de resultaten laten weergeven of downloaden door de browser.

U kunt ook een opdrachtregelprogramma gebruiken, zoals curl of wget , en elke HTTP-clienttoepassing. Wanneer u geen browsertabblad gebruikt met een geverifieerde sessie, moet u een beheergebruikersnaam en -wachtwoord opgeven als onderdeel van de opmerking.

Hieronder ziet u hoe u dit kunt doen:
curl -u admin:admin 'http://localhost:4502/apps/best-practices-analyzer/analysis/report.csv' > report.csv.

Kopteksten en parameters http-headers-and-parameters

De volgende HTTP-headers worden door deze interface gebruikt:

Cache-Control: max-age=<seconds> : Geeft de levensduur van de cachevervaging in seconden aan. (Zie 🔗 RFC 7234.)
Prefer: respond-async : Geeft op dat de server asynchroon moet reageren. (Zie RFC 7240 .)
Prefer: return=minimal : Geeft aan dat de server een minimale reactie moet retourneren. (Zie RFC 7240 .)

De volgende HTTP-queryparameters zijn beschikbaar als handig wanneer HTTP-headers niet gemakkelijk kunnen worden gebruikt:

max-age (nummer, optioneel): Geeft de levensduur van de cachevervaging in seconden aan. Dit getal moet 0 of hoger zijn. De standaard versheidslevensduur is 86400 seconden. Zonder deze parameter of de overeenkomstige kopbal, wordt een vers geheime voorgeheugen gebruikt om verzoeken voor 24 uren te dienen, waarbij het geheime voorgeheugen moet worden opnieuw geproduceerd. Het gebruiken van max-age=0 zal dwingen het geheime voorgeheugen wordt ontruimd en zal een regeneratie van het rapport in werking stellen, gebruikend het vorige niet-nul freshness leven voor het onlangs geproduceerde geheime voorgeheugen.
respond-async (Boolean, optioneel): Geeft op dat de reactie asynchroon moet worden opgegeven. Als u respond-async=true gebruikt wanneer de cache leeg is, retourneert de server een reactie van 202 Accepted zonder te wachten tot de cache is vernieuwd en tot het rapport is gegenereerd. Als de cache vers is, heeft deze parameter geen effect. De standaardwaarde is false . Zonder deze parameter of de overeenkomstige kopbal zal de server synchroon antwoorden, die een significante hoeveelheid tijd kan vereisen en een aanpassing van de maximumreactietijd voor de cliënt van HTTP vereisen.
may-refresh-cache (Boolean, optioneel): Geeft aan dat de server de cache kan vernieuwen als reactie op een aanvraag als de huidige cache leeg, leeg of bijna leeg is. Als may-refresh-cache=true is, of als dit niet is opgegeven, kan de server een achtergrondtaak starten die de Patroondetector oproept en de cache vernieuwt. Als may-refresh-cache=false dan zal de server geen verfrissingstaak in werking stellen die anders zou gedaan zijn als het geheime voorgeheugen leeg of verouderd is, in welk geval het rapport leeg is. Deze parameter heeft geen invloed op vernieuwingstaken die al in uitvoering zijn.
return-minimal (Boolean, optioneel): Geeft aan dat de reactie van de server alleen de status moet bevatten die de voortgangsindicatie en cachestatus in de JSON-indeling bevat. Als return-minimal=true , is de hoofdtekst van de reactie beperkt tot het statusobject. Als return-minimal=false is opgegeven of als deze niet is opgegeven, wordt een volledige reactie gegeven.
log-findings (Boolean, optioneel): Specificeert dat de server de inhoud van het geheime voorgeheugen zou moeten registreren wanneer het eerst wordt gebouwd of verfrist. Elke bevinding via de cache wordt geregistreerd als een JSON-tekenreeks. Deze logboekregistratie vindt alleen plaats als log-findings=true en de aanvraag een nieuwe cache genereren.

Wanneer zowel een HTTP- kopbal als overeenkomstige vraagparameter aanwezig zijn, zal de vraagparameter belangrijkheid nemen.

Een eenvoudige manier om de generatie van het rapport via de interface van HTTP in werking te stellen is met het volgende bevel:
curl -u admin:admin 'http://localhost:4502/apps/best-practices-analyzer/analysis/report.json?max-age=0&respond-async=true'.

Zodra een verzoek is ingediend, te hoeven de cliënt niet actief voor het te produceren rapport te blijven. De rapportgeneratie zou met één cliënt kunnen in werking worden gesteld gebruikend HTTP KRIJGT verzoek en, zodra het rapport is geproduceerd, bekeken van het geheime voorgeheugen met een andere cliënt of met het hulpmiddel BPA in het gebruikersinterface van AEM.

Reacties http-responses

De volgende responswaarden zijn mogelijk:

200 OK : Geeft aan dat de reactie bevindingen van de Patroondetector bevat die zijn gegenereerd binnen de versheidslevensduur van de cache.
202 Accepted : Wordt gebruikt om aan te geven dat de cache leeg is. Als respond-async=true en may-refresh-cache=true dit antwoord aangeeft dat een vernieuwingstaak wordt uitgevoerd. Als may-refresh-cache=false deze reactie alleen maar aangeeft dat de cache leeg is.
400 Bad Request : Geeft aan dat er een fout is opgetreden met de aanvraag. Een bericht in het formaat van de Details van het Probleem (zie RFC 7807 ) verstrekt meer details.
401 Unauthorized : Geeft aan dat de aanvraag niet is geautoriseerd.
500 Internal Server Error : Geeft aan dat er een interne serverfout is opgetreden. Een bericht in het formaat van de Details van het Probleem verstrekt meer details.
503 Service Unavailable : Geeft aan dat de server bezig is met een andere reactie en dit verzoek niet tijdig kan uitvoeren. Dit zal alleen gebeuren wanneer synchrone verzoeken worden gedaan. Een bericht in het formaat van de Details van het Probleem verstrekt meer details.

Beheerdersgegevens

Aanpassing van levensduur cache cache-adjustment

De standaardlevensduur van de BPA-cache is 24 uur. Met de optie om een rapport te verfrissen, en het geheime voorgeheugen, in zowel de instantie van AEM als de interface van HTTP te regenereren, zal deze standaardwaarde waarschijnlijk aangewezen voor de meeste toepassingen van BPA zijn. Als de tijd van de rapportgeneratie voor uw instantie van AEM bijzonder lang is, kunt u het geheim voorgeheugenleven willen aanpassen om de regeneratie van het rapport te minimaliseren.

De levenswaarde van de cache wordt opgeslagen als de eigenschap maxCacheAge op het volgende knooppunt in de opslagplaats:
/apps/best-practices-analyzer/content/BestPracticesReport/jcr:content

De waarde van deze eigenschap is de levensduur van de cache in seconden. Een beheerder kan de levensduur van de cache aanpassen met behulp van CRX/DE Lite.

Installeren op AEM 6.1 installing-on-aem61

BPA gebruikt een gebruikersaccount voor systeemservices met de naam repository-reader-service om de Patroondetector uit te voeren. Deze account is beschikbaar op AEM 6.2 en hoger. Op AEM 6.1, moet deze rekening voorafgaand aan installatie van BPA worden gecreeerd door de volgende stappen te nemen:

Volg de instructies bij Creërend een nieuwe de dienstgebruiker om een gebruiker tot stand te brengen. Stel de gebruikersnaam in op repository-reader-service , laat het tijdelijke pad leeg en klik op het groene vinkje.
Volg de instructies bij het Leiden Gebruikers en Groepen , specifiek de instructies om Gebruikers aan een Groep toe te voegen om de repository-reader-service gebruiker aan de administrators groep toe te voegen.
Installeer het BPA-pakket via Package Manager op uw AEM-bronexemplaar. (Hiermee wordt het benodigde configuratieamendement toegevoegd aan de configuratie ServiceUserMapper voor de gebruiker van de systeemservice van repository-reader-service .)

recommendation-more-help

experience-manager-cloud-service-help-main-toc