Consultas e indexação do Oak

Introdução

Ao contrário do Jackrabbit 2, o Oak não indexa o conteúdo por padrão. Os índices personalizados precisam ser criados quando necessário, assim como os bancos de dados relacionais tradicionais. Se não houver índice para uma consulta específica, possivelmente muitos nós serão atravessados. A consulta ainda pode funcionar, mas provavelmente está muito lenta.

Se o Oak encontrar uma consulta sem um índice, uma mensagem de log de nível AVISO será impressa:

*WARN* Traversed 1000 nodes with filter Filter(query=select ...) consider creating an index or changing the query

Idiomas de consulta compatíveis

O mecanismo de consulta Oak oferece suporte para os seguintes idiomas:

• XPath (recomendado)
• SQL-2
• SQL (obsoleto)
• JQOM

Tipos de indexador e cálculo de custo

O back-end baseado no Apache Oak permite que diferentes indexadores sejam conectados ao repositório.

Um indexador é o Índice de propriedades, para o qual a definição do índice é armazenada no próprio repositório.

As implementações para Apache Lucene e Solr também estão disponíveis por padrão, o que oferece suporte à indexação de texto completo.

O Índice de travessia é usado se nenhum outro indexador estiver disponível. Isso significa que o conteúdo não é indexado e os nós de conteúdo são percorridos para encontrar correspondências com a consulta.

Se vários indexadores estiverem disponíveis para uma consulta, cada indexador disponível estima o custo de execução da consulta. Oak então escolhe o indexador com o menor custo estimado.

O diagrama acima é uma representação de alto nível do mecanismo de execução de consulta do Apache Oak.

Primeiro, o query é analisado em uma Árvore de sintaxe abstrata. Em seguida, a query é marcada e transformada em SQL-2, que é o idioma nativo para queries Oak.

Em seguida, cada índice é consultado para estimar o custo do query. Uma vez concluídos, os resultados do índice mais barato são recuperados. Finalmente, os resultados são filtrados, tanto para garantir que o usuário atual tenha acesso de leitura ao resultado quanto que o resultado corresponda à query completa.

Configuração dos índices

Se a reindexação for necessária em repositórios muito grandes, especialmente ao usar MongoDB e para índices de texto completo, considere a pré-extração de texto e o uso de oak-run para criar o índice inicial e reindexar.

Os índices são configurados como nós no repositório no nó oak:index.

O tipo do nó de índice deve ser oak:QueryIndexDefinition. Várias opções de configuração estão disponíveis para cada indexador como propriedades de nó. Para obter mais informações, consulte os detalhes de configuração de cada tipo de indexador abaixo.

O Índice de propriedades

O Índice de propriedades geralmente é útil para consultas que têm restrições de propriedade, mas não são de texto completo. Ele pode ser configurado seguindo o procedimento abaixo:

1. Abra o CRXDE acessando http://localhost:4502/crx/de/index.jsp

2. Crie um novo nó em oak:index

3. Nomeie o nó PropertyIndex e defina o tipo de nó como oak:QueryIndexDefinition

4. Defina as seguintes propriedades para o novo nó:

   • type: property (do tipo String)
   • propertyNames: jcr:uuid (do tipo Name)

   Este exemplo específico indexará a propriedade jcr:uuid, cujo trabalho é expor o identificador universalmente exclusivo (UUID) do nó ao qual está anexado.

5. Salve as alterações.

O Índice de propriedades tem as seguintes opções de configuração:

• A propriedade type especificará o tipo de índice e, nesse caso, deverá ser definida como property

• A propriedade propertyNames indica a lista das propriedades que serão armazenadas no índice. Caso esteja ausente, o nome do nó será usado como um valor de referência do nome da propriedade. Neste exemplo, a propriedade jcr:uuid cujo trabalho é expor o identificador exclusivo (UUID) de seu nó é adicionada ao índice.

• O sinalizador exclusivo que, se definido como true adiciona uma restrição de exclusividade no índice de propriedade.

• A propriedade declareNodeTypes permite especificar um determinado tipo de nó ao qual o índice só será aplicado.

• O sinalizador reindex que, se definido como true, acionará uma reindexação de conteúdo completa.

O índice solicitado

O índice Ordered é uma extensão do índice Property . No entanto, ela foi substituída. Os índices desse tipo precisam ser substituídos pelo Índice de propriedades do Lucene.

O índice de texto completo do Lucene

Um indexador de texto completo com base no Apache Lucene está disponível no AEM 6.

Se um índice de texto completo estiver configurado, todos os queries com uma condição de texto completo usarão o índice de texto completo, independentemente de haver outras condições indexadas, e independentemente de haver uma restrição de caminho.

Se nenhum índice de texto completo estiver configurado, as consultas com condições de texto completo não funcionarão conforme esperado.

Como o índice é atualizado por meio de um encadeamento em segundo plano assíncrono, algumas pesquisas em texto completo não estarão disponíveis por uma pequena janela de tempo até que os processos em segundo plano sejam concluídos.

Você pode configurar um índice de texto completo do Lucene seguindo o procedimento abaixo:

1. Abra o CRXDE e crie um novo nó em oak:index.

2. Nomeie o nó LuceneIndex e defina o tipo de nó como oak:QueryIndexDefinition

3. Adicione as seguintes propriedades ao nó :

   • type: lucene (do tipo String)
   • async: async (do tipo String)

4. Salve as alterações.

O Índice Lucene tem as seguintes opções de configuração:

• A propriedade type que especificará o tipo de índice deve ser definida como lucene
• A propriedade async que deve ser definida como async. Isso enviará o processo de atualização do índice para um thread em segundo plano.
• A propriedade includePropertyTypes, que definirá qual subconjunto de tipos de propriedade será incluído no índice.
• A propriedade excludePropertyNames que definirá uma lista de nomes de propriedades - propriedades que devem ser excluídas do índice.
• O sinalizador reindex que, quando definido como true, aciona uma reindexação de conteúdo completo.

O Índice de propriedades do Lucene

Como Oak 1.0.8, Lucene pode ser usado para criar índices que envolvam restrições de propriedade que não sejam texto completo.

Para alcançar um Índice de propriedade do Lucene, a propriedade fulltextEnabled deve sempre ser definida como false.

Use o exemplo de consulta a seguir:

select * from [nt:base] where [alias] = '/admin'

Para definir um Índice de propriedades do Lucene para a consulta acima, você pode adicionar a seguinte definição criando um novo nó em oak:index:

• Nome: LucenePropertyIndex
• Tipo: oak:QueryIndexDefinition

Depois que o nó tiver sido criado, adicione as seguintes propriedades:

• tipo:

  lucene (of type String)
  

• async:

  async (of type String)
  

• fulltextEnabled:

  false (of type Boolean)
  

• includePropertyNames: [alias] (do tipo String)

Analisadores Lucene

Desde a versão 1.2.0, o Oak é compatível com os analisadores Lucene.

Os analisadores são usados quando um documento é indexado e no momento da consulta. Um analisador examina o texto dos campos e gera um fluxo de token. Os analisadores Lucene são compostos de uma série de classes de tokenizer e filtro.

Os analisadores podem ser configurados por meio do nó analyzers (do tipo nt:unstructured) dentro da definição oak:index.

O analisador padrão para um índice é configurado no filho default do nó dos analisadores.

Especificar a classe do analisador diretamente

Se quiser usar qualquer analisador pronto para uso, você pode configurá-lo seguindo o procedimento abaixo:

1. Localize o índice com o qual você deseja usar o analisador no nó oak:index.

2. No índice, crie um nó filho chamado default do tipo nt:unstructured.

3. Adicione uma propriedade ao nó padrão com as seguintes propriedades:

   • Nome: class
   • Tipo: String
   • Valor: org.apache.lucene.analysis.standard.StandardAnalyzer

   O valor é o nome da classe do analisador que você deseja usar.

   Você também pode definir o analisador para ser usado com uma versão específica do lucene usando a propriedade opcional luceneMatchVersion string. Uma sintaxe válida para usá-la com o Lucene 4.7 seria:

   • Nome: luceneMatchVersion
   • Tipo: String
   • Valor: LUCENE_47

   Se luceneMatchVersion não for fornecido, o Oak usará a versão do Lucene com a qual ele foi enviado.

4. Se quiser adicionar um arquivo de palavras de interrupção às configurações do analisador, crie um novo nó no default com as seguintes propriedades:

   • Nome: stopwords
   • Tipo: nt:file

Criação de analisadores por meio da Composição

Os analisadores também podem ser compostos com base em Tokenizers, TokenFilters e CharFilters. Você pode fazer isso especificando um analisador e criando nós filhos de seus tokens e filtros opcionais que serão aplicados em ordem listada. Consulte também https://wiki.apache.org/solr/AnalyzersTokenizersTokenFilters#Specifying_an_Analyzer_in_the_schema

Considere esta estrutura de nó como um exemplo:

• Nome: analyzers

  • Nome: default

    • Nome: charFilters

    • Tipo: nt:unstructured

      • Nome: HTMLStrip
      • Nome: Mapping

    • Nome: tokenizer

      • Nome da Propriedade: name

        • Tipo: String
        • Valor: Standard

    • Nome: filters

    • Tipo: nt:unstructured

      • Nome: LowerCase

      • Nome: Stop

        • Nome da propriedade: words

          • Tipo: String
          • Valor: stop1.txt, stop2.txt

        • Nome: stop1.txt

          • Tipo: nt:file

        • Nome: stop2.txt

          • Tipo: nt:file

O nome dos filtros, charFilters e tokenizers é formado pela remoção dos sufixos de fábrica. Assim:

• org.apache.lucene.analysis.standard.StandardTokenizerFactory become standard

• org.apache.lucene.analysis.charfilter.MappingCharFilterFactory become Mapping

• org.apache.lucene.analysis.core.StopFilterFactory become Stop

Qualquer parâmetro de configuração necessário para a fábrica é especificado como propriedade do nó em questão.

Para casos como o carregamento de palavras de interrupção em que o conteúdo de arquivos externos precisa ser carregado, o conteúdo pode ser fornecido criando um nó filho do tipo nt:file para o arquivo em questão.

O Índice Solr

A finalidade do índice Solr é principalmente a pesquisa de texto completo, mas também pode ser usada para indexar a pesquisa por caminho, restrições de propriedade e restrições de tipo primário. Isso significa que o índice Solr no Oak pode ser usado para qualquer tipo de consulta JCR.

A integração no AEM ocorre no nível do repositório, de modo que o Solr seja um dos índices possíveis que podem ser usados no Oak, a nova implementação do repositório enviada com o AEM.

Ele pode ser configurado para funcionar como um servidor incorporado com a instância do AEM ou como um servidor remoto.

Configurando AEM com um servidor Solr incorporado

AEM pode ser usado com um servidor Solr incorporado que pode ser configurado através do Console da Web. Nesse caso, o servidor Solr será executado na mesma JVM da instância de AEM à qual está incorporado.

Você pode configurar o servidor Solr incorporado:

1. Ir para o Console da Web em https://serveraddress:4502/system/console/configMgr

2. Procure por "Provedor de servidor Oak Solr".

3. Pressione o botão de edição e, na janela a seguir, defina o tipo de servidor como Embedded Solr na lista suspensa.

4. Em seguida, edite "Configuração de servidor incorporado do Oak Solr" e crie uma configuração. Para obter mais informações sobre as opções de configuração, visite o site do Apache Solr.

   OBSERVAÇÃO

   A configuração do diretório base Solr (solr.home.path) procurará uma pasta com o mesmo nome na pasta de instalação AEM.

5. Abra o CRXDE e faça logon como Administrador.

6. Adicione um nó chamado solrlndex do tipo oak:QueryIndexDefinition em oak:index com as seguintes propriedades:

   • type: solr (do tipo String)
   • async: async (do tipo String)
   • reindex: true (do tipo Boolean)

7. Salve as alterações.

Configurando AEM com um único servidor Solr remoto

AEM também pode ser configurado para funcionar com uma instância remota do servidor Solr:

1. Baixe e extraia a versão mais recente do Solr. Para obter mais informações sobre como fazer isso, consulte a Documentação de instalação do Apache Solr.

2. Agora, crie dois fragmentos Solr. Você pode fazer isso criando pastas para cada compartilhamento na pasta onde Solr foi compactado:

   • Para o primeiro compartilhamento, crie a pasta :

   <solrunpackdirectory>\aemsolr1\node1

   • Para o segundo compartilhamento, crie a pasta :

   <solrunpackdirectory>\aemsolr2\node2

3. Localize a instância de exemplo no pacote Solr. Normalmente, ele está localizado em uma pasta chamada " example" na raiz do pacote.

4. Copie as seguintes pastas da instância de exemplo para as duas pastas compartilhadas ( aemsolr1\node1 e aemsolr2\node2):

   • contexts
   • etc
   • lib
   • resources
   • scripts
   • solr-webapp
   • webapps
   • start.jar

5. Crie uma nova pasta chamada " cfg" em cada uma das duas pastas compartilhadas.

6. Coloque os arquivos de configuração Solr e Zookeeper nas pastas cfg recém-criadas.

   OBSERVAÇÃO

   Para obter mais informações sobre a configuração do Solr e do ZooKeeper, consulte a Documentação de configuração do Solr e o Guia de Introdução do ZooKeeper.

7. Inicie o primeiro compartilhamento com o suporte ao ZooKeeper acessando aemsolr1\node1 e executando o seguinte comando:

   java -Xmx2g -Dbootstrap_confdir=./cfg/oak/conf -Dcollection.configName=myconf -DzkRun -DnumShards=2 -jar start.jar
   

8. Inicie o segundo compartilhamento acessando aemsolr2\node2 e executando o seguinte comando:

   java -Xmx2g -Djetty.port=7574 -DzkHost=localhost:9983 -jar start.jar
   

9. Depois que ambos os fragmentos forem iniciados, teste se tudo está funcionando, conectando-se à interface Solr em http://localhost:8983/solr/#/

10. Inicie o AEM e vá para o Console da Web em http://localhost:4502/system/console/configMgr

11. Defina a seguinte configuração em Configuração do servidor remoto Oak Solr:

    • URL HTTP Solr: http://localhost:8983/solr/

12. Escolha Remote Solr na lista suspensa em Oak Solr provedor de servidor.

13. Vá para o CRXDE e faça logon como Admin.

14. Crie um novo nó chamado solrIndex em oak:index e defina as seguintes propriedades:

    • tipo:​solr (do tipo String)
    • async:​async (do tipo String)
    • reindex:​true (do tipo Boolean)

15. Salve as alterações.

Configuração recomendada para Solr

Veja abaixo um exemplo de uma configuração básica que pode ser usada com todas as três implantações Solr descritas neste artigo. Ele acomoda os índices de propriedade dedicados que já estão presentes em AEM e não devem ser usados com outras aplicações.

Para usá-lo corretamente, é necessário colocar o conteúdo do arquivo diretamente no Diretório base Solr. No caso de implantações de vários nós, elas devem ir diretamente sob a pasta raiz de cada nó.

Arquivos de configuração de Solr recomendados

Obter arquivo

Ferramentas de indexação AEM

O AEM 6.1 também integra duas ferramentas de indexação presentes no AEM 6.0 como parte do conjunto de ferramentas do Adobe Consulting Services Commons:

1. Explain Query, uma ferramenta projetada para ajudar os administradores a entender como as consultas são executadas;
2. Oak Index Manager, uma interface de usuário da Web para manter os índices existentes.

Agora você pode atingi-los indo até Tools - Operations - Dashboard - Diagnosis da tela de boas-vindas AEM.

Para obter mais informações sobre como usá-los, consulte a documentação do Painel de Operações.

Criação de índices de propriedade via OSGi

O pacote ACS Commons também expõe configurações OSGi que podem ser usadas para criar índices de propriedade.

Você pode acessá-lo no Console da Web procurando por "Garanta o índice de propriedades do Oak".

Solução de problemas de indexação

Podem surgir situações em que as consultas demoram muito para serem executadas e o tempo geral de resposta do sistema está lento.

Esta seção apresenta um conjunto de recomendações sobre o que deve ser feito para rastrear a causa desses problemas e conselhos sobre como resolvê-los.

Preparando informações de depuração para análise

A maneira mais fácil de obter as informações necessárias para a consulta que está sendo executada é através da ferramenta Explicar Consulta. Isso permitirá coletar as informações precisas necessárias para depurar uma consulta lenta sem a necessidade de consultar as informações do nível de log. Isso é desejável se você souber o query que está sendo depurado.

Se isso não for possível por qualquer motivo, você pode coletar os logs de indexação em um único arquivo e usá-lo para solucionar seu problema específico.

Habilitar registro

Para ativar o registro, é necessário ativar os logs de nível DEBUG para as categorias relacionadas à indexação e consultas do Oak. Essas categorias são:

• org.apache.jackrabbit.oak.plugins.index
• org.apache.jackrabbit.oak.query
• com.day.cq.search

A categoria com.day.cq.search só é aplicável se você estiver usando o utilitário QueryBuilder fornecido AEM.

Você pode ativar o registro seguindo este procedimento:

1. Aponte seu navegador para https://serveraddress:port/system/console/slinglog

2. Clique no botão Add new Logger na parte inferior do console.

3. Na linha recém-criada, adicione as categorias mencionadas acima. Você pode usar o sinal + para adicionar mais de uma categoria a um único logger.

4. Escolha DEBUG na lista suspensa Log level.

5. Defina o arquivo de saída como logs/queryDebug.log. Isso correlacionará todos os eventos DEBUG em um único arquivo de log.

6. Execute o query ou renderize a página que está usando a consulta que deseja depurar.

7. Depois de executar a query, volte para o console de log e altere o nível de log do logger recém-criado para INFO.

Configuração de índice

A maneira como o query é avaliado é amplamente afetada pela configuração do índice. É importante obter a configuração do índice para ser analisado ou enviado para oferecer suporte. Você pode obter a configuração como um pacote de conteúdo ou uma representação JSON.

Como na maioria dos casos, a configuração de indexação é armazenada no nó /oak:index no CRXDE, você pode obter a versão JSON em:

https://serveraddress:port/oak:index.tidy.-1.json

Se o índice estiver configurado em um local diferente, altere o caminho de acordo.

Saída de MBean

Em alguns casos, é útil fornecer a saída de MBeans relacionados ao índice para depuração. Você pode fazer isso ao:

1. Vá para o console JMX em:
   https://serveraddress:port/system/console/jmx

2. Procure os seguintes MBeans:

   • Estatísticas do Índice Lucene
   • Estatísticas de suporte do CopyOnRead
   • Estatísticas de Consulta Oak
   • IndexStats

3. Clique em cada MBeans para obter as estatísticas de desempenho. Crie uma captura de tela ou anote-as caso o envio para suporte seja necessário.

Você também pode obter a variante JSON dessas estatísticas nos seguintes URLs:

• https://serveraddress:port/system/sling/monitoring/mbeans/org/apache/jackrabbit/oak/%2522LuceneIndex%2522.tidy.-1.json
• https://serveraddress:port/system/sling/monitoring/mbeans/org/apache/jackrabbit/oak/%2522LuceneIndex%2522.tidy.-1.json
• https://serveraddress:port/system/sling/monitoring/mbeans/org/apache/jackrabbit/oak/%2522LuceneIndex%2522.tidy.-1.json
• https://serveraddress:port/system/sling/monitoring/mbeans/org/apache/jackrabbit/oak/%2522LuceneIndex%2522.tidy.-1.json

Você também pode fornecer saída JMX consolidada via https://serveraddress:port/system/sling/monitoring/mbeans/org/apache/jackrabbit/oak.tidy.3.json. Isso incluiria todos os detalhes do MBean relacionados ao Oak no formato JSON.

Outros detalhes

Você pode coletar detalhes adicionais para ajudar a solucionar o problema, como:

1. A versão do Oak em que sua instância está sendo executada. Você pode ver isso abrindo o CRXDE e observando a versão no canto inferior direito da página de boas-vindas, ou verificando a versão do pacote org.apache.jackrabbit.oak-core.
2. A saída do QueryBuilder Debugger da consulta problemática. O depurador pode ser acessado em: https://serveraddress:port/libs/cq/search/content/querydebug.html