Registrazione per AEM as a Cloud Service

AEM as a Cloud Service è una piattaforma che consente ai clienti di includere codice personalizzato per creare esperienze univoche per la propria base di clienti. Tenendo presente questo aspetto, il servizio di registrazione è una funzione fondamentale per eseguire il debug e comprendere l’esecuzione del codice sullo sviluppo locale e gli ambienti cloud, in particolare gli ambienti di sviluppo as a Cloud Service AEM.

AEM impostazioni di registrazione e livelli di registro as a Cloud Service vengono gestiti in file di configurazione memorizzati come parte del progetto AEM in Git e distribuiti come parte del progetto AEM tramite Cloud Manager. L'accesso AEM as a Cloud Service può essere suddiviso in due set logici:

• Registrazione AEM, che esegue la registrazione a livello di applicazione AEM
• Registrazione server Web/Dispatcher HTTPD di Apache, che esegue la registrazione del server web e del Dispatcher sul livello di pubblicazione.

Registrazione AEM

La registrazione a livello di applicazione AEM è gestita da tre registri:

1. AEM i registri Java, che eseguono il rendering delle istruzioni di registrazione Java per l’applicazione AEM.
2. Registri di richiesta HTTP, che registrano le informazioni sulle richieste HTTP e le loro risposte fornite da AEM
3. Registri di accesso HTTP, che registrano le informazioni di riepilogo e le richieste HTTP servite da AEM

Registrazione Java AEM

AEM as a Cloud Service fornisce l'accesso alle istruzioni di registro Java. Gli sviluppatori di applicazioni per AEM devono seguire le best practice generali sulla registrazione Java, registrare istruzioni pertinenti sull’esecuzione del codice personalizzato, ai seguenti livelli di log:

Mentre la registrazione Java supporta diversi altri livelli di granularità della registrazione, AEM as a Cloud Service consiglia di utilizzare i tre livelli descritti in precedenza.

AEM I livelli di registro sono impostati per tipo di ambiente tramite la configurazione OSGi, che a sua volta si impegna su Git e implementato tramite Cloud Manager per AEM as a Cloud Service. Per questo motivo, è meglio mantenere le istruzioni di registro coerenti e ben note per i tipi di ambiente, al fine di garantire che i registri disponibili tramite AEM come Cloud Service siano disponibili a livello di log ottimale senza richiedere la ridistribuzione dell’applicazione con la configurazione aggiornata del livello di log.

Esempio di output del registro

22.06.2020 18:33:30.120 [cm-p12345-e6789-aem-author-86657cbb55-xrnzq] *ERROR* [qtp501076283-1809] io.prometheus.client.dropwizard.DropwizardExports Failed to get value from Gauge
22.06.2020 18:33:30.229 [cm-p12345-e6789-aem-author-86657cbb55-xrnzq] *INFO* [qtp501076283-1805] org.apache.sling.auth.core.impl.SlingAuthenticator getAnonymousResolver: Anonymous access not allowed by configuration - requesting credentials
22.06.2020 18:33:30.370 [cm-p12345-e6789-aem-author-86657cbb55-xrnzq] *INFO* [73.91.59.34 [1592850810364] GET /libs/granite/core/content/login.html HTTP/1.1] org.apache.sling.i18n.impl.JcrResourceBundle Finished loading 0 entries for 'en_US' (basename: <none>) in 4ms
22.06.2020 18:33:30.372 [cm-p12345-e6789-aem-author-86657cbb55-xrnzq] *INFO* [FelixLogListener] org.apache.sling.i18n Service [5126, [java.util.ResourceBundle]] ServiceEvent REGISTERED
22.06.2020 18:33:30.372 [cm-p12345-e6789-aem-author-86657cbb55-xrnzq] *WARN* [73.91.59.34 [1592850810364] GET /libs/granite/core/content/login.html HTTP/1.1] libs.granite.core.components.login.login$jsp j_reason param value 'unknown' cannot be mapped to a valid reason message: ignoring

Formato del registro

Registratori di configurazione

I registri Java AEM sono definiti come configurazione OSGi e quindi indirizzati a specifici ambienti AEM as a Cloud Service utilizzando le cartelle in modalità di esecuzione.

Configura la registrazione java per i pacchetti Java personalizzati tramite le configurazioni OSGi per la fabbrica Sling LogManager. Sono disponibili due proprietà di configurazione supportate:

La modifica di altre proprietà di configurazione OSGi di LogManager può causare problemi di disponibilità in AEM as a Cloud Service.

Di seguito sono riportati alcuni esempi delle configurazioni di registrazione consigliate (utilizzando il pacchetto Java segnaposto di com.example) per i tre tipi di ambiente as a Cloud Service AEM.

Sviluppo

/apps/my-app/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": "debug"
}

Area di visualizzazione

/apps/my-app/config.stage/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": "warn"
}

Produzione

/apps/my-app/config.prod/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": "error"
}

Registrazione delle richieste HTTP AEM

AEM registrazione delle richieste HTTP di as a Cloud Service fornisce informazioni approfondite sulle richieste HTTP effettuate a AEM e sulle relative risposte HTTP in ordine temporale. Questo registro è utile per comprendere le richieste HTTP effettuate a AEM e l’ordine in cui vengono elaborate e a cui rispondono.

La chiave per comprendere questo registro è la mappatura delle coppie di richieste e risposte HTTP in base ai loro ID, identificate dal valore numerico tra parentesi. Tieni presente che spesso le richieste e le risposte corrispondenti hanno altre richieste HTTP e risposte incrociate tra loro nel registro.

Esempio di log

29/Apr/2020:19:14:21 +0000 [137] -> POST /conf/global/settings/dam/adminui-extension/metadataprofile/ HTTP/1.1 [cm-p1234-e5678-aem-author-59555cb5b8-q7l9s]
...
29/Apr/2020:19:14:22 +0000 [139] -> GET /mnt/overlay/dam/gui/content/processingprofilepage/metadataprofiles/editor.html/conf/global/settings/dam/adminui-extension/metadataprofile/main HTTP/1.1 [cm-p1234-e5678-aem-author-59555cb5b8-q7l9s]
...
29/Apr/2020:19:14:21 +0000 [137] <- 201 text/html 111ms [cm-p1234-e5678-aem-author-59555cb5b8-q7l9s]
...
29/Apr/2020:19:14:22 +0000 [139] <- 200 text/html;charset=utf-8 637ms [cm-p1234-e5678-aem-author-59555cb5b8-q7l9s]

Formato del registro

Configurazione del registro

Il registro AEM richiesta HTTP non è configurabile in AEM as a Cloud Service.

Registrazione AEM accesso HTTP

AEM come registrazione Cloud Service degli accessi HTTP mostra le richieste HTTP in ordine temporale. Ogni voce di registro rappresenta la richiesta HTTP che accede a AEM.

Questo registro è utile per comprendere rapidamente quali richieste HTTP vengono effettuate per AEM, se riescono guardando il codice di stato della risposta HTTP che accompagna e quanto tempo la richiesta HTTP ha impiegato per essere completata. Questo registro può anche essere utile per eseguire il debug di un'attività specifica di un utente filtrando le voci di registro da Utenti.

Esempio di output del registro

cm-p1234-e26813-aem-author-59555cb5b8-8kgr2 - example@adobe.com 30/Apr/2020:17:37:14 +0000  "GET /libs/granite/ui/references/clientlibs/references.lc-5188e85840c529149e6cd29d94e74ad5-lc.min.css HTTP/1.1" 200 1141 "https://author-p10711-e26813.adobeaemcloud.com/mnt/overlay/dam/gui/content/assets/metadataeditor.external.html?item=/content/dam/en/images/example.jpeg&_charset_=utf8" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.122 Safari/537.36"
cm-p1234-e26813-aem-author-59555cb5b8-8kgr2 - example@adobe.com 30/Apr/2020:17:37:14 +0000  "GET /libs/dam/gui/coral/components/admin/customthumb/clientlibs.lc-60e4443805c37afa0c74b674b141f1df-lc.min.css HTTP/1.1" 200 809 "https://author-p10711-e26813.adobeaemcloud.com/mnt/overlay/dam/gui/content/assets/metadataeditor.external.html?item=/content/dam/en/images/example.jpeg&_charset_=utf8" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.122 Safari/537.36"
cm-p1234-e26813-aem-author-59555cb5b8-8kgr2 - example@adobe.com 30/Apr/2020:17:37:14 +0000  "GET /libs/dam/gui/coral/components/admin/metadataeditor/clientlibs/metadataeditor.lc-4a2226d8232f8b7ab27d24820b9ddd64-lc.min.js HTTP/1.1" 200 7965 "https://author-p10711-e26813.adobeaemcloud.com/mnt/overlay/dam/gui/content/assets/metadataeditor.external.html?item=/content/dam/en/images/example.jpeg&_charset_=utf8" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.122 Safari/537.36"

Configurazione del registro di accesso HTTP

Il registro di accesso HTTP non è configurabile in AEM as a Cloud Service.

Registrazione di Apache Web Server e Dispatcher

AEM as a Cloud Service fornisce tre registri per il livello Apache Web Server e dispatcher nella pubblicazione:

• Registro di accesso al server Web HTTPD di Apache
• Registro degli errori del server web HTTPD di Apache
• Registro di Dispatcher

Questi registri sono disponibili solo per il livello di pubblicazione.

Questo set di registri fornisce informazioni sulle richieste HTTP al livello di pubblicazione AEM as a Cloud Service prima che tali richieste raggiungano l’applicazione AEM. Questo è importante da comprendere in quanto, idealmente, la maggior parte delle richieste HTTP ai server del livello di pubblicazione sono servite da contenuti memorizzati nella cache da Apache HTTPD Web Server e AEM Dispatcher e non arrivano mai all’applicazione AEM stessa. Pertanto non ci sono istruzioni di registro per queste richieste nei registri AEM Java, Request o Access.

Registro di accesso al server Web HTTPD di Apache

Il registro di accesso Apache HTTP Web Server fornisce istruzioni per ogni richiesta HTTP che raggiunge il server Web/Dispatcher del livello Publish. Tieni presente che le richieste che vengono servite da una rete CDN a monte non vengono riportate in questi registri.

Consulta le informazioni sul formato del registro degli errori nella documentazione ufficiale di apache.

Esempio di output del registro

cm-p1234-e5678-aem-publish-b86c6b466-qpfvp - - 17/Jul/2020:09:14:41 +0000  "GET /etc.clientlibs/wknd/clientlibs/clientlib-site/resources/images/favicons/favicon-32.png HTTP/1.1" 200 715 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:78.0) Gecko/20100101 Firefox/78.0"
cm-p1234-e5678-aem-publish-b86c6b466-qpfvp - - 17/Jul/2020:09:14:41 +0000  "GET /etc.clientlibs/wknd/clientlibs/clientlib-site/resources/images/favicons/favicon-512.png HTTP/1.1" 200 9631 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:78.0) Gecko/20100101 Firefox/78.0"
cm-p1234-e5678-aem-publish-b86c6b466-qpfvp - - 17/Jul/2020:09:14:42 +0000  "GET /etc.clientlibs/wknd/clientlibs/clientlib-site/resources/images/country-flags/US.svg HTTP/1.1" 200 810 "https://publish-p6902-e30226.adobeaemcloud.com/content/wknd/us/en.html" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:78.0) Gecko/20100101 Firefox/78.0"

Formato del registro

Configurazione del registro di accesso al server web HTTPD di Apache

Questo registro non è configurabile in AEM as a Cloud Service.

Registro degli errori del server web HTTPD di Apache

Il registro degli errori del server Web HTTP Apache fornisce istruzioni per ogni errore nel server Web/Dispatcher del livello di pubblicazione.

Consulta le informazioni sul formato del registro degli errori nella documentazione ufficiale di apache.

Esempio di output del registro

Fri Jul 17 02:19:48.093820 2020 [mpm_worker:notice] [pid 1:tid 140272153361288] [cm-p1234-e30226-aem-publish-b86c6b466-b9427] AH00292: Apache/2.4.43 (Unix) Communique/4.3.4-20200424 mod_qos/11.63 configured -- resuming normal operations
Fri Jul 17 02:19:48.093874 2020 [core:notice] [pid 1:tid 140272153361288] [cm-p1234-e30226-aem-publish-b86c6b466-b9427] AH00094: Command line: 'httpd -d /etc/httpd -f /etc/httpd/conf/httpd.conf -D FOREGROUND -D ENVIRONMENT_PROD'
Fri Jul 17 02:29:34.517189 2020 [mpm_worker:notice] [pid 1:tid 140293638175624] [cm-p1234-e30226-aem-publish-b496f64bf-5vckp] AH00295: caught SIGTERM, shutting down

Formato del registro

Configurazione del registro degli errori del server web HTTPD di Apache

I livelli di registro mod_rewrite sono definiti dalla variabile REWRITE_LOG_LEVEL nel file conf.d/variables/global.var.

Può essere impostato su Errore, Avverti, Informazioni, Debug e Trace1 - Trace8, con un valore predefinito Avverti. Per eseguire il debug di RewriteRules, si consiglia di elevare il livello di log a Trace2.

Per ulteriori informazioni, consulta la documentazione del modulo mod_rewrite .

Per impostare il livello di log per ambiente, utilizza il ramo condizionale appropriato nel file global.var, come descritto di seguito:

Define REWRITE_LOG_LEVEL Debug
  
<IfDefine ENVIRONMENT_STAGE>
  ...
  Define REWRITE_LOG_LEVEL Warn
  ...
</IfDefine>
<IfDefine ENVIRONMENT_PROD>
  ...
  Define REWRITE_LOG_LEVEL Error
  ...
</IfDefine>

Registro di Dispatcher

Esempio

[17/Jul/2020:23:48:06 +0000] [I] [cm-p12904-e25628-aem-publish-6c5f7c9dbd-mzcvr] "GET /content/wknd/us/en/adventures.html" - 475ms [publishfarm/0] [action miss] "publish-p12904-e25628.adobeaemcloud.com"
[17/Jul/2020:23:48:07 +0000] [I] [cm-p12904-e25628-aem-publish-6c5f7c9dbd-mzcvr] "GET /content/wknd/us/en/adventures/climbing-new-zealand/_jcr_content/root/responsivegrid/carousel/item_1571266094599.coreimg.jpeg/1473680817282/sport-climbing.jpeg" 302 10ms [publishfarm/0] [action none] "publish-p12904-e25628.adobeaemcloud.com"
[17/Jul/2020:23:48:07 +0000] [I] [cm-p12904-e25628-aem-publish-6c5f7c9dbd-mzcvr] "GET /content/wknd/us/en/adventures/ski-touring-mont-blanc/_jcr_content/root/responsivegrid/carousel/item_1571168419252.coreimg.jpeg/1572047288089/adobestock-238230356.jpeg" 302 11ms [publishfarm/0] [action none] "publish-p12904-e25628.adobeaemcloud.com"

Formato del registro

Configurazione del registro degli errori del Dispatcher

I livelli di log del dispatcher sono definiti dalla variabile DISP_LOG_LEVEL nel file conf.d/variables/global.var.

Può essere impostato su Errore, Avverti, Informazioni, Debug e Trace1, con un valore predefinito Avverti.

Mentre la funzione di log del Dispatcher supporta diversi altri livelli di granularità della registrazione, l’AEM as a Cloud Service consiglia di utilizzare i livelli descritti di seguito.

Per impostare il livello di registro per ambiente, utilizza il ramo condizionale appropriato nel file global.var come descritto di seguito:

Define DISP_LOG_LEVEL Debug
  
<IfDefine ENVIRONMENT_STAGE>
  ...
  Define DISP_LOG_LEVEL Warn
  ...
</IfDefine>
<IfDefine ENVIRONMENT_PROD>
  ...
  Define DISP_LOG_LEVEL Error
  ...
</IfDefine>

Accesso ai registri

Ambienti cloud

È possibile accedere AEM registri as a Cloud Service per i servizi cloud scaricando tramite l’interfaccia di Cloud Manager o inserendo nella riga di comando i registri nella riga di comando utilizzando l’interfaccia della riga di comando di Adobe I/O. Per ulteriori informazioni, consulta la documentazione sulla registrazione di Cloud Manager.

SDK locale

AEM SDK as a Cloud Service fornisce file di registro per supportare lo sviluppo locale.

I registri AEM si trovano nella cartella crx-quickstart/logs, in cui è possibile visualizzare i seguenti registri:

• Registro Java AEM: error.log
• Registro delle richieste HTTP AEM: request.log
• Registro di accesso HTTP AEM: access.log

I registri di livello Apache, incluso il dispatcher, si trovano nel contenitore Docker che contiene il Dispatcher. Per informazioni su come avviare il Dispatcher, consulta la documentazione di Dispatcher .

Per recuperare i registri:

1. Nella riga di comando, digita docker ps per elencare i contenitori
2. Per accedere al contenitore, digita "docker exec -it <container> /bin/sh", dove <container> è l’ID del contenitore del dispatcher del passaggio precedente
3. Passa alla directory principale della cache in /mnt/var/www/html
4. I log si trovano sotto /etc/httpd/logs
5. Inspect registra: sono accessibili nella cartella XYZ, dove è possibile visualizzare i seguenti registri:
   • Registro di accesso al server Web HTTPD di Apache - httpd_access.log
   • Log degli errori del server web HTTPD di Apache - httpd_error.log
   • Log del dispatcher - dispatcher.log

I registri vengono inoltre stampati direttamente nell'uscita terminale. Nella maggior parte dei casi, questi log devono essere DEBUG, che può essere realizzato passando il livello Debug come parametro durante l'esecuzione di Docker. Esempio:

DISP_LOG_LEVEL=Debug ./bin/docker_run.sh out docker.for.mac.localhost:4503 8080

Debug di fase e produzione

In circostanze eccezionali, è necessario modificare i livelli di registro per accedere a una granularità più precisa negli ambienti Stage o Production.

Anche se questo è possibile, richiede modifiche ai livelli di registro nei file di configurazione in Git da Avverti ed Errore a Debug ed esegue una distribuzione AEM as a Cloud Service per registrare queste modifiche di configurazione con gli ambienti.

A seconda del traffico e della quantità di istruzioni di registro scritte da Debug, questo può causare un impatto negativo sulle prestazioni sull'ambiente, pertanto, si consiglia di modificare i livelli di debug di Stage e Production:

• Fatto in modo giudizioso, e solo quando assolutamente necessario
• Ripristino dei livelli appropriati e ridistribuzione al più presto

Registri Splunk

I clienti che dispongono di account Splunk possono richiedere tramite ticket di assistenza clienti che i loro registri AEM Cloud Service vengano inoltrati all’indice appropriato. I dati di registrazione equivalgono a quelli disponibili tramite i download del registro di Cloud Manager, ma i clienti potrebbero avere comodo sfruttare le funzioni di query disponibili nel prodotto Splunk.

La larghezza di banda di rete associata ai log inviati a Splunk è considerata parte dell'utilizzo di I/O di rete del cliente.

Abilitazione dell’inoltro Splunk

Nella richiesta di assistenza, i clienti devono indicare:

• Indirizzo endpoint HEC Splunk
• Indice Splunk
• Porta Splunk
• Il token Splunk HEC. Per ulteriori informazioni, consulta questa pagina .

Le proprietà di cui sopra devono essere specificate per ciascuna combinazione di programmi/tipi di ambiente pertinente. Ad esempio, se un cliente desidera ambienti di sviluppo, staging e produzione, deve fornire tre set di informazioni, come indicato di seguito.

Assicurati che la richiesta iniziale includa tutti gli ambienti di sviluppo che devono essere abilitati, oltre agli ambienti stage/prod.

Se dopo la richiesta iniziale sono stati creati nuovi ambienti di sviluppo per cui è previsto l’inoltro Splunk, ma non è stato abilitato , è necessario effettuare una richiesta aggiuntiva.

Inoltre, se sono stati richiesti ambienti di sviluppo, è possibile che altri ambienti di sviluppo non inclusi nella richiesta o persino negli ambienti sandbox abbiano abilitato l’inoltro Splunk e condividano un indice Splunk. I clienti possono utilizzare il campo aem_env_id per distinguere tra questi ambienti.

Di seguito è riportato un esempio di richiesta di assistenza clienti:

Programma 123, Production Env

• Indirizzo endpoint HEC della splunk: splunk-hec-ext.acme.com
• Indice splunk: acme_123prod (il cliente può scegliere qualsiasi convenzione di denominazione desidera)
• Porta splunk: 443
• Token HEC Splunk: ABC123

Programma 123, Stage Env

• Indirizzo endpoint HEC della splunk: splunk-hec-ext.acme.com
• Indice splunk: acme_123stage
• Porta splunk: 443
• Token HEC Splunk: ABC123

Programma 123, Dev Envs

• Indirizzo endpoint HEC della splunk: splunk-hec-ext.acme.com
• Indice splunk: acme_123dev
• Porta splunk: 443
• Token HEC Splunk: ABC123

Può essere sufficiente che lo stesso indice Splunk sia utilizzato per ogni ambiente, nel qual caso il campo aem_env_type può essere utilizzato per differenziare in base ai valori dev, stage e prod. Se sono presenti più ambienti di sviluppo, è possibile utilizzare anche il campo aem_env_id . Alcune organizzazioni possono scegliere un indice separato per i registri dell'ambiente di produzione se l'indice associato limita l'accesso a un set ridotto di utenti Splunk.

Ecco un esempio di voce di registro:

aem_env_id: 1242
aem_env_type: dev
aem_program_id: 12314
aem_tier: author
file_path: /var/log/aem/error.log
host: 172.34.200.12 
level: INFO
msg: [FelixLogListener] com.adobe.granite.repository Service [5091, [org.apache.jackrabbit.oak.api.jmx.SessionMBean]] ServiceEvent REGISTERED
orig_time: 16.07.2020 08:35:32.346
pod_name: aemloggingall-aem-author-77797d55d4-74zvt
splunk_customer: true