Registro para AEM como Cloud Service

O AEM as a Cloud Service é uma plataforma para clientes incluírem código personalizado para criar experiências exclusivas para sua base de clientes. Com isso em mente, o serviço de registro é uma função essencial para depurar e entender a execução de código em desenvolvimento local e em ambientes de nuvem, especialmente o AEM como ambientes Cloud Service Dev.

AEM configurações de registro e níveis de log são gerenciados em arquivos de configuração que são armazenados como parte do projeto AEM no Git e implantados como parte do projeto AEM pelo Cloud Manager. O logon AEM como um Cloud Service pode ser dividido em dois conjuntos lógicos:

• Registro de AEM, que executa o registro em log no nível de aplicativo AEM
• Apache HTTPD Web Server/Dispatcher logging, que executa o log do servidor da Web e do Dispatcher na camada de Publicação.

Registro de AEM

O registro no nível do aplicativo AEM é feito por três logs:

1. AEM logs Java, que renderizam instruções de registro Java para o aplicativo AEM.
2. Logs de solicitação HTTP, que registram informações sobre solicitações HTTP e suas respostas fornecidas por AEM
3. Logs de acesso HTTP, que registram informações resumidas e solicitações HTTP atendidas por AEM

AEM registro do Java

AEM como um Cloud Service fornece acesso às instruções de log do Java. Os desenvolvedores de aplicativos para AEM devem seguir as práticas recomendadas gerais de registro em Java, registrando declarações pertinentes sobre a execução do código personalizado, nos seguintes níveis de log:

Embora o registro em log do Java seja compatível com vários outros níveis de granularidade de registro, AEM como um Cloud Service recomenda o uso dos três níveis descritos acima.

AEM Os níveis de log são definidos por tipo de ambiente por meio da configuração OSGi, que, por sua vez, são comprometidos com o Git, e implantados por meio do Cloud Manager para AEM como Cloud Service. Por causa disso, é melhor manter as declarações de log consistentes e bem conhecidas para tipos de ambiente, a fim de garantir que os logs disponíveis via AEM como Cloud Service estejam disponíveis no nível de log ideal sem exigir a reimplantação do aplicativo com a configuração atualizada do nível de log.

Exemplo de saída de log

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 de registro

Registradores de configuração

AEM logs Java são definidos como configuração OSGi e, portanto, direcionam AEM específicos como ambientes Cloud Service usando pastas de modo de execução.

Configure o registro do java para pacotes Java personalizados por meio de configurações OSGi para a fábrica do Sling LogManager. Há duas propriedades de configuração compatíveis:

Alterar outras propriedades de configuração do OSGi do LogManager pode resultar em problemas de disponibilidade no AEM como um Cloud Service.

A seguir estão exemplos das configurações de registro recomendadas (usando o pacote Java de espaço reservado com.example) para os três AEM como tipos de ambiente Cloud Service.

Desenvolvimento

/apps/my-app/config/org.apache.sling.commons.log.LogManager.fatory.config-example.cfg.json

{
    "org.apache.sling.commons.log.names": ["com.example"],
    "org.apache.sling.commons.log.level": "debug"
}

Estágio

/apps/my-app/config.stage/org.apache.sling.commons.log.LogManager.fatory.config-example.cfg.json

{
    "org.apache.sling.commons.log.names": ["com.example"],
    "org.apache.sling.commons.log.level": "warn"
}

Produção

/apps/my-app/config.prod/org.apache.sling.commons.log.LogManager.fatory.config-example.cfg.json

{
    "org.apache.sling.commons.log.names": ["com.example"],
    "org.apache.sling.commons.log.level": "error"
}

Registro de solicitação HTTP AEM

AEM como um Cloud Service no registro de solicitação HTTP fornece informações sobre solicitações HTTP feitas para AEM e suas respostas HTTP em ordem de tempo. Esse log é útil para entender as Solicitações HTTP feitas no AEM e a ordem em que são processadas e respondidas.

A chave para entender esse log é mapear os pares de solicitação e resposta HTTP por suas IDs, indicadas pelo valor numérico entre colchetes. Observe que frequentemente as solicitações e suas respostas correspondentes têm outras solicitações HTTP e respostas interpeladas entre elas no log.

Exemplo de 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 de registro

Configurar o registro

O log de Solicitação HTTP AEM não pode ser configurado no AEM como Cloud Service.

Registro de acesso HTTP AEM

AEM como registro de acesso HTTP do Cloud Service mostra solicitações HTTP em ordem de tempo. Cada entrada de log representa a Solicitação HTTP que acessa AEM.

Esse log é útil para entender rapidamente quais solicitações HTTP são feitas para AEM, se elas tiverem êxito ao analisar o código de status de resposta HTTP associado e quanto tempo a solicitação HTTP levou para ser concluída. Esse log também pode ser útil para depurar a atividade de um usuário específico filtrando entradas de log por usuários.

Exemplo de saída de log

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"

Configurar o registro de acesso HTTP

O log de Acesso HTTP não pode ser configurado no AEM como Cloud Service.

Apache Web Server e Dispatcher Logging

O AEM as a Cloud Service fornece três logs para os Servidores Web Apache e a camada do dispatcher na Publicação:

• Log de acesso do servidor Web Apache HTTPD
• Log de erros do servidor Web Apache HTTPD
• Log do Dispatcher

Observe que esses logs só estão disponíveis para a camada Publicar .

Esse conjunto de logs fornece insights sobre solicitações HTTP para o AEM como um nível de publicação do Cloud Service antes que essas solicitações cheguem ao aplicativo AEM. Isso é importante para entender, pois, idealmente, a maioria das solicitações HTTP para os servidores da camada de Publicação é veiculada pelo conteúdo armazenado em cache pelo Apache HTTPD Web Server e AEM Dispatcher, e nunca alcança o aplicativo AEM em si. Portanto, não há instruções de log para essas solicitações em AEM logs de Java, Solicitação ou Acesso.

Log de acesso do servidor Web Apache HTTPD

O log de acesso do Apache HTTP Web Server fornece instruções para cada solicitação HTTP que chega ao servidor Web/Dispatcher da camada de publicação. Observe que as solicitações enviadas por um CDN upstream não são refletidas nesses logs.

Consulte as informações sobre o formato do log de erros na documentação oficial do apache.

Exemplo de saída de log

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 de registro

Configurando o Log de Acesso do Servidor Web Apache HTTPD

Este log não pode ser configurado no AEM como um Cloud Service.

Log de erros do servidor Web Apache HTTPD

O log de erros do Apache HTTP Web Server fornece instruções para cada erro no servidor Web/Dispatcher da camada de publicação.

Consulte as informações sobre o formato do log de erros na documentação oficial do apache.

Exemplo de saída de log

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 de registro

Configurando o Log de Erros do Servidor Web Apache HTTPD

Os níveis de log mod_rewrite são definidos pela variável REWRITE_LOG_LEVEL no arquivo conf.d/variables/global.var.

Ele pode ser definido como Erro, Aviso, Informações, Depuração e Trace1 - Trace8, com um valor padrão Warn. Para depurar as RewriteRules, é recomendável elevar o nível do log para Trace2.

Consulte a documentação do módulo mod_rewrite para obter mais informações.

Para definir o nível de log por ambiente, use a ramificação condicional apropriada no arquivo global.var, conforme descrito abaixo:

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

Log do Dispatcher

Exemplo

[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 de registro

Configurar o log de erros do Dispatcher

Os níveis de log do dispatcher são definidos pela variável DISP_LOG_LEVEL no arquivo conf.d/variables/global.var.

Ele pode ser definido como Erro, Aviso, Informações, Depuração e Trace1, com um valor padrão de Aviso.

Embora o log do Dispatcher seja compatível com vários outros níveis de granularidade do log, o AEM como um Cloud Service recomenda o uso dos níveis descritos abaixo.

Para definir o nível de log por ambiente, use a ramificação condicional apropriada no arquivo global.var, conforme descrito abaixo:

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

Como acessar logs

Ambientes em nuvem

O AEM como um Cloud Service logs para serviços em nuvem pode ser acessado baixando a interface do Cloud Manager ou ajustando logs na linha de comando usando o usando a interface de linha de comando Adobe I/O. Para obter mais informações, consulte a documentação de registro do Cloud Manager.

SDK local

O AEM as a Cloud Service SDK fornece arquivos de logs para suportar desenvolvimento local.

AEM logs estão localizados na pasta crx-quickstart/logs, onde os seguintes logs podem ser visualizados:

• AEM log do Java: error.log
• AEM log de solicitação HTTP: request.log
• Log de acesso HTTP AEM: access.log

Os logs de camada do Apache, incluindo o dispatcher, estão no contêiner Docker que contém o Dispatcher. Consulte a documentação do Dispatcher para obter informações sobre como iniciar o Dispatcher.

Para recuperar os logs:

1. Na linha de comando, digite docker ps para listar seus contêineres
2. Para fazer logon no contêiner, digite "docker exec -it <container> /bin/sh", onde <container> é o ID do contêiner do dispatcher da etapa anterior
3. Navegue até a raiz do cache em /mnt/var/www/html
4. Os logs estão em /etc/httpd/logs
5. Inspect os logs: eles podem ser acessados na pasta XYZ, onde os seguintes logs podem ser visualizados:
   • Log de acesso do servidor Web Apache HTTPD - httpd_access.log
   • Logs de erro do servidor Web Apache HTTPD - httpd_error.log
   • Logs do Dispatcher - dispatcher.log

Os registros também são impressos diretamente na saída do terminal. Na maioria das vezes, esses registros devem ser DEBUG, o que pode ser feito transmitindo o nível de Depuração como um parâmetro ao executar o Docker. Por exemplo:

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

Depuração da produção e do estágio

Em circunstâncias excepcionais, os níveis de log precisam ser alterados para registrar em uma granularidade mais fina em ambientes de Preparo ou Produção.

Embora isso seja possível, ele requer alterações nos níveis de log nos arquivos de configuração no Git de Aviso e Erro para Depuração e a execução de uma implantação para AEM como Cloud Service para registrar essas alterações de configuração nos ambientes.

Dependendo do tráfego e da quantidade de declarações de log gravadas pelo Debug, isso pode resultar em um impacto negativo no desempenho do ambiente. Portanto, é recomendável que as alterações nos níveis de depuração de Preparo e Produção sejam:

• Feito criteriosamente e apenas quando absolutamente necessário
• Revertido para os níveis apropriados e reimplantado o mais rápido possível

Logs do Splunk

Os clientes que têm contas do Splunk podem solicitar, por meio de um tíquete de suporte ao cliente, que seus registros de Cloud Service AEM sejam encaminhados ao índice apropriado. Os dados de registro são equivalentes ao que está disponível por meio dos downloads de log do Cloud Manager, mas os clientes podem achar conveniente aproveitar os recursos de query disponíveis no produto Splunk.

A largura de banda de rede associada aos logs enviados ao Splunk é considerada parte do uso de E/S de rede do cliente.

Ativar o encaminhamento de subpartes

Na solicitação de suporte, os clientes devem indicar:

• Endereço do ponto de extremidade de HEC do Splunk
• O índice Splunk
• A porta Splunk
• O token HEC do Splunk. Consulte esta página para obter mais informações.

As propriedades acima devem ser especificadas para cada combinação de programa/tipo de ambiente relevante. Por exemplo, se um cliente deseja ambientes de desenvolvimento, armazenamento temporário e produção, ele deve fornecer três conjuntos de informações, conforme indicado abaixo.

Certifique-se de que a solicitação inicial inclua todo o ambiente de desenvolvimento que deve ser ativado, além dos ambientes stage/prod.

Se qualquer novo ambiente de desenvolvimento criado após a solicitação inicial tiver o encaminhamento do Splunk, mas não o tiver ativado, uma solicitação adicional deverá ser feita.

Observe também que, se os ambientes de desenvolvimento tiverem sido solicitados, é possível que outros ambientes de desenvolvimento que não estejam nos ambientes de solicitação ou mesmo sandbox tenham o encaminhamento de Splunk ativado e compartilhem um índice de Splunk. Os clientes podem usar o campo aem_env_id para distinguir entre esses ambientes.

Abaixo você encontrará um exemplo de solicitação de suporte ao cliente:

Programa 123, Env de produção

• Endereço do ponto de extremidade de Splunk HEC: splunk-hec-ext.acme.com
• Índice de partes: acme_123prod (o cliente pode escolher qualquer convenção de nomenclatura que desejar)
• Porta de tronco: 443
• Token de HEC do Splunk: ABC123

Programa 123, Stage Env

• Endereço do ponto de extremidade de Splunk HEC: splunk-hec-ext.acme.com
• Índice de partes: acme_123stage
• Porta de tronco: 443
• Token de HEC do Splunk: ABC123

Programa 123, Dev Envs

• Endereço do ponto de extremidade de Splunk HEC: splunk-hec-ext.acme.com
• Índice de partes: acme_123dev
• Porta de tronco: 443
• Token de HEC do Splunk: ABC123

Pode ser suficiente para que o mesmo índice Splunk seja usado em cada ambiente, nesse caso, o campo aem_env_type pode ser usado para diferenciar com base nos valores dev, stage e prod. Se houver vários ambientes de desenvolvimento, o campo aem_env_id também poderá ser usado. Algumas organizações podem escolher um índice separado para os logs do ambiente de produção se o índice associado limitar o acesso a um conjunto reduzido de usuários do Splunk.

Veja um exemplo de entrada de log:

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