Documentação AEM as a Cloud Service Guia do usuário

Utilização do Analisador de práticas recomendadas using-best-practices-analyzer

Last update: Wed Oct 23 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Tópicos:

Criado para:

Administrador

Considerações importantes sobre o uso do Analisador de práticas recomendadas imp-considerations

Siga a seção abaixo para entender considerações importantes na execução do Analisador de práticas recomendadas (BPA):

O relatório do BPA é criado usando a saída do Detector de Padrões do Adobe Experience Manager (AEM). A versão do Detector de padrões usada pelo BPA está incluída no pacote de instalação do BPA.
O BPA só pode ser executado pelo usuário administrador ou por um usuário do grupo administradores.

BPA é compatível em instâncias AEM com a versão 6.1 e superior.

note note
NOTE
Consulte Instalação no AEM 6.1 para obter os requisitos especiais de instalação do BPA no AEM 6.1.

O BPA pode ser executado em qualquer ambiente, mas é preferível executá-lo em um ambiente Preparo.

note note
NOTE
Para evitar um impacto em instâncias críticas para os negócios, é recomendável executar o BPA em um ambiente de Preparo o mais próximo possível do ambiente de Produção nas áreas de personalizações, configurações, conteúdo e aplicativos de usuários. Como alternativa, ele pode ser executado em um clone do ambiente de Autor de produção.

A geração de conteúdo do relatório do BPA pode levar um tempo significativo, de vários minutos a algumas horas. O tempo necessário depende muito do tamanho e da natureza do conteúdo do repositório do AEM, da versão do AEM e de outros fatores.
Devido ao tempo significativo que pode ser necessário para gerar o conteúdo do relatório, este é gerado por um processo em segundo plano e mantido em cache. A visualização e o download do relatório devem ser relativamente rápidos, pois ele utiliza o cache de conteúdo até expirar ou até o relatório ser atualizado. Durante a geração do conteúdo do relatório, você pode fechar a guia do navegador e retornar posteriormente para a visualização do relatório quando o conteúdo estiver disponível no cache.

Disponibilidade availability

É possível baixar o Analisador de Práticas Recomendadas como arquivo zip no Portal de distribuição de software. Você pode instalar o pacote por meio do Gerenciador de Pacotes na instância do Adobe Experience Manager (AEM) de origem.

NOTE

Baixe o Analisador de Práticas Recomendadas do portal Distribuição de Software.

Conectividade de ambiente do Source source-environment-connectivity

A instância do AEM de origem pode estar sendo executada por trás de um firewall, em que ela só pode alcançar determinados hosts que foram adicionados a uma Lista de permissões. Para carregar automaticamente o relatório gerado pelo BPA para o Cloud Acceleration Manager com êxito, os seguintes endpoints precisam estar acessíveis na instância que está executando o AEM:

O serviço de armazenamento de blobs do Azure: casstorageprod.blob.core.windows.net

Exibição do relatório do Analisador de práticas recomendadas viewing-report

Adobe Experience Manager 6.3.0 e posterior aem-later-versions

Siga esta seção para saber como exibir o relatório do Analisador de práticas recomendadas:

Selecione o Adobe Experience Manager e navegue até Ferramentas > Operações > Analisador de práticas recomendadas.
Clique em Gerar relatório para executar o Analisador de práticas recomendadas.
Forneça a chave de carregamento de BPA para carregar automaticamente o relatório de BPA gerado no Cloud Acceleration Manager (CAM). Para obter a chave de carregamento, navegue até a Análise de práticas recomendadas no CAM

NOTE

Você tem a opção de ignorar o carregamento automático para o CAM selecionando Ignorar carregamento automático do relatório para o CAM. Se você optar por ignorar, será necessário baixar manualmente o relatório do BPA como um arquivo de valor separado por vírgulas e, em seguida, fazer upload do arquivo no CAM. É recomendável usar a opção de chave de upload, pois ela simplifica a operação.

O botão Gerar fica ativo quando uma chave válida é fornecida. Clique em Gerar para iniciar a geração do relatório.
Enquanto o BPA está gerando o relatório, você pode ver o progresso feito pela ferramenta na tela. Ele exibe o progresso em termos de porcentagem concluída. Ele também exibe o número de itens analisados e o número de descobertas encontradas.

NOTE

O carimbo de data e hora de expiração da chave de upload do BPA é exibido no canto superior direito. Você deve renovar a chave de upload do BPA quando estiver próxima de sua expiração. Para renovar a chave, você pode clicar em Renovar para navegar até o CAM para renovar a chave.

Depois que o relatório do BPA é gerado, ele exibe um resumo e o número de conclusões em um formato tabular organizado pelo tipo de descoberta e o nível de importância. Para obter mais detalhes sobre uma descoberta específica, você pode clicar no número que corresponde ao tipo de descoberta na tabela.
Você tem a opção de baixar o relatório em um formato CSV (valores separados por vírgula) clicando em Exportar para CSV. Você também tem a opção de exibir o relatório no CAM clicando em Ir para o CAM. Você será direcionado à página Análise de Práticas Recomendadas no CAM.

Você pode forçar o BPA a limpar seu cache e gerar novamente o relatório clicando em Atualizar Relatório.

Atualizar relatório

Se o cache expirar, você terá a opção de visualizar o último relatório gerado no CAM clicando em Exibir o último relatório gerado no CAM ou iniciar uma nova geração de relatórios clicando em Gerar novo relatório.

Nenhum relatório

Utilização de filtros no relatório do Analisador de práticas recomendadas bpa-filters

Para filtrar os achados relacionados ao ACS Commons, siga as etapas abaixo:

Clique no ícone do painel à esquerda no lado esquerdo da página. Isso exibirá o Filtro ACS Commons. Clique no Filtro ACS Commons para exibir a caixa de seleção interativa como mostrado na imagem abaixo.

Filtro ACS Commons

note note
NOTE
O ícone do painel esquerdo será exibido somente se o BPA detectar o uso do ACS Commons.

Desmarque a caixa para filtrar todos os achados relacionados ao ACS Commons. Você deve ver uma Contagem de Achados Filtrados no relatório, como mostrado na imagem abaixo. O filtro também é aplicado ao relatório quando ele é exportado em um formato CSV (valores separados por vírgula).

Contagem de Achados Filtrados

note note
NOTE
As conclusões do ACS Commons não devem ser ignoradas. Consulte a documentação para determinar a compatibilidade com o AEM as a Cloud Service.

Interpretação do relatório do analisador de práticas recomendadas cra-report

Quando a ferramenta Analisador de práticas recomendadas é executada na instância do AEM, o relatório é exibido como resultado na janela da ferramenta.

O formato do relatório é:

Visão geral do relatório: informações sobre o relatório propriamente dito, que incluem as seguintes informações:
- Hora do relatório: quando o conteúdo do relatório foi gerado e disponibilizado pela primeira vez.
- Hora de expiração: quando o cache do conteúdo do relatório expirará.
- Período de geração: o tempo gasto pelo processo de geração de conteúdo do relatório.
- Contagem de conclusões: o número total de conclusões incluídas no relatório.
Visão geral do sistema: informações sobre o sistema AEM no qual o BPA foi executado.
Categorias de conclusão: várias seções que abordam uma ou mais conclusões da mesma categoria. Cada seção inclui o seguinte: nome da categoria, subtipos, contagem e importância das conclusões, resumo, link para a documentação da categoria e informações de conclusões individuais.

Um nível de importância é atribuído a cada conclusão para indicar uma prioridade aproximada de ação.

NOTE

Para saber mais sobre cada Categoria de Achados, consulte Categorias do Detector de Padrões.

Siga a tabela abaixo para entender os níveis de importância:

Importância

Descrição

INFO

Essa conclusão é fornecida para fins informativos.

CONSULTIVO

Essa conclusão pode ser um problema de atualização. Recomenda-se uma investigação mais aprofundada.

IMPORTANTE

Essa conclusão provavelmente será um problema de atualização que deve ser resolvido.

CRÍTICO

Essa conclusão provavelmente será um problema de atualização que deve ser resolvido para evitar a perda de função ou do desempenho.

Interpretação do relatório CSV do Analisador de práticas recomendadas cra-csv-report

Quando você clica na opção CSV da sua instância do AEM, o formato CSV do relatório do Analisador de práticas recomendadas é criado a partir do cache de conteúdo e retornado ao seu navegador. Dependendo das configurações do navegador, esse relatório é baixado automaticamente como um arquivo com o nome padrão de results.csv.

Se o cache tiver expirado, o relatório será gerado novamente antes que o arquivo CSV seja criado e baixado.

O formato CSV do relatório inclui informações geradas a partir da saída do Detector de padrões, classificadas e organizadas por tipo de categoria, subtipo e nível de importância. Seu formato é adequado para exibição e edição em um aplicativo como o Microsoft Excel. O objetivo é fornecer todas as informações de conclusão em um formato repetível, que pode ser útil na comparação de relatórios ao longo do tempo para medir o progresso.

As colunas do relatório em formato CSV são:

code: o código da categoria
type: o nome da categoria
subtype: o subtipo da categoria
importance: o nível de importância
identifier: o identificador principal da conclusão
other: informações adicionais sobre a conclusão
message: a mensagem fornecida para a conclusão
moreInfo: um link que pode ser usado para acessar a ajuda online sobre a categoria
context: uma cadeia JSON de dados de conclusões

O valor "\N" em uma coluna para uma conclusão individual indica que nenhum dado foi fornecido.

Interface HTTP http-interface

O BPA fornece uma interface HTTP que pode ser usada como alternativa à interface do usuário no AEM. A interface oferece suporte a comandos HEAD e GET. Ela pode ser usada para gerar o relatório do BPA e retorná-lo em um dos três formatos: JSON, CSV e valores separados por tabulação (TSV).

As seguintes URLs estão disponíveis para acesso HTTP, em que <host> é o nome do host e da porta, se necessário, do servidor no qual o BPA está instalado:

http://<host>/apps/best-practices-analyzer/analysis/report.json para formato JSON
http://<host>/apps/best-practices-analyzer/analysis/report.csv para formato CSV
http://<host>/apps/best-practices-analyzer/analysis/report.tsv para formato TSV

Execução de uma solicitação HTTP executing-http-request

A interface HTTP pode ser usada em diversos métodos.

Uma maneira simples é abrir uma guia do navegador no mesmo navegador no qual você já fez logon no AEM como administrador. Você pode digitar o URL na guia do navegador e fazer com que os resultados sejam exibidos ou baixados pelo navegador.

Você também pode usar uma ferramenta de linha de comando como curl ou wget e qualquer aplicativo cliente HTTP. Quando não estiver usando uma guia do navegador com uma sessão autenticada, você deve fornecer um nome de usuário administrativo e uma senha como parte do comentário.

Este é um exemplo de como isso pode ser feito:
curl -u admin:admin 'http://localhost:4502/apps/best-practices-analyzer/analysis/report.csv' > report.csv.

Cabeçalhos e parâmetros http-headers-and-parameters

Os seguintes cabeçalhos HTTP são usados por essa interface:

Cache-Control: max-age=<seconds>: especifica o tempo de vida da atualização do cache em segundos. (Consulte RFC 7234.)
Prefer: respond-async: especifica que o servidor deve responder de forma assíncrona. (Consulte RFC 7240.)
Prefer: return=minimal: especifica que o servidor deve retornar uma resposta mínima. (Consulte RFC 7240.)

Os seguintes parâmetros de consulta HTTP estão disponíveis como conveniência para quando cabeçalhos HTTP não puderem ser usados com facilidade:

max-age (número, opcional): especifica o tempo de vida da atualização do cache em segundos. Esse número deve ser 0 ou maior. O tempo de vida da atualização padrão é de 86.400 segundos. Sem esse parâmetro ou o cabeçalho correspondente, um novo cache é usado para atender a solicitações por 24 horas, momento em que o cache deve ser regenerado. O uso de max-age=0 forçará a limpeza do cache e iniciará uma regeneração do relatório, usando o tempo de vida de atualização diferente de zero anterior para o cache recém-gerado.
respond-async (booleano, opcional): especifica que a resposta deve ser fornecida de forma assíncrona. Usar respond-async=true quando o cache estiver obsoleto fará com que o servidor retorne uma resposta de 202 Accepted sem esperar a atualização do cache e a geração do relatório. Se o cache estiver atualizado, esse parâmetro não terá efeito. O valor padrão é false. Sem esse parâmetro ou o cabeçalho correspondente, o servidor responderá de forma síncrona, o que pode exigir uma quantidade significativa de tempo e um ajuste ao tempo máximo de resposta do cliente HTTP.
may-refresh-cache (booleano, opcional): especifica que o servidor pode atualizar o cache em resposta a uma solicitação se o cache atual estiver vazio, obsoleto ou prestes a ser obsoleto. Se may-refresh-cache=true ou se não for especificado, o servidor poderá iniciar uma tarefa em segundo plano que chamará o Detector de Padrões e atualizará o cache. Se may-refresh-cache=false, o servidor não iniciará nenhuma tarefa de atualização que teria sido realizada se o cache estivesse vazio ou obsoleto, caso em que o relatório está vazio. Qualquer tarefa de atualização que já esteja em andamento não será afetada por esse parâmetro.
return-minimal (booleano, opcional): especifica que a resposta do servidor deve incluir apenas o status contendo a indicação de progresso e o status do cache no formato JSON. Se return-minimal=true, o corpo da resposta será limitado ao objeto de status. Se return-minimal=false ou se não for especificado, uma resposta completa será fornecida.
log-findings (booleano, opcional): especifica que o servidor deve registrar o conteúdo do cache quando ele é compilado ou atualizado pela primeira vez. Cada descoberta do cache é registrada como uma cadeia de caracteres JSON. Este log só ocorrerá se log-findings=true e a solicitação gerarem um novo cache.

Quando um cabeçalho HTTP e um parâmetro de consulta correspondente estiverem presentes, o parâmetro de consulta terá prioridade.

Uma maneira simples de iniciar a geração do relatório por meio da interface HTTP é com o seguinte comando:
curl -u admin:admin 'http://localhost:4502/apps/best-practices-analyzer/analysis/report.json?max-age=0&respond-async=true'.

Depois que uma solicitação é feita, o cliente não precisa permanecer ativo para que o relatório seja gerado. A geração de relatórios pode ser iniciada com um cliente usando uma solicitação HTTP GET e, uma vez gerado o relatório, visualizada do cache com outro cliente ou com a ferramenta BPA na interface do usuário AEM.

Respostas http-responses

Os seguintes valores de resposta são possíveis:

200 OK: indica que a resposta contém conclusões do Detector de Padrões que foram geradas dentro do tempo de vida da atualização do cache.
202 Accepted: usado para indicar que o cache está obsoleto. Quando respond-async=true e may-refresh-cache=true esta resposta indica que uma tarefa de atualização está em andamento. Quando may-refresh-cache=false esta resposta simplesmente indica que o cache está obsoleto.
400 Bad Request: indica que houve um erro com a solicitação. Uma mensagem no formato de Detalhes do Problema (consulte RFC 7807) fornece mais detalhes.
401 Unauthorized: indica que a solicitação não foi autorizada.
500 Internal Server Error: indica que ocorreu um erro de servidor interno. Uma mensagem no formato de Detalhes do problema fornece mais detalhes.
503 Service Unavailable: indica que o servidor está ocupado com outra resposta e não pode atender a essa solicitação em tempo hábil. Isso só pode ocorrer quando forem feitas solicitações síncronas. Uma mensagem no formato de Detalhes do problema fornece mais detalhes.

Informações do administrador

Ajuste da Duração do Cache cache-adjustment

O tempo de vida padrão do cache do BPA é de 24 horas. Com a opção de atualizar um relatório e regenerar o cache, tanto na instância AEM quanto na interface HTTP, esse valor padrão provavelmente será apropriado para a maioria dos usos do BPA. Se o tempo de geração do relatório for particularmente longo para a instância AEM, talvez você queira ajustar o tempo de vida do cache para minimizar a regeneração do relatório.

O valor vitalício do cache é armazenado como a propriedade maxCacheAge no seguinte nó do repositório:
/apps/best-practices-analyzer/content/BestPracticesReport/jcr:content

O valor dessa propriedade é o tempo de vida do cache em segundos. Um administrador pode ajustar a duração do cache usando o CRX/DE Lite.

Instalação no AEM 6.1 installing-on-aem61

O BPA usa uma conta de usuário do serviço do sistema chamada repository-reader-service para executar o Detector de Padrões. Essa conta está disponível no AEM 6.2 e nas versões posteriores. No AEM 6.1, essa conta deve ser criada antes da instalação do BPA, executando as seguintes etapas:

Siga as instruções em Criar um novo usuário de serviço para criar um usuário. Defina a UserID como repository-reader-service, deixe o Caminho intermediário vazio e clique na marca de seleção verde.
Siga as instruções em Gerenciar usuários e grupos, especificamente as instruções para adicionar usuários a um grupo, para adicionar o usuário repository-reader-service ao grupo administrators.
Instale o pacote BPA por meio do Gerenciador de pacotes na instância AEM de origem. (Essa etapa adiciona a alteração de configuração necessária à configuração ServiceUserMapper do usuário de serviço do sistema repository-reader-service.)

recommendation-more-help

fbcff2a9-b6fe-4574-b04a-21e75df764ab