Relatório

Para ajudar você a monitorar e analisar o estado da sua instância, o AEM fornece uma seleção de relatórios padrão, que podem ser configurados para seus requisitos individuais:

OBSERVAÇÃO

Esses relatórios só estão disponíveis na interface do usuário clássica. Para monitoramento e relatórios do sistema na interface do usuário moderna, consulte o Painel de Operações.

Todos os relatórios podem ser acessados no console Ferramentas. Selecione Reports no painel esquerdo e clique duas vezes no relatório necessário no painel direito para abri-lo para exibição e/ou configuração.

Novas instâncias de um relatório também podem ser criadas no console Ferramentas. Selecione Relatórios no painel esquerdo e, em seguida, Novo… na barra de ferramentas. Defina um Título e Nome, selecione o tipo de relatório necessário e clique em Criar. A nova instância do relatório será exibida na lista. Clique duas vezes para abrir e arraste um componente do sidekick para criar a primeira coluna e iniciar a definição do relatório.

OBSERVAÇÃO

Além dos relatórios de AEM padrão que estão disponíveis imediatamente, você pode desenvolver seus próprios relatórios (completamente novos).

As noções básicas da personalização de relatórios

Há vários formatos de relatórios disponíveis. Os relatórios a seguir usam colunas que podem ser personalizadas conforme detalhado nas seguintes seções:

OBSERVAÇÃO

Os relatórios a seguir têm seu próprio formato e personalização:

  • As Verificações de Integridade usam campos de seleção para especificar os dados nos quais você deseja criar relatórios.
  • O Uso de disco usa links para detalhar a estrutura do repositório.
  • O relatório Workflow fornece uma visão geral dos workflows em execução na sua instância.

Portanto, os seguintes procedimentos para a configuração da coluna não são apropriados. Consulte as descrições dos relatórios individuais para obter seus detalhes.

Selecionar e posicionar as colunas de dados

As colunas podem ser adicionadas, reposicionadas ou removidas de qualquer relatório, padrão ou personalizado.

A guia Components do sidekick (disponível na página do relatório) lista todas as categorias de dados que podem ser selecionados como colunas.

Para alterar a seleção de dados:

  • para adicionar uma nova coluna, arraste o componente desejado do sidekick e solte na posição desejada

    • uma marca de verificação verde indica quando a posição é válida e um par de setas indicará exatamente onde será colocada
    • um símbolo vermelho sem movimento indicará quando a posição for inválida
  • para mover uma coluna, clique no cabeçalho, segure e arraste para a nova posição

  • para remover uma coluna, clique no título da coluna, arraste e solte na área do cabeçalho do relatório (um símbolo vermelho de menos indicará que a posição não é válida); solte o botão do mouse e a caixa de diálogo Excluir componentes solicitará a confirmação de que você realmente deseja excluir a coluna.

Menu suspenso de coluna

Cada coluna no relatório tem um menu suspenso. Isso se torna visível quando o cursor do mouse se move sobre a célula do título da coluna.

Uma cabeça de seta aparecerá na extremidade direita da célula de título (não confundir com a cabeça de seta imediatamente à direita do texto do título que indica o mecanismo de classificação atual).

reportcolumnsort

As opções disponíveis no menu dependerão da configuração da coluna (conforme feita durante o desenvolvimento do projeto), quaisquer opções inválidas serão esmaecidas.

Classificação dos dados

Os dados podem ser classificados de acordo com uma coluna específica por:

  • clicar no cabeçalho da coluna apropriado; a classificação alternará entre ascendente e descendente, indicado por uma cabeça de seta imediatamente ao lado do texto do título
  • use o menu suspenso coluna para selecionar especificamente Classificar crescente ou Classificar decrescente; novamente, isso será indicado por uma seta imediatamente ao lado do texto do título

Grupos e o Gráfico de dados atual

Em colunas apropriadas, você pode selecionar Group by this column no menu suspenso column. Isso agrupará os dados de acordo com cada valor distinto dentro dessa coluna. É possível selecionar mais de uma coluna para ser agrupada. A opção ficará esmaecida quando os dados na coluna forem inadequados; ou seja, cada entrada é distinta e exclusiva para que nenhum grupo possa ser formado, por exemplo, a coluna ID de usuário do relatório de usuário.

Após pelo menos uma coluna ter sido agrupada, um gráfico de pizza de Current data será gerado, com base nesse agrupamento. Se várias colunas forem agrupadas, isso também será indicado no gráfico.

reportuser

Mover o cursor sobre o gráfico de pizza mostrará o valor agregado do segmento apropriado. Usa a agregação atualmente definida para a coluna; por exemplo, contagem, mínimo, média, entre outras.

Filtros e agregados

Em colunas apropriadas, você também pode configurar Filtrar configurações e/ou Agregações no menu suspenso da coluna.

Filtros

As Configurações de filtro permitem que você especifique os critérios para as entradas a serem exibidas. Os operadores disponíveis são:

  • contains
  • equals

reportfilter

Para definir um filtro:

  1. Selecione o operador desejado na lista suspensa.
  2. Insira o texto a ser filtrado.
  3. Clique em Aplicar.

Para desativar o filtro:

  1. Remova o texto do filtro.
  2. Clique em Aplicar.

Agregados

Você também pode selecionar um método de agregação (eles podem variar dependendo da coluna selecionada):

reportaggregate

Propriedades da coluna

Essa opção só estará disponível quando a Generic column tiver sido usada no Relatório de usuário.

Dados históricos

Um gráfico da alteração em seus dados ao longo do tempo pode ser visto em Historic data. Isso é derivado de instantâneos tirados em intervalos regulares.

Os dados são:

  • Coletada por, se disponível, a primeira coluna classificada, caso contrário, a primeira coluna (não agrupada)
  • Agrupado pela coluna apropriada

O relatório pode ser gerado:

  1. Defina Grouping na coluna desejada.

  2. ​Edite a configuração para definir a frequência com que os instantâneos devem ser feitos; por hora ou por dia.

  3. Concluir… a definição para iniciar a coleção de instantâneos.

    O botão deslizante vermelho/verde na parte superior esquerda indica quando os instantâneos estão sendo coletados.

O gráfico resultante é mostrado na parte inferior direita:

relatórios

Depois de iniciar a coleta de dados, você pode selecionar:

  • Período

    É possível selecionar datas de e para os dados do relatório a serem exibidos.

  • Intervalo

    Mês, Semana, Dia, Hora pode ser selecionado para a escala e agregação do relatório.

    Por exemplo, se os instantâneos diários estiverem disponíveis para fevereiro de 2011:

    • Se o intervalo estiver definido como Day, cada instantâneo será mostrado como um único valor no gráfico.
    • Se o intervalo estiver definido como Month, todos os instantâneos de fevereiro serão agregados em um único valor (exibido como um único "ponto" no gráfico).

Selecione seus requisitos e clique em Ir para aplicá-los ao relatório. Para atualizar a exibição depois que novos instantâneos tiverem sido feitos, clique em Go novamente.

chlimage_1-43

Quando os instantâneos estão sendo coletados, você pode:

  • Usar Concluir… novamente para reinicializar a coleção.

    Concluir "congela" a estrutura do relatório (ou seja, as colunas atribuídas ao relatório e que são agrupadas, classificadas, filtradas, etc.) e começa a tirar instantâneos.

  • Abra a caixa de diálogo Edit para selecionar No data snapshots para encerrar a coleta até necessário.

    ​A edição apenas altera ou desativa a captura de instantâneos. Se os instantâneos forem ativados novamente, ele usará o estado do relatório quando foi concluído pela última vez para obter mais instantâneos.

OBSERVAÇÃO

Os instantâneos são armazenados em /var/reports/..., onde o restante do caminho espelha o caminho do respectivo relatório e ID criada quando o relatório foi concluído.

Instantâneos antigos podem ser removidos manualmente, se você tiver certeza absoluta de que não precisa mais dessas instâncias.

OBSERVAÇÃO

Os relatórios pré-configurados não exigem muito desempenho, mas ainda é recomendável usar instantâneos diários em um ambiente de produção. Se possível, execute esses instantâneos diários em um momento do dia em que não há muita atividade em seu site; isso pode ser definido com o parâmetro Daily snapshots (repconf.hourofday) para Day CQ Reporting Configuration; consulte Configuração OSGI para obter mais detalhes sobre como configurar isso.

Limites de exibição

O relatório de dados históricos também pode mudar um pouco na aparência devido a limites que podem ser definidos, de acordo com o número de resultados do período selecionado.

Cada linha horizontal é conhecida como uma série (e corresponde a uma entrada na legenda do gráfico), cada coluna vertical de pontos representa os instantâneos agregados.

chlimage_1-44

Para manter o gráfico limpo por períodos de tempo maiores, há limites que podem ser definidos. Para os relatórios padrão, são:

  • série horizontal - o padrão e o máximo do sistema são 9

  • instantâneos agregados verticais - o padrão é 35 (por série horizontal)

Assim, quando os limites (adequados) forem excedidos, o:

  • os pontos não serão exibidos
  • a legenda do gráfico de dados históricos pode mostrar um número diferente de entradas em relação ao do gráfico de dados atual

chlimage_1-45

Relatórios personalizados também podem mostrar o valor Total para todas as séries. Isso é mostrado como uma série (linha horizontal e entrada na legenda).

OBSERVAÇÃO

Para relatórios personalizados, os limites podem ser definidos de forma diferente.

Editar (Relatório)

O botão Editar abre a caixa de diálogo Editar relatório.

Este é um local onde o período para a coleta de instantâneos para Dados históricos é definido, mas várias outras configurações também podem ser definidas:

reportedit

  • Título

    Você pode definir seu próprio título.

  • Descrição

    Você pode definir sua própria descrição.

  • Caminho raiz (ativo apenas para determinados relatórios)

    Use isso para limitar o relatório a uma (sub) seção do repositório.

  • Processamento de relatório

    • atualização automática de dados

      Os dados do relatório serão atualizados toda vez que você atualizar a definição do relatório.

    • atualizar dados manualmente

      Essa opção pode ser usada para evitar atrasos causados por operações automáticas de atualização quando há um grande volume de dados.

      Selecionar isso indica que os dados do relatório devem ser atualizados manualmente quando qualquer aspecto da configuração do relatório for alterado. Isso também significa que, assim que você alterar qualquer aspecto da configuração, a tabela do relatório ficará em branco.

      Quando isso for selecionado, o botão Load data será exibido (ao lado de Edit no relatório). O carregamento de dados carregará os dados e atualizará os dados do relatório mostrados.


  • SnapshotsVocê pode definir a frequência com que os snapshots devem ser feitos; diariamente, a cada hora ou não.

Carregar dados

O botão Carregar dados só é visível quando atualizar dados manualmente foi selecionado em Editar.

chlimage_1-46

Clicar em Load data recarregará os dados e atualizará o relatório que está sendo exibido.

Selecionar para atualizar dados manualmente significa que:

  1. Assim que você alterar a configuração do relatório, a tabela de dados do relatório ficará em branco.

    Por exemplo, se você alterar o mecanismo de classificação de uma coluna, os dados não serão exibidos.

  2. Se desejar que os dados do relatório sejam exibidos novamente, será necessário clicar em Load data para recarregar os dados.

Finalizar (relatório)

Quando você Finalizar o relatório:

  • A definição de relatório a partir desse ponto no tempo será usada para obter os instantâneos (depois você pode continuar trabalhando em uma definição de relatório, pois é separada dos instantâneos).
  • Quaisquer instantâneos existentes serão removidos.
  • Novos instantâneos são coletados para os Dados históricos.

Com essa caixa de diálogo, você pode definir ou atualizar seu próprio título e descrição para o relatório resultante.

relatório

Tipos de relatórios

Relatório de componentes

O relatório de componente fornece informações sobre como o site usa os componentes do .

Colunas de informações sobre:

  • Autor
  • Caminho do componente
  • Tipo de componente
  • Última modificação
  • Página

Isso significa que você pode ver, por exemplo:

  • Quais componentes são usados onde.

    Útil, por exemplo, ao testar.

  • Como as instâncias de um componente específico são distribuídas.

    Isso pode ser interessante se páginas específicas (ou seja, "páginas pesadas") apresentam problemas de desempenho.

  • Identificar partes do site com alterações frequentes/menos frequentes.

  • Veja como o conteúdo da página se desenvolve ao longo do tempo.

Todos os componentes estão incluídos, padrão do produto e específico do projeto. Usando a caixa de diálogo Edit, o usuário também pode definir um Root path que define o ponto de partida do relatório - todos os componentes sob essa raiz são considerados para o relatório.

reportcomponentreportcomentall

Uso do disco

O relatório de uso do disco mostra informações sobre os dados armazenados em seu repositório.

O relatório é iniciado na raiz ( / ) do repositório; ao clicar em uma ramificação específica, você pode fazer drill-down dentro do repositório (o caminho atual será refletido no título do relatório).

reportdiskusage

Verificação de integridade

Este relatório analisa o log de solicitação atual:

<cq-installation-dir>/crx-quickstart/logs/request.log
para ajudá-lo a identificar as solicitações mais caras em um determinado período.

Para gerar o relatório, você pode especificar:

  • Período (horas)

    O número de horas (passadas) a serem analisadas.

    Padrão: 24

  • max. Resultados

    Número máximo de linhas de saída.

    Padrão: 50

  • máx. Solicitações

    Número máximo de solicitações a serem analisadas.

    Padrão: -1 (todos)

  • Endereço de e-mail

    Envie os resultados para um endereço de email.

    Facultativo; Padrão: blank

  • Executar diariamente às (hh:mm)

    Especifique um horário para a execução automática do relatório diariamente.

    Facultativo; Padrão: blank

repórter

Relatório de atividades de página

O relatório de atividade da página lista as páginas e as ações realizadas neles.

Colunas de informações sobre:

  • Página
  • Hora
  • Tipo
  • Usuário

Isso significa que você pode monitorar:

  • As modificações mais recentes.
  • Autores que trabalham em páginas específicas.
  • As páginas que não foram modificadas recentemente, por isso podem precisar de ação.
  • Páginas que são alteradas com mais/menos frequência.
  • Usuários mais / menos ativos.

O relatório de atividade da página pega todas as informações do log de auditoria. Por padrão, o caminho raiz é configurado para o log de auditoria em /var/audit/com.day.cq.wcm.core.page.

reportpageactivity

Relatório de conteúdo gerado pelo usuário

Este relatório fornece informações sobre o conteúdo gerado pelo usuário; sejam comentários, classificações ou fóruns.

Colunas de informações:

  • Data
  • Endereço IP
  • Página
  • Referenciador
  • Tipo
  • Identificador do usuário

Permitir:

  • Veja quais páginas estão recebendo mais comentários.
  • Obtenha uma visão geral de todos os comentários que visitantes específicos do site estão deixando, talvez os problemas estejam relacionados.
  • Verifique se o novo conteúdo está provocando comentários monitorando quando comentários são feitos em uma página.

reportusercontent

Relatório do usuário

Este relatório fornece informações sobre todos os usuários que registraram uma conta e/ou perfil; isso pode incluir autores em sua organização e visitantes externos.

Colunas de informações (se disponíveis) sobre:

  • Idade
  • País
  • Domínio
  • E-mail
  • Nome da família
  • Sexo
  • Genérico
  • Nome
  • Informações
  • Interesse
  • Idioma
  • Hashcode NTLM
  • ID de usuário

Permitir:

  • Veja a distribuição demográfica de seus usuários.
  • Relate os campos personalizados que você adicionou aos perfis.

reportusercanned

Coluna Genérica

A coluna Genérica está disponível no Relatório do Usuário para que você possa acessar informações personalizadas, geralmente nos perfis do usuário; por exemplo, Cor favorita conforme detalhado em Adicionar campos à definição do perfil.

A caixa de diálogo da coluna Genérica será aberta quando você:

  • Arraste o componente Genérico do sidekick para o relatório.
  • Selecione as Propriedades da coluna para uma coluna Genérica existente.

reportusrgenericcolm

Na guia Definições, é possível definir:

  • Título

    Seu próprio título para a coluna genérica.

  • Propriedade

    O nome da propriedade como armazenado no repositório, normalmente no perfil do usuário.

  • Caminho

    Geralmente, a propriedade é retirada do profile.

  • Tipo

    Selecione o tipo de campo de String, Number, Integer, Date.

  • Agregação padrão

    Isso define a agregação usada por padrão se a coluna for desagrupada em um relatório com pelo menos uma coluna agrupada. Selecione a agregação necessária de Count, Minimum, Average, Maximum, Sum.

    Por exemplo, Count para um campo String significa que o número de valores String distintos é exibido para a coluna no estado agregado.

Na guia Extended você também pode definir as agregações e filtros disponíveis:

reportusrgenericcolmextented

Relatório de instâncias do fluxo de trabalho

Isso oferece uma visão geral concisa, fornecendo informações sobre as instâncias individuais de workflows, em execução e concluídos.

Colunas de informações sobre:

  • Concluído
  • Duração
  • Iniciador
  • Modelo
  • Carga
  • Iniciado
  • Status

Isso significa que você pode:

  • Monitorar a duração média dos fluxos de trabalho; se isso acontecer regularmente, é possível destacar problemas com o workflow .

reportworkflowintance

Relatório de fluxo de trabalho

Isso fornece estatísticas importantes sobre os workflows em execução na sua instância.

reportworkflow

Uso de relatórios em um ambiente de publicação

Depois de configurar os relatórios para seus requisitos específicos, você pode ativá-los para transferir a configuração para o ambiente de publicação.

CUIDADO

Se desejar Dados históricos para o ambiente de publicação, em seguida, Conclua o relatório sobre o ambiente do autor antes de ativar a página.

O relatório adequado será então acessível em

/etc/reports

Por exemplo, o relatório Conteúdo gerado pelo usuário pode ser encontrado em:

http://localhost:4503/etc/reports/ugcreport.html

Isso agora relatará os dados coletados do ambiente de publicação.

Como nenhuma configuração de relatório é permitida no ambiente de publicação, os botões Edit e Finish não estão disponíveis. No entanto, você pode selecionar o Period e Interval para os relatórios Historic data se os instantâneos estiverem sendo coletados.

reportsucgpublish

CUIDADO

O acesso a estes relatórios pode constituir uma questão de segurança; portanto, recomendamos configurar o Dispatcher para que /etc/reports não esteja disponível para visitantes externos. Consulte a Lista de verificação de segurança para obter mais detalhes.

Permissões necessárias para executar relatórios

As permissões necessárias dependem da ação:

  • Os dados do relatório são basicamente coletados usando os privilégios do usuário atual.
  • Os dados históricos são coletados usando os privilégios do usuário que concluiu o relatório.

Em uma instalação padrão do AEM, as seguintes permissões são predefinidas para os relatórios:

  • Relatório do usuário

    user administrators - ler e escrever

  • Relatório de atividades de página

    contributors - ler e escrever

  • Relatório de componentes

    contributors - ler e escrever

  • Relatório de conteúdo gerado pelo usuário

    contributors - ler e escrever

  • Relatório de instâncias do fluxo de trabalho

    workflow-users - ler e escrever

Todos os membros do grupo administrators têm os direitos necessários para criar novos relatórios.

Nesta página