Debug di AEM as a Cloud Service tramite i registri

I registri fungono da strumenti di prima linea per il debug delle applicazioni AEM in AEM as a Cloud Service, ma dipendono dalla registrazione adeguata nell’applicazione AEM implementata.

Tutte le attività di registro per il servizio AEM di un dato ambiente (Author, Publish/Publish Dispatcher) sono consolidate in un unico file di registro, anche se i pod diversi all’interno di tale servizio generano le istruzioni di registro.

Gli ID dei pod vengono forniti in ogni istruzione di registro e consentono di filtrare o fascicolare le istruzioni di registro. Gli ID pod sono nel formato di:

File di registro personalizzati

I Cloud Service AEM non supportano i file di registro personalizzati, ma la registrazione personalizzata.

Affinché i registri Java siano disponibili in AEM as a Cloud Service (tramite Cloud Manager o Adobe I/O CLI), le istruzioni di registro personalizzate devono essere scritte in error.log. I registri scritti in registri denominati personalizzati, ad esempio example.log, non saranno accessibili da AEM as a Cloud Service.

I registri possono essere scritti in error.log utilizzando una proprietà di configurazione Sling LogManager OSGi nei file org.apache.sling.commons.log.LogManager.factory.config~example.cfg.json dell'applicazione.

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

Registri di servizio per l’authoring di AEM e Publish

I servizi di authoring AEM e Publish forniscono i registri server di runtime AEM:

Registri Dispatcher di AEM Publish

Solo AEM Publish Dispatcher fornisce il server web Apache e i registri di Dispatcher, in quanto questi aspetti esistono solo nel livello AEM Publish e non nel livello AEM Author.

Cloud Manager cloud-manager

Adobe Cloud Manager consente di scaricare i registri ogni giorno tramite l’azione Scarica registri di un ambiente.

Questi registri possono essere scaricati e ispezionati tramite qualsiasi strumento di analisi dei registri.

CLI Adobe I/O con plug-in Cloud Manager aio

Adobe Cloud Manager supporta l'accesso ai registri di AEM as a Cloud Service tramite Adobe I/O CLI con il plug-in Cloud Manager per Adobe I/O CLI.

Innanzitutto, configura l'Adobe I/O con il plug-in di Cloud Manager.

Verifica che l'ID programma e l'ID ambiente pertinenti siano stati identificati e utilizza list-available-log-options per elencare le opzioni di registro utilizzate per tail o download registri.

$ 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

Registri di coda aio-cli-tail-logs

Adobe I/O CLI consente di visualizzare i registri in tempo reale da AEM as a Cloud Service utilizzando il comando tail-logs. La coda è utile per guardare l’attività di registro in tempo reale mentre le azioni vengono eseguite nell’ambiente AEM as a Cloud Service.

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

Altri strumenti della riga di comando, come grep, possono essere utilizzati insieme a tail-logs per isolare le istruzioni di registro di interesse, ad esempio:

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

… visualizza solo le istruzioni di registro generate da com.example.MySlingModel o contengono tale stringa.

Download dei registri aio-cli-download-logs

Adobe I/O CLI consente di scaricare i registri da AEM as a Cloud Service utilizzando il comando download-logs). Questo fornisce lo stesso risultato finale del download dei registri dall'interfaccia utente Web di Cloud Manager, con la differenza che il comando download-logs consolida i registri tra giorni, in base al numero di giorni richiesti.

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

Informazioni sui registri

I registri in AEM as a Cloud Service contengono più pod che scrivono istruzioni di registro. Poiché più istanze AEM scrivono nello stesso file di registro, è importante comprendere come analizzare e ridurre i disturbi durante il debug. Per spiegare, viene utilizzato il seguente frammento di registro aemerror:

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

Utilizzando gli ID del pod, il punto dati dopo la data e l’ora, i registri possono essere fascicolati dal pod o dall’istanza AEM all’interno del servizio, facilitando la tracciatura e la comprensione dell’esecuzione del codice.

Pod cm-p12345-e56789-aem-author-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-author-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.

Livelli di registro consigliati log-levels

Le linee guida generali di Adobe sui livelli di registro per ambiente AEM as a Cloud Service sono:

Impostando il livello di registro più appropriato per ogni tipo di ambiente con AEM as a Cloud Service, i livelli di registro vengono mantenuti nel codice

…e quindi richiedono una distribuzione per cambiare.

Variabili specifiche dell’ambiente per impostare i livelli di registro Java

In alternativa all'impostazione di livelli di registro Java noti statici per ogni ambiente, è possibile utilizzare AEM come variabili specifiche dell'ambiente del Cloud Service per parametrizzare i livelli di registro, consentendo la modifica dinamica dei valori tramite Adobe I/O CLI con plug-in Cloud Manager.

A tal fine, è necessario aggiornare le configurazioni OSGi di registrazione per utilizzare segnaposto di variabili specifici per l’ambiente. I valori predefiniti per i livelli di registro devono essere impostati in base a Adobi consigliati. Ad esempio:

/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]"
    ...
}

Questo approccio presenta aspetti negativi che devono essere presi in considerazione:

Le variabili specifiche dell'ambiente non funzionano per le configurazioni del server web Apache o del registro di Dispatcher, in quanto non sono configurate tramite la configurazione OSGi.