Painel de operações

Introdução

O Painel Operations no AEM 6 ajuda os operadores do sistema a monitorar AEM integridade do sistema imediatamente. Ele também fornece informações de diagnóstico geradas automaticamente sobre aspectos relevantes da AEM e permite configurar e executar automação de manutenção autônoma para reduzir significativamente as operações do projeto e os casos de suporte. O Painel Operações pode ser estendido com verificações de integridade personalizadas e tarefas de manutenção. Além disso, os dados do Operations Painel podem ser acessados a partir de ferramentas de monitoramento externas via JMX.

O Painel de Operações:

• É um status de sistema de um clique para ajudar os departamentos de operações a aumentar a eficiência
• Fornece uma visão geral da integridade do sistema em um único local centralizado
• Reduz o tempo para localizar, analisar e corrigir problemas
• Oferece automação de manutenção independente que ajuda a reduzir significativamente os custos das operações do projeto

Ele pode ser acessado indo para Ferramentas - Operações na tela de boas-vindas AEM.

Relatórios de integridade

O sistema de Relatório de Integridade fornece informações sobre a integridade de uma instância AEM por meio de Sling Health Checks. Isso pode ser feito por meio de solicitações OSGI, JMX, HTTP (via JSON) ou pela interface de usuário de toque. Ele oferta as medições e o limite de certos contadores configuráveis e, em alguns casos, oferta informações sobre como resolver o problema.

Ele tem vários recursos, descritos abaixo.

Verificações de integridade

Os Relatórios de integridade são um sistema de cartões que indica integridade boa ou ruim em relação a uma área específica do produto. Esses cartões são visualizações das Sling Health Checks, que agregação dados do JMX e de outras fontes e expõe as informações processadas novamente como MBeans. Esses MBeans também podem ser inspecionados no console da Web JMX, sob o domínio org.apache.sling.saudcheck.

A interface de Relatórios de Integridade pode ser acessada por meio do menu Ferramentas - Operações - Relatórios de Integridade na tela de Boas-vindas AEM ou diretamente pelo seguinte URL:

https://<serveraddress>:port/libs/granite/operations/content/healthreports/healthreportlist.html

O sistema de cartões expõe três estados possíveis: OK, AVISO e CRÍTICO. Os estados resultam de regras e limites, que podem ser configurados passando o mouse sobre o cartão e, em seguida, clicando no ícone de engrenagem na barra de ação:

Tipos de verificação de integridade

Existem dois tipos de controlos sanitários no AEM 6:

1. Verificações de integridade individuais
2. Verificações de integridade compostas

Uma Verificação de integridade individual é uma verificação de integridade única que corresponde a um cartão de status. As Verificações de integridade individuais podem ser configuradas com regras ou limites e podem fornecer uma ou mais dicas e links para resolver problemas de integridade identificados. Vejamos a verificação "Erros de registro" como um exemplo: se houver entradas ERROR nos registros da instância, você as encontrará na página de detalhes da verificação de integridade. Na parte superior da página, você verá um link para o analisador "Mensagem de registro" na seção Ferramentas de diagnóstico, que permitirá que você analise esses erros com mais detalhes e reconfigure os registradores.

Um Composite Health Check é uma verificação que agregação informações de várias verificações individuais.

As verificações de integridade composta são configuradas com o auxílio de tags de filtro. Essencialmente, todas as verificações únicas que têm a mesma tag de filtro serão agrupadas como uma verificação de integridade composta. Uma verificação de integridade composta terá um status OK somente se todas as verificações únicas que ela agregação tiverem status OK também.

Como criar verificações de integridade

No Painel Operações, você pode visualizar o resultado de verificações de integridade individuais e compostas.

Criando uma verificação de integridade individual

A criação de uma verificação de integridade individual envolve duas etapas: implementar uma Verificação de integridade Sling e adicionar uma entrada para a Verificação de integridade nos nós de configuração do Painel.

1. Para criar uma Verificação de integridade Sling, é necessário criar um componente OSGI que implemente a interface Sling HealthCheck. Você adicionará esse componente dentro de um pacote. As propriedades do componente identificarão completamente a verificação de integridade. Quando o componente estiver instalado, um MBean JMX será criado automaticamente para a verificação de integridade. Consulte a Documentação do Sling Health Check para obter mais informações.

   Exemplo de um componente Sling Health Check, gravado com anotações do componente de serviço OSGI:

   @Component(service = HealthCheck.class,
   property = {
       HealthCheck.NAME + "=Example Check",
       HealthCheck.TAGS + "=example",
       HealthCheck.TAGS + "=test",
       HealthCheck.MBEAN_NAME + "=exampleHealthCheckMBean"
   })
    public class ExampleHealthCheck implements HealthCheck {
       @Override
       public Result execute() {
           // health check code
       }
    }
   

   OBSERVAÇÃO

   A propriedade MBEAN_NAME define o nome da mbean que será gerada para essa verificação de integridade.

2. Depois de criar uma Verificação de integridade, é necessário criar um novo nó de configuração para torná-lo acessível na interface do Painel Operações. Para esta etapa, é necessário saber o nome do JMX Mbean da verificação de integridade (a propriedade MBEAN_NAME). Para criar uma configuração para a Verificação de integridade, abra o CRXDE e adicione um novo nó (do tipo nt:unstructed) no seguinte caminho: /apps/settings/granite/operations/hc

   As seguintes propriedades devem ser definidas no novo nó:

   • Nome: sling:resourceType

     • Tipo: String
     • Valor: granite/operations/components/mbean

   • Nome: resource

     • Tipo: String
     • Valor: /system/sling/monitoring/mbeans/org/apache/sling/healthcheck/HealthCheck/exampleHealthCheck
   OBSERVAÇÃO

   O caminho do recurso acima é criado da seguinte forma: se o nome do bean da sua Verificação de integridade for "test", adicione "test" ao final do caminho /system/sling/monitoring/mbeans/org/apache/sling/healthcheck/HealthCheck

   Assim, o caminho final será:

   /system/sling/monitoring/mbeans/org/apache/sling/healthcheck/HealthCheck/test

   OBSERVAÇÃO

   Verifique se o caminho /apps/settings/granite/operations/hc tem as seguintes propriedades definidas como true:

   sling:configCollectionInherit

   sling:configPropertyInherit

   Isso instruirá o gerenciador de configuração a unir as novas configurações às existentes de /libs.

Criando uma verificação de integridade composta

A função de uma verificação de integridade composta é agregação de várias verificações de integridade individuais que compartilham um conjunto de recursos comuns. Por exemplo, o Security Composite Health Check agrupa todas as verificações de integridade individuais que realizam verificações relacionadas com a segurança. A primeira etapa para criar uma verificação composta é adicionar uma nova configuração OSGI. Para ser exibido no Painel Operações, é necessário adicionar um novo nó de configuração, da mesma forma que fizemos para uma verificação simples.

1. Vá para o Web Configuration Manager no Console OSGI. Você pode fazer isso acessando https://serveraddress:port/system/console/configMgr

2. Procure a entrada chamada Apache Sling Composite Health Check. Depois de encontrá-lo, observe que existem duas configurações disponíveis: um para as verificações do sistema e outro para as verificações de segurança.

3. Crie uma nova configuração pressionando o botão "+" no lado direito da configuração. Uma nova janela será exibida, como mostrado abaixo:

   

4. Crie uma configuração e salve-a. Uma Mbean será criada com a nova configuração.

   A finalidade de cada propriedade de configuração é a seguinte:

   • Nome (hc.name): o nome da Verificação de integridade composta. Um nome significativo é recomendado.
   • Tags (hc.tags): As tags para essa verificação de integridade. Se essa verificação de integridade composta for parte de outra verificação de integridade composta (como em uma hierarquia de verificações de integridade), adicione as tags às quais esse composto está relacionado.
   • Nome do MBean (hc.mbean.name): O nome do Mbean que será fornecido ao MBean JMX desta verificação de integridade composta.
   • Tags de filtro (filter.tags): Esta é uma propriedade específica para verificações de integridade compostas. Essas são as tags que o composto deve agregação. A verificação de integridade composta agregação em seu grupo todas as verificações de integridade que tenham qualquer tag correspondente a qualquer uma das tags de filtro desse composto. Por exemplo, uma verificação de integridade composta que tenha as tags de filtro test e check irá agregação todas as verificações de integridade individuais e compostas que tenham qualquer uma das tags test e check em suas propriedades de tags ( hc.tags).
   OBSERVAÇÃO

   Um novo JMX Mbean é criado para cada nova configuração da Verificação de integridade composta do Apache Sling.**

5. Finalmente, a entrada da verificação de integridade composta que acabou de ser criada precisa ser adicionada nos nós de configuração do Painel Operations. O procedimento para o efeito é o mesmo que para os controlos sanitários individuais: um nó do tipo nt:unstruct precisa ser criado em /apps/settings/granite/operations/hc. A propriedade resource do nó será definida pelo valor de hc.medium.name na configuração OSGI.

   Se, por exemplo, você tiver criado uma configuração e definir o valor hc.mbean.name como diskusage, os nós de configuração terão a seguinte aparência:

   • Nome: Composite Health Check

     • Tipo: nt:unstructured

   Com as seguintes propriedades:

   • Nome: sling:resourceType

     • Tipo: String
     • Valor: granite/operations/components/mbean

   • Nome: resource

     • Tipo: String
     • Valor: /system/sling/monitoring/mbeans/org/apache/sling/healthcheck/HealthCheck/diskusage
   OBSERVAÇÃO

   Se você criar verificações de integridade individuais que pertencem logicamente a uma verificação composta que já está presente no Painel por padrão, elas serão automaticamente capturadas e agrupadas sob a respectiva verificação composta. Por isso, não há necessidade de criar um novo nó de configuração para essas verificações.

   Por exemplo, se você criar uma verificação de integridade de segurança individual, tudo o que precisa fazer é atribuir a ela a tag "security" e ela estiver instalada, ela aparecerá automaticamente sob a verificação composta de Verificações de segurança no Painel Operações.

Verificações de integridade fornecidas com AEM

Nome da verificação completa	Descrição
Desempenho da consulta	Essa verificação de integridade foi simplificada no AEM 6.4 e agora verifica o MBean Oak QueryStats recém-refatorado, mais especificamente o atributo SlowQueries . Se as estatísticas contiverem query lentos, a verificação de integridade retornará um aviso. Caso contrário, retornará o status OK. O MBean para esta verificação de integridade é org.apache.sling.saudcheck:name=queriesStatus,type=HealthCheck.
Comprimento da fila de observação	A Duração da Fila de Observação repete todos os Ouvintes de Evento e Observadores de Plano de Fundo, compara seus queueSize aos seus maxQueueSize e: retorna o status Crítico se o valor queueSize exceder o valor maxQueueSize (é quando os eventos seriam descartados) retorna Avisar se o valor queueSize estiver acima de maxQueueSize * WARN_THRESHOLD (o valor padrão é 0,75) O comprimento máximo de cada fila provém de configurações separadas (Oak e AEM) e não é configurável a partir dessa verificação de integridade. O MBean para esta verificação de integridade é org.apache.sling.saudcheck:name=ObservationQueueLengthHealthCheck,type=HealthCheck.
Limites de cruzamento da consulta	Os limites de travessia do query verificam QueryEngineSettings MBean, mais especificamente os atributos LimitInMemory e LimitReads, e retornam o seguinte status: retorna o status Avisar se um dos limites for igual ou superior ao Integer.MAX_VALUE retorna o status Aviso se um dos limites for menor que 10000 (a configuração recomendada do Oak) retorna o status Crítico se QueryEngineSettings ou qualquer um dos limites não puder ser recuperado O Mbean para esta verificação de integridade é org.apache.sling.saudcheck:name=queryTraversalLimitsBundle,type=HealthCheck.
Relógios sincronizados	Essa verificação é relevante apenas para clusters de nó de documento. Ele retorna o seguinte status: retorna o status de Aviso quando os relógios de instância ficam fora de sincronização e passam por um limite baixo predefinido retorna o status Crítico quando os relógios de instância ficam fora de sincronia e ultrapassam um limite alto predefinido O Mbean para esta verificação de integridade é org.apache.sling.saudcheck:name=slingDiscoveryOakSynchronizedClocks,type=HealthCheck.
Índices assíncronos	A verificação Índices Assíncronos: retorna o status Crítico se pelo menos uma linha de indexação estiver falhando verifica lastIndexedTime para todas as rotas de indexação e: retorna o status Crítico se estiver há mais de 2 horas retorna o status Aviso se estiver entre 2 horas e 45 minutos atrás retorna o status OK se estiver há menos de 45 minutos se nenhuma dessas condições for atendida, retornará o status OK Os limites de status Crítico e Avisar são configuráveis. O Mbean para esta verificação de integridade é org.apache.sling.saudcheck:name=asyncIndexHealthCheck,type=HealthCheck. Observação: Esta verificação de integridade está disponível com o AEM 6.4 e tem suporte para AEM 6.3.0.1.
Índices Lucene grandes	Essa verificação usa os dados expostos pelo MBean Lucene Index Statistics para identificar grandes índices e retornos: um status de Aviso se houver um índice com mais de 1 bilhão de documentos um status crítico se houver um índice com mais de 1,5 bilhão de documentos Os limites são configuráveis e o MBean para a verificação de integridade é org.apache.sling.saudcheck:name=largeIndexHealthCheck,type=HealthCheck. Observação: Esta verificação está disponível com o AEM 6.4 e tem suporte para AEM 6.3.2.0.
Manutenção do sistema	A Manutenção do sistema é uma verificação composta que retorna o OK se todas as tarefas de manutenção estiverem em execução como configurado. Lembre-se de que: cada tarefa de manutenção é acompanhada de um exame de saúde associado se uma tarefa não for adicionada a uma janela de manutenção, sua verificação de integridade retornará Crítico é necessário configurar as tarefas de manutenção Log de Auditoria e Expurgação do Fluxo de Trabalho ou removê-las das janelas de manutenção. Se não estiverem configuradas, essas tarefas falharão na primeira tentativa de execução, então a verificação Manutenção do sistema retornará o status Crítico. Com o AEM 6.4, também há uma verificação para a Lucene Binaries Maintenancetask. no AEM 6.2 e inferior, a verificação de manutenção do sistema retorna um status de Aviso logo após a inicialização, pois o tarefa nunca é executado. A partir da versão 6.3, eles retornarão OK se a primeira janela de manutenção ainda não tiver sido atingida. O MBean para esta verificação de integridade é org.apache.sling.saudcheck:name=systemcheck,type=HealthCheck.
Fila de replicação	Esta verificação repete os agentes de replicação e observa suas filas. Para o item na parte superior da fila, a verificação verifica quantas vezes o agente repetiu a replicação. Se o agente tentar novamente a replicação mais do que o valor do parâmetro numberOfRetriesAllowed, ele retornará um aviso. O parâmetro numberOfRetriesAllowed é configurável. O MBean para esta verificação de integridade é org.apache.sling.saudcheck:name=ReplicationQueue,type=HealthCheck.
Tarefas de arremesso	O Sling Jobs verifica o número de jobs na fila no JobManager, o compara ao maxNumQueueJobs limite e: retorna Crítico se mais de maxNumQueueJobs estiver na fila retorna Crítico se houver trabalhos ativos de longa duração com mais de 1 hora retorna Crítico se houver trabalhos em fila e o último tempo de trabalho concluído for superior a 1 hora Somente o número máximo de parâmetros de trabalhos em fila é configurável e tem o valor padrão de 1000. O MBean para esta verificação de integridade é org.apache.sling.saudcheck:name=slingJobs,type=HealthCheck.
Desempenho da solicitação	Esta verificação analisa a métrica granite.request.metrics.timer Sling e: retorna Crítico se o valor do percentil 75 estiver acima do limite crítico (o valor padrão é 500 milissegundos) retorna Avisar se o valor do 75º percentil estiver acima do limite de aviso (o valor padrão é 200 milissegundos) O MBean para esta verificação de integridade é org.apache.sling.saudcheck:name=RequestsStatus,type=HealthCheck.
Erros de log	Essa verificação retornará o status Avisar se houver erros no log. O MBean para esta verificação de integridade é org.apache.sling.saudcheck:name=logErrorHealthCheck,type=HealthCheck.
Espaço em disco	A verificação de Espaço em Disco verifica o MBean FileStoreStats, recupera o tamanho do armazenamento de nós e a quantidade de espaço em disco utilizável na partição do armazenamento de nós e: retorna Avisar se a proporção de espaço em disco utilizável para o tamanho do repositório for menor que o limite de aviso (o valor padrão é 10) retorna Crítico se a taxa de espaço em disco utilizável para o tamanho do repositório for menor que o limite crítico (o valor padrão é 2) Ambos os limites são configuráveis. A verificação só funciona em instâncias com um Repositório de segmentos. O MBean para esta verificação de integridade é org.apache.sling.saudcheck:name=DiskSpaceHealthCheck,type=HealthCheck.
Verificação de integridade do assistente de agendamento	Essa verificação retornará um aviso se a instância tiver trabalhos do Quartz em execução por mais de 60 segundos. O limite de duração aceitável é configurável. O MBean para esta verificação de integridade é org.apache.sling.saudcheck:name=slingCommonsSchedulerHealthCheck,type=HealthCheck.
Verificações de segurança	A verificação de segurança é um composto que agregação os resultados de várias verificações relacionadas à segurança. Essas verificações de integridade individuais tratam de preocupações diferentes da lista de verificação de segurança disponível na página de documentação da Lista de verificação de segurança. A verificação é útil como um teste de segurança de fumaça quando a instância é iniciada. O MBean para esta verificação de integridade é org.apache.sling.saudcheck:name=securityCheckits,type=HealthCheck
Grupos ativos	Os Pacotes Ativos verificam o estado de todos os pacotes e: retorna o status Aviso se algum dos pacotes não estiver ativo ou (iniciando, com ativação lento) ignora o status dos pacotes na lista ignorada O parâmetro ignorar lista é configurável. O MBean para esta verificação de integridade é org.apache.sling.saudcheck:name=inativeBundles,type=HealthCheck.
Verificação de Cache de Código	Esta é uma verificação de integridade que verifica várias condições JVM que podem disparar um erro CodeCache presente no Java 7: retorna Avisar se a instância estiver em execução no Java 7, com o enfraquecimento do Cache de Código ativado retorna Avisar se a instância estiver em execução no Java 7 e o tamanho do Cache de Código Reservado for menor que um limite mínimo (o valor padrão é 90 MB) O limite minimum.code.cache.size é configurável. Para obter mais informações sobre o erro, verifique esta página. O MBean para esta verificação de integridade é org.apache.sling.saudcheck:name=codeCacheHealthCheck,type=HealthCheck.
Recurso Buscar erros de caminho	Verifica se há recursos no caminho /apps/foundation/components/primary e: retorna Avisar se houver nós secundários em /apps/foundation/components/primary O MBean para esta verificação de integridade é org.apache.sling.saudcheck:name=resourceSearchPathErrorHealthCheck,type=HealthCheck.

Monitoramento com Nagios

O Painel de verificação de integridade pode se integrar ao Nagios por meio do Granite JMX Mbeans. O exemplo a seguir ilustra como adicionar uma verificação que mostre a memória usada no servidor que está executando o AEM.

1. Configure e instale Nagios no servidor de monitoramento.

2. Em seguida, instale o executor de plug-in remoto Nagios (NRPE).

   OBSERVAÇÃO

   Para obter mais informações sobre como instalar Nagios e NRPE em seu sistema, consulte a Documentação do Nagios.

3. Adicione uma definição de host para o servidor AEM. Isso pode ser feito por meio da interface da Web Nagios XI, usando o Configuration Manager:

   1. Abra um navegador e aponte para o servidor Nagios.
   2. Pressione o botão Configure no menu superior.
   3. No painel esquerdo, pressione o Gerenciador de configuração principal em Configuração avançada.
   4. Pressione o link Hosts na seção Monitoring.
   5. Adicione a definição do host:

   

   Abaixo está um exemplo de um arquivo de configuração de host, no caso de você estar usando o Nagios Core:

   define host {
      address 192.168.0.5
      max_check_attempts 3
      check_period 24x7
      check-command check-host-alive
      contacts admin
      notification_interval 60
      notification_period 24x7
   }
   

4. Instale Nagios e NRPE no servidor AEM.

5. Instale o plug-in check_http_json em ambos os servidores.

6. Defina um comando de verificação JSON genérico em ambos os servidores:

   define command{
   
       command_name    check_http_json-int
   
       command_line    /usr/lib/nagios/plugins/check_http_json --user "$ARG1$" --pass "$ARG2$" -u 'https://$HOSTNAME$:$ARG3$/$ARG4$' -e '$ARG5$' -w '$ARG6$' -c '$ARG7$'
   
   }
   

7. Adicione um serviço para memória usada no servidor AEM:

   define service {
   
       use generic-service
   
       host_name my.remote.host
   
       service_description AEM Author Used Memory
   
       check_command  check_http_json-int!<cq-user>!<cq-password>!<cq-port>!system/sling/monitoring/mbeans/java/lang/Memory.infinity.json!{noname}.mbean:attributes.HeapMemoryUsage.mbean:attributes.used.mbean:value!<warn-threshold-in-bytes>!<critical-threshold-in-bytes>
   
       }
   

8. Verifique seu painel Nagios para obter o serviço recém-criado:

   

Ferramentas de diagnóstico

O Painel Operation também fornece acesso às Ferramentas de diagnóstico que podem ajudar a encontrar e solucionar problemas das causas raiz dos avisos provenientes do Painel Health Check, além de fornecer informações importantes de depuração para os operadores do sistema.

Entre as suas características mais importantes estão:

• Um analisador de mensagens de registro
• A capacidade de acessar os despejos de heap e thread
• Analisadores de desempenho de solicitações e query

Você pode acessar a tela Ferramentas de diagnóstico indo para Ferramentas - Operações - Diagnóstico na tela de boas-vindas do AEM. Você também pode acessar a tela acessando diretamente o seguinte URL: https://serveraddress:port/libs/granite/operations/content/diagnosis.html

Mensagens de registro

Por padrão, as mensagens de log da Interface do usuário exibirão todas as mensagens de ERRO. Se desejar que mais mensagens de log sejam exibidas, é necessário configurar um agente de log com o nível de log apropriado.

As mensagens de registro usam um anexo de registro de memória e, portanto, não estão relacionadas aos arquivos de registro. Outra consequência é que alterar os níveis de log nesta interface não alterará as informações que são registradas nos arquivos de log tradicionais. A adição e remoção de registradores nesta interface afetará apenas o registrador de memória. Além disso, observe que a alteração das configurações do agente de log será refletida no futuro do agente de log de memória - as entradas que já estão registradas e não são mais relevantes não serão excluídas, mas entradas semelhantes não serão registradas no futuro.

Você pode configurar o que é registrado fornecendo configurações de logger do botão de engrenagem superior esquerdo na interface do usuário. Lá, você pode adicionar, remover ou atualizar configurações de agente de log. Uma configuração de agente de log é composta por um log level (WARN / INFO / DEBUG) e um nome do filtro. O nome do filtro tem a função de filtrar a origem das mensagens de registro que são registradas. Como alternativa, se um agente de log deve capturar todas as mensagens de log para o nível especificado, o nome do filtro deve ser "root". Definir o nível de um agente de log acionará a captura de todas as mensagens com um nível igual ou superior ao especificado.

Exemplos:

• Se você planeja capturar todas as mensagens ERROR - nenhuma configuração é necessária. Todas as mensagens de ERRO são capturadas por padrão.

• Se você planeja capturar todas as mensagens ERROR, WARN e INFO - o nome do agente de log deve ser definido como: "root" e o nível do agente de log para: INFO.

• Se você planeja capturar todas as mensagens provenientes de um determinado pacote (por exemplo, com.adobe.granite) - o nome do agente de log deve ser definido como: "com.adobe.granite" e o nível do agente de log para: DEBUG (isso capturará todas as mensagens ERROR, WARN, INFO e DEBUG), conforme mostrado na imagem abaixo.

Log level: INFO
DATE+TIME [MaintanceLogger] Name=<MT_NAME>, Status=<MT_STATUS>, Time=<MT_TIME>, Error=<MT_ERROR>, Details=<MT_DETAILS>

Solicitar desempenho

A página Desempenho da solicitação permite a análise das solicitações de página mais lentas processadas. Somente as solicitações de conteúdo serão registradas nesta página. Mais especificamente, as seguintes solicitações serão capturadas:

1. Solicitações de acesso a recursos em /content
2. Solicitações de acesso a recursos em /etc/design
3. Solicitações com a extensão ".html"

A página exibe:

• A hora em que a solicitação foi feita
• O URL e o método de solicitação
• A duração em milissegundos

Por padrão, as 20 solicitações de página mais lentas são capturadas, mas o limite pode ser modificado no Configuration Manager.

Desempenho da consulta

A página Desempenho do Query permite a análise dos query mais lentos executados pelo sistema. Essas informações são fornecidas pelo repositório em um JMX Mbean. Em Jackrabbit, o com.adobe.granite.QueryStat JMX Mbean fornece essas informações, enquanto no repositório Oak, ele é oferecido por org.apache.jackrabbit.oak.QueryStats.

A página exibe:

• A hora em que o query foi feito
• O idioma do query
• O número de vezes que o query foi emitido
• A declaração do query
• A duração em milissegundos

Explicar consulta

Para qualquer query, Oak tenta descobrir a melhor maneira de executar com base nos índices Oak definidos no repositório no nó oak:index. Dependendo do query, diferentes índices podem ser escolhidos por Oak. Entender como o Oak está executando um query é o primeiro passo para otimizar o query.

O Query Explique é uma ferramenta que explica como o Oak está executando um query. Ele pode ser acessado indo até Ferramentas - Operações - Diagnóstico da tela de boas-vindas AEM, clicando em Desempenho do Query e alternando para a guia Explorar Query.

Recursos

• Suporta os idiomas de query Xpath, JCR-SQL e JCR-SQL2
• Relata o tempo de execução real do query fornecido
• Detecta query lentos e avisa sobre query que podem ser lentos
• Relata o índice Oak usado para executar o query
• Exibe a explicação real do mecanismo de Query Oak
• Fornece lista de clique para carregar de query lentos e populares

Depois que você estiver na interface do usuário do Query Explique, tudo o que precisa fazer para usá-la é digitar o query e pressionar o botão Explicar:

A primeira entrada na seção Explicação do Query é a explicação concreta. A explicação mostrará o tipo de índice usado para executar o query.

A segunda entrada é o plano de execução.

Clicar na caixa Incluir tempo de execução antes de executar o query também mostrará a quantidade de tempo em que o query foi executado, permitindo mais informações que podem ser usadas para otimizar os índices do aplicativo ou da implantação.

O Gerenciador de índice

A finalidade do Gerenciador de índice é facilitar o gerenciamento de índice, como manter índices, ou exibir seu status.

Ele pode ser acessado indo até Ferramentas - Operações - Diagnóstico na tela de boas-vindas e clicando no botão Gerenciador de índice.

Ele também pode ser acessado diretamente neste URL: https://serveraddress:port/libs/granite/operations/content/diagnosistools/indexManager.html

A interface do usuário pode ser usada para filtrar índices na tabela digitando os critérios do filtro na caixa de pesquisa no canto superior esquerdo da tela.

Baixar o ZIP de status

Isso acionará o download de um zip que contém informações úteis sobre o status e a configuração do sistema. O arquivo contém configurações de instância, uma lista de pacotes, OSGI, Métricas e estatísticas Sling, o que pode resultar em um arquivo grande. Você pode reduzir o impacto de arquivos de status grandes usando a janela Baixar ZIP de status. A janela pode ser acessada de:AEM > Ferramentas > Operações > Diagnóstico > Baixar ZIP de Status.

Nessa janela, você pode selecionar o que exportar (arquivos de log e/ou despejos de thread) e o número de dias de logs incluídos no download em relação à data atual.

Baixar o despejo de encadeamento

Isso acionará o download de um zip que contém informações sobre os encadeamentos presentes no sistema. Informações sobre cada thread são fornecidas, como seu status, o carregador de classe e o rastreamento de pilha.

Baixar o despejo da pilha

Você também pode baixar um instantâneo do heap para analisá-lo posteriormente. Observe que isso acionará o download de um arquivo grande, da ordem de centenas de megabytes.

Tarefas de manutenção automatizadas

A página Tarefas de manutenção automatizada é um local onde você pode visualização e rastrear tarefas de manutenção recomendadas programadas para execução periódica. As tarefas são integradas ao sistema de verificação de integridade. As tarefas também podem ser executadas manualmente a partir da interface.

Para chegar à página Manutenção no Painel Operações, você precisa ir para Ferramentas - Operações - Painel - Manutenção na tela de Boas-vindas AEM ou seguir diretamente este link:

https://serveraddress:port/libs/granite/operations/content/maintenance.html

As seguintes tarefas estão disponíveis no Painel Operações:

1. A tarefa Limpeza de revisão localizada no menu Janela de manutenção diária.
2. A tarefa Limpeza de binários Lucene, localizada no menu Janela de manutenção diária.
3. A tarefa Expurgação do fluxo de trabalho, localizada no menu Janela de manutenção semanal.
4. A tarefa Coleta de lixo do Data Store, localizada no menu Janela de manutenção semanal.
5. A tarefa Manutenção do Log de Auditoria, localizada no menu Janela de Manutenção Semanal.
6. A tarefa Version Purge Maintenance, localizada no menu Weekly Maintenance Window.

O tempo padrão para a janela de manutenção diária é de 2 a 5 da manhã. As tarefas configuradas para execução na janela de manutenção semanal serão executadas entre 1 e 2 AM aos sábados.

Você também pode configurar os horários pressionando o ícone de engrenagem em qualquer uma das duas placas de manutenção:

Limpeza da revisão

Para obter mais informações sobre como executar a limpeza de revisão, consulte este artigo dedicado.

Limpeza de binários do Lucene

Ao usar a tarefa de Limpeza de binários Lucene, você pode expurgar binários lucene e reduzir o requisito de tamanho do armazenamento de dados em execução. Isso ocorre porque a grade binária do lucene será recuperada diariamente em vez da dependência anterior em uma coleta de lixo do armazenamento de dados executada com êxito.

Embora a tarefa de manutenção tenha sido desenvolvida para reduzir o lixo de revisão relacionado a Lucene, há ganhos gerais de eficiência ao executar a tarefa:

• A execução semanal da tarefa de coleta de lixo do armazenamento de dados será concluída mais rapidamente
• Também pode melhorar ligeiramente o desempenho geral do AEM

Você pode acessar a tarefa de Limpeza de binários de Lucene a partir de: AEM > Ferramentas > Operações > Manutenção > Janela de manutenção diária > Limpeza de binários Lucene.

Coleta de lixo do armazenamento de dados

Para obter detalhes sobre a coleta de lixo do Data Store, consulte a página de documentação dedicada a1/>.

Expurgação do fluxo de trabalho

Workflows também podem ser removidos do Painel Maintenance. Para executar a tarefa de Expurgação do Fluxo de Trabalho, é necessário:

1. Clique na página Janela de manutenção semanal.
2. Na página a seguir, clique no botão Reproduzir no cartão Expurgação do fluxo de trabalho.

Manutenção do Log de Auditoria

Para a Manutenção do Log de Auditoria, consulte a página de documentação separada.

Remoção da versão

Você pode agendar a tarefa de manutenção Expurgação da versão para excluir versões antigas automaticamente. Como resultado, isso minimiza a necessidade de usar manualmente as ferramentas de Expurgação da Versão. Você pode agendar e configurar a tarefa de Expurgação da Versão acessando Ferramentas > Operações > Manutenção > Janela de manutenção semanal e seguindo estas etapas:

1. Clique no botão Adicionar.

2. Escolha Expurgação da versão no menu suspenso.

   

3. Para configurar a tarefa de Expurgação da Versão, clique no ícone engrenagens no cartão de manutenção de Expurgação da Versão recém-criado.

   

Com o AEM 6.4, você pode parar a tarefa de manutenção da Expurgação da Versão da seguinte maneira:

• Automaticamente - se a janela de manutenção programada for fechada antes que a tarefa possa ser concluída, a tarefa será interrompida automaticamente. Ele será retomado quando a próxima janela de manutenção for aberta.
• Manualmente - Para interromper manualmente a tarefa, no cartão de manutenção Expurgação da versão, clique no ícone Parar. Na próxima execução, a tarefa será retomada com segurança.

Tarefas de manutenção personalizadas

Tarefas de manutenção personalizadas podem ser implementadas como serviços OSGi. Como a infraestrutura da tarefa de manutenção se baseia no gerenciamento de tarefas do Apache Sling, uma tarefa de manutenção deve implementar a interface java [org.apache.sling.event.jobs.consumer.JobExecutor](https://sling.apache.org/apidocs/sling7/org/apache/sling/event/jobs/consumer/JobExecutor.html). Além disso, deve declarar várias propriedades de registro de serviço a serem detectadas como tarefa de manutenção, conforme listado abaixo:

Nome da propriedade do serviço	Descrição	Exemplo	Tipo
granite.maintenance.isStoppable	Atributo booliano que define se a tarefa pode ser interrompida pelo usuário. Se uma tarefa declarar que é parada, deverá verificar, durante a sua execução, se foi parada e, em seguida, agir em conformidade. O padrão é false.	verdadeiro	Opcional
granite.maintenance.mandatory	Atributo booliano que define se uma tarefa é obrigatória e deve ser executada periodicamente. Se uma tarefa for obrigatória, mas não estiver em nenhuma janela de programação ativa, uma Verificação de integridade reportará isso como um erro. O padrão é false.	verdadeiro	Opcional
granite.maintenance.name	Um nome exclusivo para a tarefa - é usado para fazer referência à tarefa. Este é geralmente um nome simples.	MyMaintenanceTask	Obrigatório
granite.maintenance.title	Um título exibido para esta tarefa	Minha Tarefa de manutenção especial	Obrigatório
job.topics	Este é um tópico exclusivo da tarefa de manutenção. O manuseio de tarefas do Apache Sling irá start um trabalho com exatamente este tópico para executar a tarefa de manutenção e, conforme a tarefa é registrada para este tópico, ele será executado. O tópico deve ser start com/ adobe/granite/manutenção/job/	com/adobe/granite/manutenção/job/MyMaintenanceTask	Obrigatório

Além das propriedades de serviço acima, o método process() da interface JobConsumer precisa ser implementado adicionando o código que deve ser executado para a tarefa de manutenção. O JobExecutionContext fornecido pode ser usado para gerar informações de status, verificar se o trabalho foi interrompido pelo usuário e criar um resultado (bem-sucedido ou com falha).

Para situações em que uma tarefa de manutenção não deve ser executada em todas as instalações (por exemplo, executada apenas na instância de publicação), você pode fazer com que o serviço exija uma configuração para ficar ativo adicionando @Component(policy=ConfigurationPolicy.REQUIRE). Você pode marcar a configuração de acordo como sendo o modo de execução dependente no repositório. Para obter mais informações, consulte Configuração do OSGi.

Abaixo está um exemplo de uma tarefa de manutenção personalizada que exclui arquivos de um diretório temporário configurável que foi modificado nas últimas 24 horas:

src/main/java/com/adobe/granite/samples/maintenance/impl/DeleteTempFilesTask.java

/* * #%L * sample-maintenance-task * %% * Copyright (C) 2014 Adobe * %% * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * https://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * #L% */ package com.adobe.granite.samples.maintenance.impl; import java.io.File; import java.util.Calendar; import java.util.Collection; import java.util.Map; import org.apache.commons.io.FileUtils; import org.apache.commons.io.filefilter.IOFileFilter; import org.apache.commons.io.filefilter.TrueFileFilter; import org.apache.felix.scr.annotations.Activate; import org.apache.felix.scr.annotations.Component; import org.apache.felix.scr.annotations.Properties; import org.apache.felix.scr.annotations.Property; import org.apache.felix.scr.annotations.Service; import org.apache.sling.commons.osgi.PropertiesUtil; import org.apache.sling.event.jobs.Job; import org.apache.sling.event.jobs.consumer.JobConsumer; import org.apache.sling.event.jobs.consumer.JobExecutionContext; import org.apache.sling.event.jobs.consumer.JobExecutionResult; import org.apache.sling.event.jobs.consumer.JobExecutor; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import com.adobe.granite.maintenance.MaintenanceConstants; @Component(metatype = true, label = "Delete Temp Files Maintenance Task", description = "Maintatence Task which deletes files from a configurable temporary directory which have been modified in the last 24 hours.") @Service @Properties({ @Property(name = MaintenanceConstants.PROPERTY_TASK_NAME, value = "DeleteTempFilesTask", propertyPrivate = true), @Property(name = MaintenanceConstants.PROPERTY_TASK_TITLE, value = "Delete Temp Files", propertyPrivate = true), @Property(name = JobConsumer.PROPERTY_TOPICS, value = MaintenanceConstants.TASK_TOPIC_PREFIX + "DeleteTempFilesTask", propertyPrivate = true) }) public class DeleteTempFilesTask implements JobExecutor { private static final Logger log = LoggerFactory.getLogger(DeleteTempFilesTask.class); @Property(label = "Temporary Directory", description="Temporary Directory. Defaults to the java.io.tmpdir system property.") private static final String PROP_TEMP_DIR = "temp.dir"; private File tempDir; @Activate private void activate(Map<string, object=""> properties) { this.tempDir = new File(PropertiesUtil.toString(properties.get(PROP_TEMP_DIR), System.getProperty("java.io.tmpdir"))); } @Override public JobExecutionResult process(Job job, JobExecutionContext context) { log.info("Deleting old temp files from {}.", tempDir.getAbsolutePath()); Collection<file> files = FileUtils.listFiles(tempDir, new LastModifiedBeforeYesterdayFilter(), TrueFileFilter.INSTANCE); int counter = 0; for (File file : files) { log.debug("Deleting file {}.", file.getAbsolutePath()); counter++; file.delete(); // TODO - capture the output of delete() and do something useful with it } return context.result().message(String.format("Deleted %s files.", counter)).succeeded(); } /** * IOFileFilter which filters out files which have been modified in the last 24 hours. * */ private static class LastModifiedBeforeYesterdayFilter implements IOFileFilter { private final long minTime; private LastModifiedBeforeYesterdayFilter() { Calendar cal = Calendar.getInstance(); cal.add(Calendar.DATE, -1); this.minTime = cal.getTimeInMillis(); } @Override public boolean accept(File dir, String name) { // this method is never actually called. return false; } @Override public boolean accept(File file) { return file.lastModified() <= this.minTime; } } } <file></string,>

experience-emanager-java-manuetask-sample - src/main/java/com/adobe/granite/samples/maintenance/impl/DeleteTempFilesTask.java

Depois que o serviço é implantado, ele é exposto à interface do usuário do Painel de Operações. Você pode adicioná-lo a uma das programações de manutenção disponíveis:

Isso adicionará um recurso correspondente em /apps/granite/operations/config/manutenção/schedule/taskname. Se a tarefa for dependente do modo de execução, a propriedade granite.operations.as.runmode precisa ser definida nesse nó com os valores dos modos de execução que precisam estar ativos para essa tarefa de manutenção.

Visão geral do sistema

O Painel Visão geral do sistema exibe uma visão geral de alto nível da configuração, hardware e integridade da instância AEM. Isso significa que o status de integridade do sistema é transparente e todas as informações são agregadas em um único painel.

Como acessar

Para acessar o Painel Visão geral do sistema, navegue até Ferramentas > Operações > Visão geral do sistema.

Explicação do Painel de Visão Geral do Sistema

A tabela abaixo descreve todas as informações exibidas no Painel Visão geral do sistema. Lembre-se de que quando não houver informações relevantes para mostrar (por exemplo, o backup não está em andamento, não há verificações de integridade críticas) a respectiva seção exibirá a mensagem "Nenhuma entrada".

Você também pode baixar um arquivo JSON resumindo as informações do painel clicando no botão Download no canto superior direito do painel. O endpoint JSON é /libs/granite/operations/content/systemoverview/export.json e pode ser usado em um script curl para monitoramento externo.

Seção	Que informações são exibidas	Quando é crítico	Links para
Verificações de integridade	uma lista de verificações em estado crítico uma lista de verificações que estão no status Aviso	Indicado visualmente: uma tag vermelha para verificações Críticas uma tag laranja para as verificações de Aviso	Página Relatórios de integridade
Tarefas de manutenção	uma lista de tarefas que falhou uma lista de tarefas em execução no momento uma lista de tarefas que tiveram êxito na última execução uma lista de tarefas que nunca foram executadas uma lista de tarefas que não estão programadas	Indicado visualmente: uma tag vermelha para tarefas com falha uma tag laranja para executar o tarefa (pois isso pode afetar o desempenho) tags cinza para todos os outros status	Página Tarefas de manutenção
Sistema	sistema operacional e versão do SO (por exemplo, Mac OS X) média de carga do sistema, conforme recuperado de OperatingSystemMXBeanusable espaço em disco (na partição onde o diretório inicial está localizado) heap máximo, conforme retornado por MemoryMXBean	N/A	N/A
Instância	a versão AEM lista dos modos de execução a data em que a instância foi iniciada	N/A	N/A
Repositório	a versão Oak tipo de armazenamento de nó (barra de segmentos ou Documento) se o tipo for documento, o tipo de armazenamento de documentos será exibido (RDB ou Mongo) se houver um armazenamento de dados personalizado: para um Arquivo de Dados, o caminho é exibido para um armazenamento de dados S3, o nome do bucket S3 é exibido para um armazenamento de Dados S3 Compartilhado, o nome do bucket S3 é exibido para um Armazenamento de Dados do Azure, o container é exibido se não houver um armazenamento de dados externo personalizado, uma mensagem indicando esse fato será exibida	N/A	N/A
Agentes de distribuição	uma lista de agentes com filas bloqueadas uma lista de agentes configurados incorretamente ("Erro de configuração") uma lista de agentes com processamento de fila pausado uma lista de agentes ociosos uma lista de agentes em execução (que estão processando entradas no momento)	Indicado visualmente: uma tag vermelha para agentes bloqueados ou erros de configuração uma tag laranja para agentes pausados uma tag cinza para agentes pausados, ociosos ou em execução	Página de distribuição
Agentes de replicação	uma lista de agentes com filas bloqueadas uma lista de agentes ociosos uma lista de agentes em execução (que estão processando entradas no momento)	Indicado visualmente: uma tag vermelha para agentes bloqueados uma tag cinza para agentes pausados	Página Replicação
Fluxos de trabalhos	Trabalhos de Fluxo de Trabalho: número de trabalhos de fluxo de trabalho com falha (se houver) número de trabalhos de fluxo de trabalho cancelados (se houver) Contagens de Fluxo de Trabalho - número de workflows em um determinado status (se houver): execução Falha suspenso abortado Para cada um dos status apresentados acima, um query é executado, com um limite de 400 milissegundos. Em 400 milissegundos, o número de entradas obtidas até esse ponto é exibido.	Não interpretado: o usuário deve investigar quando há workflows e trabalhos em status inesperados.	Página Falhas de Fluxo de Trabalho
Tarefas de arremesso	Contagem de trabalhos de sling - número de trabalhos em um determinado status (se houver): Falha na fila cancelado ativo	Não interpretado: o usuário deve investigar quando há trabalhos em status inesperados ou com contagens elevadas.	N/A
Contagens estimadas de nós	Número estimado de: páginas ativos tags autorizáveis número total de nós O número total de nós é obtido a partir de nodeCounterMBean, enquanto o restante das estatísticas é obtido a partir de IndexInfoService.	N/A	N/A
Backup	Exibe "Backup on-line em andamento", se esse for o caso.	N/A	N/A
Indexação	Exibições: "Indexação em andamento" "Consulta em andamento" Se uma indexação ou thread de query estiver presente no despejo de thread.	N/A	N/A