Siga a seção abaixo para entender as considerações importantes para executar o BPA (Best Practices Analyzer):
O relatório BPA é criado usando a saída do Adobe Experience Manager (AEM) Detector de padrão. A versão do Detector de padrão usada pelo BPA está incluída no pacote de instalação do BPA.
O BPA só pode ser executado pelo usuário admin ou por um usuário no grupo administradores.
O BPA é suportado em instâncias AEM com a versão 6.1 e superior.
Consulte Instalação no AEM 6.1 para obter os requisitos especiais para instalação do BPA no AEM 6.1.
O BPA pode ser executado em qualquer ambiente, mas é preferível executá-lo em um ambiente Stage.
Para evitar um impacto em instâncias críticas para os negócios, é recomendável executar o BPA em um ambiente **Authenvironment o mais próximo possível do ambiente de ** produção nas áreas de personalizações, configurações, conteúdo e aplicativos do usuário. 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 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.
O Analisador de práticas recomendadas pode ser baixado como um arquivo zip do portal de distribuição de software. Você pode instalar o pacote por meio do Gerenciador de pacotes na sua instância de origem do Adobe Experience Manager (AEM).
Baixe o Analisador de práticas recomendadas do portal de distribuição de software.
Siga esta seção para saber como visualização o relatório Analisador de práticas recomendadas:
Selecione Adobe Experience Manager e navegue até tools -> Operations -> Best Practices Analyzer.
Clique em Gerar relatório para executar o Analisador de práticas recomendadas.
Enquanto o BPA está gerando o relatório, você pode ver o progresso feito pela ferramenta na tela. Exibe o número de itens analisados e também o número de descobertas encontradas.
Depois que o relatório BPA é gerado, ele exibe um resumo e o número de conclusões em um formato de tabela organizado pelo tipo de descoberta e o nível de importância. Para obter mais detalhes sobre uma determinada descoberta, clique no número que corresponde ao tipo de descoberta na tabela.
A ação acima percorrerá automaticamente o local da descoberta no relatório.
Você tem a opção de baixar o relatório em um formato CSV (valores separados por vírgula) clicando em CSV, como mostrado na figura abaixo.
Você pode forçar o BPA a limpar seu cache e gerar novamente o relatório clicando em Atualizar relatório.
Enquanto o relatório está sendo regenerado, ele exibe o progresso em termos de porcentagem concluída, como mostrado na imagem abaixo.
A ferramenta Analisador de práticas recomendadas está limitada no Adobe Experience Manager 6.2 a um link que gera e baixa o relatório CSV.
Para o Adobe Experience Manager 6.1, a ferramenta não é funcional e apenas a interface HTTP pode ser usada.
Em todas as versões, o Detector de padrões incluído pode ser executado independentemente.
Quando a ferramenta Analisador de práticas recomendadas é executada na instância AEM, o relatório é exibido como resultados na janela da ferramenta.
O formato do relatório é:
Um nível de importância é atribuído a cada conclusão para indicar uma prioridade aproximada de ação.
Para saber mais sobre cada Categoria de descoberta, 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. |
Quando você clica na opção CSV de sua instância AEM, o formato CSV do relatório 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 será 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:
O valor "\N" em uma coluna para uma conclusão individual indica que nenhum dado foi fornecido.
O BPA fornece uma interface HTTP que pode ser usada como uma alternativa à interface do usuário no AEM. A interface oferece suporte a comandos HEAD e GET. Ele pode ser usado para gerar o relatório BPA e retorná-lo em um dos três formatos: JSON, CSV e valores separados por tabulação (TSV).
Os seguintes URLs estão disponíveis para acesso HTTP, onde <host>
é o nome do host e, se necessário, a porta do servidor no qual o BPA está instalado:
http://<host>/apps/best-practices-analyzer/analysis/report.json
para formato JSONhttp://<host>/apps/best-practices-analyzer/analysis/report.csv
para formato CSVhttp://<host>/apps/best-practices-analyzer/analysis/report.tsv
para formato TSVA 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
, além de 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
.
Os seguintes cabeçalhos HTTP são usados por essa interface:
Cache-Control: max-age=<seconds>
: Especifica a duração da frescura 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 a duração da frescura do cache em segundos. Esse número deve ser 0 ou maior. A duração padrão de frescura é de 86400 segundos. Sem esse parâmetro ou o cabeçalho correspondente, um novo cache será usado para atender solicitações por 24 horas, e nesse ponto o cache deverá ser regenerado. Usar max-age=0
forçará a limpeza do cache e iniciará a regeneração do relatório, usando a duração de frescura 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 aguardar 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 em breve 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, de outra forma, teria sido feita se o cache estivesse vazio ou obsoleto, caso em que o relatório estará 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 que contém 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, será fornecida uma resposta completa.log-findings
(booleano, opcional): Especifica que o servidor deve registrar o conteúdo do cache quando ele for criado ou atualizado pela primeira vez. Cada descoberta do cache será registrada como uma string JSON. Este registro só ocorrerá se log-findings=true
e a solicitação gerar 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 de GET HTTP e, depois que o relatório for gerado, visualizado do cache com outro cliente ou com a ferramenta BPA na interface do usuário AEM.
Os seguintes valores de resposta são possíveis:
200 OK
: Indica que a resposta contém descobertas do Detector de padrão que foram geradas dentro do tempo de vida útil do cache.202 Accepted
: Usado para indicar que o cache está obsoleto. Quando respond-async=true
e may-refresh-cache=true
essa resposta indica que uma tarefa de atualização está em andamento. Quando may-refresh-cache=false
essa resposta simplesmente indica que o cache está obsoleto.400 Bad Request
: indica que houve um erro com a solicitação. Uma mensagem no formato 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.A duração padrão do cache BPA é de 24 horas. Com a opção de atualizar um relatório e gerar novamente 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 sua instância do 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.
O BPA utiliza uma conta de usuário de serviço do sistema chamada repository-reader-service
para executar o Detector de padrão. 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 de do BPA, seguindo 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 via Gerenciador de pacotes na instância de 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
.)