Il debug di AEM come Cloud Service l'utilizzo dei registri

I log fungono da prima linea per il debug delle applicazioni AEM in AEM come Cloud Service, ma dipendono da registrazione adeguati nel applicazione AEM distribuito.

Tutte le attività di registro per il servizio AEM di un determinato ambiente (Autore, Publish/Publish Dispatcher) vengono consolidate in un singolo file di registro, lineare se diversi pod all'interno di tale servizio generano le istruzioni di log.

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

AEM as a Cloud Services non supporta i file di registro personalizzati, ma supporta 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 del servizio Author e Publish di AEM

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

Registri Dispatcher di pubblicazione AEM

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

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.

Adobe I/O CLI 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, imposta il plug-in Adobe I/O con Cloud Manager.

Verificare che siano stati identificati l'ID programma e l'ID ambiente pertinenti e utilizzare list-available-log-options per elencare le opzioni di registro utilizzate per coda o scaricare 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

Tronchi di coda aio-cli-tail-logs

Adobe Systems interfaccia a riga di comando I/O consente di coda i log in tempo reale da AEM come Cloud Service utilizzando il comando coda-logs . La taina è utile per osservare l'attività dei log in tempo reale mentre vengono eseguite azioni sull'ambiente AEM come Cloud Service.

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

Altri strumenti da riga di comando, come quelli grep che possono essere utilizzati insieme tail-logs per aiutare a isolare le istruzioni di registro delle 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 di 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 da Pod o dall’istanza di 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 consistono nel rispettare le impostazioni di registro predefinite di AEM (con il livello di registro predefinito di INFO). Adobe consiglia inoltre di dotare il codice personalizzato di istruzioni di registro, che consentono di eseguirlo con il livello di registro di INFO. 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

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

Ciò richiede l'aggiornamento delle configurazioni registrazione OSGi per utilizzare i segnaposto delle variabili specifiche dell'ambiente. I valori predefiniti per i livelli di registro devono essere impostati in base ai consigli Adobe Systems. 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 ha degli aspetti negativi che devono essere presi in considerazione account:

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.