Foutopsporing in AEM as a Cloud Service met behulp van logbestanden

Logs fungeert als frontline voor foutopsporing in AEM-toepassingen in AEM as a Cloud Service, maar is afhankelijk van een adequate aanmelding in de geïmplementeerde AEM-toepassing.

Alle logboekactiviteit voor de dienst van AEM van een bepaalde milieu (Auteur, Publish/Publish Dispatcher) wordt geconsolideerd in één enkel logboekdossier, zelfs als de verschillende pods binnen die dienst de logboekverklaringen produceren.

Pod Ids wordt verstrekt in elke logboekverklaring, en het toestaan van het filtreren of het sorteren van logboekverklaringen. Pod-id's hebben de volgende indeling:

Aangepaste logbestanden

AEM als Cloud Services biedt geen ondersteuning voor aangepaste logbestanden, maar biedt wel ondersteuning voor aangepaste logboekregistratie.

Voor de logboeken van Java om in AEM as a Cloud Service (via Cloud Managerof Adobe I/O CLI) beschikbaar te zijn, moeten de verklaringen van het douanelogboek worden geschreven error.log. Logbestanden die naar aangepaste benoemde logboeken worden geschreven, zoals example.log , zijn niet toegankelijk vanuit AEM as a Cloud Service.

Logbestanden kunnen naar de error.log worden geschreven met behulp van een Sling LogManager OSGi-configuratieeigenschap in de org.apache.sling.commons.log.LogManager.factory.config~example.cfg.json -bestanden van de toepassing.

{
   ...
   "org.apache.sling.commons.log.file": "logs/error.log"
   ...
}

AEM Author and Publish service logs

Zowel AEM-auteur- als -publicatieservices bieden AEM-runtimeserverlogboeken:

AEM Publish Dispatcher logs

Alleen AEM Publish Dispatcher biedt Apache-webserver en Dispatcher-logbestanden, aangezien deze aspecten alleen bestaan in de AEM Publish-laag en niet in de AEM Author-laag.

Cloud Manager cloud-manager

Met Adobe Cloud Manager kunt u logbestanden overdag downloaden via de actie Download Logs van een omgeving.

Deze logbestanden kunnen worden gedownload en geïnspecteerd met behulp van alle programma's voor loganalyse.

Adobe I/O CLI met Cloud Manager-insteekmodule aio

Adobe Cloud Manager steunt de toegang tot van AEM as a Cloud Service logboeken via Adobe I/O CLImet de stop van Cloud Manager voor Adobe I/O CLI.

Eerst, opstelling Adobe I/O met de stop van Cloud Manager.

Verzeker relevante identiteitskaart van het Programma en Milieu ID zijn geïdentificeerd, en gebruik lijst-beschikbaar-logboek-optiesom van de logboekopties een lijst te maken die aan staartof downloadlogboeken worden gebruikt.

$ aio cloudmanager:list-programs
Program Id Name      Enabled
14304      Program 1 true
11454      Program 2 true
11502      Program 3 true

$ aio config:set cloudmanager_programid <PROGRAM ID>

$ aio cloudmanager:list-environments
Environment Id Name            Type  Description
22295          program-3-dev   dev
22310          program-3-prod  prod
22294          program-3-stage stage

$ aio cloudmanager:list-available-log-options <ENVIRONMENT ID>
Environment Id Service    Name
22295          author     aemaccess
22295          author     aemerror
22295          author     aemrequest
22295          publish    aemaccess
22295          publish    aemerror
22295          publish    aemrequest
22295          dispatcher httpdaccess
22295          dispatcher httpderror
22295          dispatcher aemdispatcher

Logboeken voor trainingen aio-cli-tail-logs

Adobe I/O CLI verstrekt de capaciteit om logboeken in real time van AEM as a Cloud Service te staart gebruikend het staart-logboekenbevel. Tailing is handig voor het bekijken van realtime logactiviteiten terwijl acties worden uitgevoerd in de AEM as a Cloud Service-omgeving.

$ aio config:set cloudmanager_programid <PROGRAM ID>
$ aio cloudmanager:tail-logs <ENVIRONMENT ID> <SERVICE> <NAME>

Andere opdrachtregelprogramma's, zoals grep , kunnen samen met tail-logs worden gebruikt om logbestandinstructies te isoleren, bijvoorbeeld:

$ aio cloudmanager:tail-logs 12345 author | grep com.example.MySlingModel

… geeft alleen loginstructies weer die zijn gegenereerd vanuit com.example.MySlingModel of bevatten die tekenreeks in die instructies.

Logbestanden downloaden aio-cli-download-logs

Adobe I/O CLI verstrekt de capaciteit om logboeken van AEM as a Cloud Service te downloaden gebruikend het download-logboeken) bevel. Dit levert hetzelfde eindresultaat op als het downloaden van de logbestanden vanuit de Cloud Manager-webinterface. Het verschil is dat met de opdracht download-logs de logbestanden over dagen worden geconsolideerd op basis van het aantal dagen dat logbestanden worden aangevraagd.

$ aio config:set cloudmanager_programid <PROGRAM ID>
$ aio cloudmanager:download-logs <ENVIRONMENT> <SERVICE> <NAME> <DAYS>

Logboeken begrijpen

Logboeken in AEM as a Cloud Service bevatten meerdere pods waarin loginstructies worden geschreven. Omdat meerdere AEM-instanties naar hetzelfde logbestand schrijven, is het belangrijk dat u begrijpt hoe u de ruis kunt analyseren en verminderen tijdens het opsporen van fouten. Voor de uitleg wordt het volgende aemerror -logfragment gebruikt:

01.01.2020 12:00:00.000 [cm-p12345-e56789-aem-author-abcdefg-1111] *DEBUG* [qtp2078364989-269] com.example.components.impl.ExampleModelImpl Preparing to collect resources
01.01.2020 12:00:01.002 [cm-p12345-e56789-aem-author-abcdefg-2222] *WARN*  [qtp40782847611-87] com.example.services.impl.ExampleServiceImpl Unable to resolve resource [ /content/example ] to a resource. Aborting.
01.01.2020 12:00:02.003 [cm-p12345-e56789-aem-author-abcdefg-1111] *ERROR* [qtp2078364989-269] com.example.components.impl.ExampleModelImpl Unable to collect any resources

Met behulp van de pod-id, het gegevenspunt na de datum en tijd, kunnen de logboeken worden gesorteerd door de pod of door een AEM-instantie binnen de service, waardoor het eenvoudiger wordt om code-uitvoering te traceren en te begrijpen.

pod cm-p12345-e56789-aem-auteur-abcdefg-1111

01.01.2020 12:00:00.000 [cm-p12345-e56789-aem-author-abcdefg-1111] *DEBUG* [qtp2078364989-269] com.example.components.impl.ExampleModelImpl Preparing to collect resources
01.01.2020 12:00:02.003 [cm-p12345-e56789-aem-author-abcdefg-1111] *ERROR* [qtp2078364989-269] com.example.components.impl.ExampleModelImpl Unable to collect any resources

Pod cm-p12345-e56789-aem-auteur-abcdefg-2222

01.01.2020 12:00:01.002 [cm-p12345-e56789-aem-author-abcdefg-2222] *WARN*  [qtp2078364989-269] com.example.services.impl.ExampleServiceImpl Unable to resolve resource [ /content/example ] to a resource. Aborting.

Aanbevolen logniveaus log-levels

De algemene richtlijnen van Adobe voor logniveaus per AEM as a Cloud Service-omgeving moeten worden nageleefd met de standaardloginstellingen van AEM (met het standaardlogniveau INFO). Adobe raadt aan dat ook de aangepaste code van instrumenten wordt voorzien met loginstructies, waardoor deze kan worden uitgevoerd met het logniveau van INFO . De logboekniveaus worden gehandhaafd in code

…en dus een implementatie vereisen om te wijzigen.

Omgevingsspecifieke variabelen om Java-logniveaus in te stellen

Een alternatief aan het plaatsen van statische bekende het logboekniveaus van Java voor elk milieu moet AEM gebruiken als Cloud Service milieu specifieke variabelenom logboekniveaus van parameters te bepalen, toestaand de waarden om dynamisch via Adobe I/O CLI met de stop van Cloud Managerworden veranderd.

Dit vereist het bijwerken van de registrerenconfiguraties OSGi om de milieu specifieke veranderlijke placeholders te gebruiken. Standaardwaardenvoor logboekniveaus zouden moeten worden geplaatst zoals per aanbevelingen van Adobe. Bijvoorbeeld:

/apps/example/config/org.apache.sling.commons.log.LogManager.factory.config~example.cfg.json

{
    ...
    "org.apache.sling.commons.log.names": ["com.example"],
    "org.apache.sling.commons.log.level": "$[env:LOG_LEVEL;default=DEBUG]"
    ...
}

Deze aanpak heeft nadelen waarmee rekening moet worden gehouden:

Milieu specifieke variabelen werken niet voor Apache Webserver of het logboekconfiguraties van Dispatcher aangezien deze niet via configuratie OSGi worden gevormd.