Junto con la transición a Oak en el AEM 6, se realizaron algunos cambios importantes en la forma en que se administran las consultas y los índices. En Jackrabbit 2, todo el contenido se indexaba de forma predeterminada y se podía consultar libremente. En Oak, los índices se deben crear manualmente bajo el nodo oak:index
. Una consulta se puede ejecutar sin índice, pero para conjuntos de datos grandes, se ejecutará muy lentamente o incluso se anulará.
En este artículo se describe cuándo crear índices y cuándo no se necesitan, los trucos para evitar el uso de consultas cuando no son necesarias y las sugerencias para optimizar los índices y consultas para que funcionen lo mejor posible.
Además, asegúrese de leer la documentación de Oak sobre la escritura de consultas e índices. Además de que los índices son un nuevo concepto en la AEM 6, hay diferencias sintácticas en las consultas Oak que deben tenerse en cuenta al migrar código desde una instalación AEM anterior.
Al diseñar la taxonomía de un repositorio, es necesario tener en cuenta varios factores. Estos incluyen controles de acceso, localización, herencia de propiedades de componente y página, entre otros.
Al diseñar una taxonomía que aborde estas preocupaciones, también es importante considerar la "transferibilidad" del diseño de indexación. En este contexto, la transferibilidad es la capacidad de una taxonomía que permite acceder al contenido de forma predecible en función de su ruta. Esto hará que sea más fácil mantener un sistema de mayor rendimiento que uno que requiera la ejecución de muchas consultas.
Además, al diseñar una taxonomía, es importante tener en cuenta si el pedido es importante. En los casos en los que no se requiere orden explícito y se espera un gran número de nodos del mismo nivel, es preferible utilizar un tipo de nodo no ordenado como sling:Folder
o oak:Unstructured
. En los casos en los que se requiera un pedido, nt:unstructured
y sling:OrderedFolder
serían más apropiados.
Dado que las consultas pueden ser una de las operaciones más gravosas que se realizan en un sistema AEM, es recomendable evitarlas en los componentes. La ejecución de varias consultas cada vez que se procesa una página puede degradar el rendimiento del sistema. Existen dos estrategias que pueden utilizarse para evitar la ejecución de consultas al procesar componentes: nodos que atraviesan y resultados de recuperación previa.
Si el repositorio está diseñado de tal manera que permite conocer previamente la ubicación de los datos requeridos, se puede implementar el código que recupera estos datos de las rutas necesarias sin tener que ejecutar consultas para encontrarlos.
Un ejemplo de esto sería la representación de contenido que se ajusta a una determinada categoría. Un método sería organizar el contenido con una propiedad de categoría que se pueda consultar para rellenar un componente que muestre elementos en una categoría.
Un mejor método sería estructurar este contenido en una taxonomía por categoría para que se pueda recuperar manualmente.
Por ejemplo, si el contenido se almacena en una taxonomía similar a:
/content/myUnstructuredContent/parentCategory/childCategory/contentPiece
el nodo /content/myUnstructuredContent/parentCategory/childCategory
simplemente se puede recuperar, sus elementos secundarios se pueden analizar y utilizar para procesar el componente.
Además, cuando se trata de un conjunto de resultados pequeño o homogéneo, puede ser más rápido recorrer el repositorio y recopilar los nodos necesarios, en lugar de crear una consulta para devolver el mismo conjunto de resultados. Como consideración general, deben evitarse consultas cuando sea posible.
A veces, el contenido o los requisitos que rodean al componente no permiten el uso de la transversal de nodos como método para recuperar los datos requeridos. En estos casos, es necesario ejecutar las consultas necesarias antes de que se procese el componente, de modo que se garantice un rendimiento óptimo para el usuario final.
Si los resultados necesarios para el componente se pueden calcular en el momento de su creación y no se espera que el contenido cambie, la consulta se puede ejecutar cuando el autor aplique la configuración en el cuadro de diálogo.
Si los datos o el contenido cambian con regularidad, la consulta se puede ejecutar según una programación o mediante un detector para actualizaciones de los datos subyacentes. A continuación, los resultados se pueden escribir en una ubicación compartida del repositorio. Cualquier componente que necesite estos datos podrá extraer los valores de este nodo único sin necesidad de ejecutar una consulta en tiempo de ejecución.
Al ejecutar una consulta que no utiliza un índice, se registrarán advertencias relativas a la transversal de nodos. Si se trata de una consulta que se va a ejecutar con frecuencia, se debe crear un índice. Para determinar qué índice utiliza una determinada consulta, se recomienda la herramienta de Consulta Explicar. Para obtener más información, el registro DEBUG puede habilitarse para las API de búsqueda relevantes.
Después de modificar una definición de índice, es necesario volver a crear el índice (reindexado). Dependiendo del tamaño del índice, esto puede tardar algún tiempo en completarse.
Al ejecutar consultas complejas, puede haber casos en los que se desglose la consulta en varias consultas más pequeñas y se unan los datos a través del código después de que el hecho tenga un mayor rendimiento. La recomendación para estos casos es comparar el rendimiento de los dos enfoques para determinar qué opción sería mejor para el caso de uso en cuestión.
AEM permite escribir consultas de una de las tres maneras siguientes:
Aunque todas las consultas se convierten a SQL2 antes de ejecutarse, la sobrecarga de conversión de consultas es mínima y, por lo tanto, la preocupación buena al elegir un lenguaje de consulta será la legibilidad y el nivel de comodidad del equipo de desarrollo.
Al utilizar QueryBuilder, determinará el recuento de resultados de forma predeterminada, que es más lento en Oak en comparación con las versiones anteriores de Jackrabbit. Para compensarlo, puede utilizar el parámetro adivinenTotal.
Como con cualquier lenguaje de consulta, el primer paso para optimizar una consulta es comprender cómo se ejecutará. Para habilitar esta actividad, puede utilizar la herramienta de Consulta Explicar que forma parte del Panel de operaciones. Con esta herramienta se puede conectar y explicar una consulta. Se mostrará una advertencia si la consulta generará problemas con un repositorio grande, así como con el tiempo de ejecución y los índices que se utilizarán. La herramienta también puede cargar una lista de consultas lentas y populares que se pueden explicar y optimizar.
Para obtener información adicional sobre cómo Oak está eligiendo qué índice utilizar y cómo el motor de consulta está ejecutando una consulta, se puede agregar una configuración de registro DEBUG para los siguientes paquetes:
Asegúrese de eliminar este registrador cuando haya terminado de depurar su consulta, ya que generará una gran cantidad de actividad y, finalmente, podrá rellenar su disco con archivos de registro.
Para obtener más información sobre cómo hacerlo, consulte la documentación de registro.
Lucene registra un grano JMX que proporciona detalles sobre el contenido indexado, incluyendo el tamaño y el número de documentos presentes en cada uno de los índices.
Puede acceder a ella accediendo a la consola de JMX en https://server:port/system/console/jmx
Una vez que haya iniciado sesión en la consola JMX, realice una búsqueda de Estadísticas de índice de Lucene para encontrarlas. Puede encontrar otras estadísticas de índice en el MBean IndexStats.
Para obtener estadísticas de consulta, consulte el MBean llamado Estadísticas de Consulta de Oak.
Si desea explorar los índices utilizando una herramienta como Luke, deberá utilizar la consola Oak para volcar el índice desde NodeStore
a un directorio del sistema de archivos. Para obtener instrucciones sobre cómo hacerlo, lea la documentación de Lucene.
También puede extraer los índices del sistema en formato JSON. Para ello, debe acceder a https://server:port/oak:index.tidy.-1.json
Durante el desarrollo
Configure umbrales bajos para oak.queryLimitInMemory
(p. ej. 10000) y roble. queryLimitReads
(p. ej. 5000) y optimice la consulta costosa al visitar una excepción UnsupportedOperationException que dice "La consulta lee más de nodos x…".
Esto ayuda a evitar consultas que requieren muchos recursos (por ejemplo: no está respaldada por ningún índice o está respaldada por un índice de cobertura menos elevado). Por ejemplo: una consulta que lee 1 millón de nodos provocaría un aumento de la E/S y tendría un impacto negativo en el rendimiento general de la aplicación. Cualquier consulta que falle debido a límites superiores debe analizarse y optimizarse.
Monitoree los registros de consultas que activan el consumo de memoria traversal de nodos grandes o de gran consumo de memoria de pila: "
*WARN* ... java.lang.UnsupportedOperationException: The query read or traversed more than 100000 nodes. To avoid affecting other tasks, processing was stopped.
Monitoree los registros de consultas que activan el consumo de memoria de gran pila:
*WARN* ... java.lang.UnsupportedOperationException: The query read more than 500000 nodes in memory. To avoid running out of memory, processing was stopped
Para las versiones de AEM 6.0 a 6.2, puede ajustar el umbral para el recorrido de nodos mediante parámetros JVM en la secuencia de comandos de inicio de AEM para evitar que grandes consultas sobrecarguen el entorno.
Los valores recomendados son:
-Doak.queryLimitInMemory=500000
-Doak.queryLimitReads=100000
En AEM 6.3, los dos parámetros anteriores están preconfigurados como OOTB y pueden persistir a través de OSGi QueryEngineSettings.
Más información disponible en : https://jackrabbit.apache.org/oak/docs/query/query-engine.html#Slow_Queries_and_Read_Limits
La primera pregunta que se debe hacer al crear o optimizar índices es si realmente son necesarios para una situación determinada. Si sólo va a ejecutar la consulta en cuestión una vez o sólo ocasionalmente y en un momento de poca actividad para el sistema a través de un proceso por lotes, puede que sea mejor no crear un índice en absoluto.
Después de crear un índice, cada vez que se actualicen los datos indexados, también se debe actualizar el índice. Dado que esto conlleva implicaciones de rendimiento para el sistema, los índices solo deben crearse cuando son realmente necesarios.
Además, los índices solo son útiles si los datos contenidos en el índice son lo suficientemente únicos como para garantizarlos. Considere un índice en un libro y los temas que abarca. Al indexar un conjunto de temas en un texto, normalmente habrá cientos o miles de entradas, lo que le permite saltar rápidamente a un subconjunto de páginas para encontrar rápidamente la información que busca. Si ese índice sólo tuviera dos o tres entradas, cada una de las cuales apunte a varios cientos de páginas, el índice no sería muy útil. Este mismo concepto se aplica a los índices de base de datos. Si solo hay un par de valores únicos, el índice no será muy útil. Dicho esto, un índice también puede llegar a ser demasiado grande para ser útil. Para ver las estadísticas de índice, consulte Estadísticas de índice más arriba.
Los índices de Lucene se introdujeron en Oak 1.0.9 y oferta algunas optimizaciones poderosas sobre los índices de propiedades que se introdujeron en el lanzamiento inicial de AEM 6. Cuando decida si desea utilizar índices de Lucene o índices de propiedades, tenga en cuenta lo siguiente:
En general, se recomienda utilizar los índices de Lucene a menos que haya una necesidad imperiosa de utilizar los índices de propiedades para que pueda obtener los beneficios de un mayor rendimiento y flexibilidad.
AEM también es compatible con la indexación de Solr de forma predeterminada. Esto se aprovecha principalmente para admitir la búsqueda de texto completo, pero también puede utilizarse para admitir cualquier tipo de consulta JCR. Se debe considerar Solr cuando las instancias de AEM no tienen la capacidad de CPU para manejar la cantidad de consultas necesarias en implementaciones intensivas de búsqueda, como los sitios web impulsados por la búsqueda con un gran número de usuarios simultáneos. De lo contrario, Solr se puede implementar en un enfoque basado en bots para aprovechar algunas de las características más avanzadas de la plataforma.
Los índices de solr pueden configurarse para ejecutarse integrados en el servidor de AEM para entornos de desarrollo o pueden descargarse en una instancia remota para mejorar la escalabilidad de búsqueda en los entornos de producción y ensayo. Aunque la descarga de la búsqueda mejorará la escalabilidad, introducirá latencia y por ello no se recomienda a menos que sea necesario. Para obtener más información sobre cómo configurar la integración de Solr y cómo crear índices de Solr, consulte la documentación de indización y Consultas de Oak.
Si se toma el enfoque de búsqueda integrada de Solr, se podría descargar la indización en un servidor Solr. Si se utilizan las características más avanzadas del servidor Solr mediante un método basado en el explorador, será necesario realizar un trabajo de configuración adicional. Headwire ha creado un conector de código abierto para acelerar estos tipos de implementaciones.
La desventaja de este enfoque es que aunque de forma predeterminada, AEM consultas respetarán las ACL y, por lo tanto, ocultarán los resultados a los que un usuario no tiene acceso, la externalización de la búsqueda en un servidor Solr no admitirá esta función. Si la búsqueda se va a externalizar de esta manera, se debe tener especial cuidado en garantizar que los usuarios no reciban los resultados que no deben ver.
En los casos de uso potencial en que este enfoque pueda ser adecuado se dan casos en que es posible que sea necesario agregar datos de búsqueda de múltiples fuentes. Por ejemplo: puede tener un sitio alojado en AEM, así como un segundo sitio alojado en una plataforma de terceros. Solr se puede configurar para rastrear el contenido de ambos sitios y almacenarlo en un índice agregado. Esto permitiría realizar búsquedas entre sitios.
La documentación de Oak para Lucene indexa listas que deben tenerse en cuenta al diseñar índices:
Si la consulta utiliza diferentes restricciones de ruta, utilice evaluatePathRestrictions
. Esto permitirá que la consulta devuelva el subconjunto de resultados bajo la ruta especificada y luego los filtre según la consulta. De lo contrario, la consulta buscará todos los resultados que coincidan con los parámetros de consulta en el repositorio y los filtrará según la ruta.
Si la consulta utiliza la ordenación, tenga una definición de propiedad explícita para la propiedad ordenada y establezca ordered
en true
para ella. Esto permitirá que los resultados se ordenen como tales en el índice y se ahorren en costosas operaciones de ordenación en tiempo de ejecución de la consulta.
Ponga lo que se necesita en el índice. Añadir características o propiedades innecesarias hará que el índice crezca y ralentice el rendimiento.
En un índice de propiedades, tener un nombre de propiedad único ayudaría a reducir el tamaño de un índice, pero para los índices de Lucene, se debería utilizar nodeTypes
y mixins
para lograr índices coherentes. Consultar un nodeType
o mixin
específico será más eficaz que consultar nt:base
. Al utilizar este método, defina indexRules
para el nodeTypes
en cuestión.
Si las consultas solo se ejecutan bajo determinadas rutas, cree dichos índices debajo de dichas rutas. No es necesario que los índices estén activos en la raíz del repositorio.
Se recomienda utilizar un único índice cuando todas las propiedades indizadas estén relacionadas para permitir que Lucene evalúe tantas restricciones de propiedad como sea posible de forma nativa. Además, una consulta solo usará un índice, aunque realice una combinación.
En los casos en que el NodeStore
se almacena de forma remota, se puede habilitar una opción llamada CopyOnRead
. La opción hará que el índice remoto se escriba en el sistema de archivos local cuando se lea. Esto puede ayudar a mejorar el rendimiento de las consultas que a menudo se ejecutan con estos índices remotos.
Esto se puede configurar en la consola OSGi bajo el servicio LuceneIndexProvider y se habilita de forma predeterminada a partir de Oak 1.0.13.
Al eliminar un índice, siempre se recomienda deshabilitar temporalmente el índice estableciendo la propiedad type
en disabled
y realizar pruebas para asegurarse de que la aplicación funciona correctamente antes de eliminarla. Tenga en cuenta que un índice no se actualiza mientras está deshabilitado, por lo que es posible que no tenga el contenido correcto si se vuelve a activar y que sea necesario volver a indexarlo.
Después de quitar un índice de propiedad en una instancia de TarMK, será necesario ejecutar la compactación para recuperar cualquier espacio en disco que se estuviera utilizando. En el caso de los índices de Lucene, el contenido del índice real permanece en BlobStore, por lo que se requiere una recopilación de elementos no utilizados del almacén de datos.
Al eliminar un índice en una instancia de MongoDB, el costo de eliminación es proporcional al número de nodos en el índice. Dado que la eliminación de un índice grande puede causar problemas, el método recomendado es deshabilitar el índice y eliminarlo únicamente durante una ventana de mantenimiento, utilizando una herramienta como oak-mongo.js. Tenga en cuenta que este método no debe emplearse para el contenido normal de nodos, ya que puede introducir incoherencias de datos.
Para obtener más información sobre oak-mongo.js, consulte la sección Herramientas de la línea de comandos de la documentación de Oak.
Esta sección describe los sólo motivos aceptables para volver a indexar los índices Oak.
Fuera de los motivos que se describen a continuación, si se inician los reíndices de Oak, no cambiará el comportamiento o resolverá los problemas y aumentará innecesariamente la carga en AEM.
Se evitará la reindexación de los índices de roble, a menos que se trate de una de las razones que figuran en los cuadros siguientes.
Antes de consultar las tablas siguientes para determinar si es útil volver a indexar, siempre verificar:
Las únicas condiciones no aceptables para volver a indexar los índices de roble son si la configuración de un índice de roble ha cambiado.
La reindexación debe abordarse siempre teniendo debidamente en cuenta su impacto en AEM rendimiento general y durante períodos de baja actividad o ventanas de mantenimiento.
A continuación se detallan los posibles problemas, junto con las resoluciones:
Se aplica para/si:
Síntomas:
Cómo verificar:
jcr:created
o jcr:lastModified
de los nodos que faltan con respecto al tiempo de modificación del índiceCómo resolver:
Volver a indizar el índice de lucene
Alternativamente, toque (realice una operación de escritura benigna) a los nodos que faltan
Se aplica para/si:
Síntomas:
Cómo verificar:
diffStoredIndexDefinition
.Cómo resolver:
Versiones Oak anteriores a la versión 1.6:
Versiones Oak 1.6+
Si los cambios no afectan al contenido existente, solo se necesita una actualización
De lo contrario, vuelva a indexar el índice de luminancia
En la siguiente tabla se describen las únicas situaciones de error aceptables y excepcionales en las que la reindexación de índices de roble resolverá el problema.
Si se produce un problema en AEM que no coincide con los criterios descritos a continuación, haga no volver a indexar ningún índice, ya que no resolverá el problema.
A continuación se detallan los posibles problemas, junto con las resoluciones:
Se aplica para/si:
Síntomas:
Cómo verificar:
Cómo resolver:
Realizar una comprobación de repositorio de travesía; por ejemplo:
http://localhost:4502/system/console/repositorycheck
recorrer el repositorio determina si faltan otros binarios (además de los archivos de lucene)
Si faltan archivos binarios que no sean índices de lucene, restaure desde la copia de seguridad
De lo contrario, re-indexar todos índices de lucene
Nota:
Esta condición indica un almacén de datos mal configurado que puede resultar en CUALQUIER binario (p. ej. recursos binarios) para desaparecer.
En este caso, restaure a la última versión correcta conocida del repositorio para recuperar todos los binarios que faltan.
Se aplica para/si:
Síntomas:
Cómo verificar:
El AsyncIndexUpdate
(cada 5s) fallará con una excepción en error.log:
...a Lucene index file is corrupt...
Cómo resolver:
Eliminar la copia local del índice de lucene
crx-quickstart/repository/index
Si esto no resuelve el problema y las excepciones AsyncIndexUpdate
persisten:
En AEM 6.4, oak-run.jar es el ÚNICO método admitido para volver a indexar en repositorios MongoMK o RDBMK.
Use oak-run.jar para volver a indexar el índice de propiedades
Establezca la propiedad async-reindex en true en el índice de propiedades
[oak:queryIndexDefinition]@reindex-async=true
Vuelva a indexar el índice de propiedades de forma asíncrona mediante la consola web mediante el MBean de PropertyIndexAsyncReindex;
por ejemplo,
Utilice oak-run.jar para volver a indexar el índice de la propiedad Lucene.
Establezca la propiedad async-reindex en true en el índice de la propiedad lucene
[oak:queryIndexDefinition]@reindex-async=true
La sección anterior resume y enmarca la guía de reindexación de Oak de la documentación de Apache Oak en el contexto de AEM.
La extracción previa del texto es el proceso de extraer y procesar texto de los binarios, directamente desde el almacén de datos a través de un proceso aislado, y exponer directamente el texto extraído a reindexaciones posteriores de los índices Oak.
/oak:index/damAssetLucene
.Reindexación de un índice de luminancia existente con extracción binaria habilitada
Compatibilidad con la implementación de un nuevo índice de lucene para AEM con la extracción binaria habilitada
La extracción previa de texto no se puede utilizar para contenido nuevo agregado al repositorio, ni es necesaria.
El nuevo contenido se agrega al repositorio de forma natural e incremental mediante el proceso de indexación de texto completo asincrónico (de forma predeterminada, cada 5 segundos).
Bajo el funcionamiento normal de AEM, por ejemplo, cargar recursos a través de la interfaz de usuario web o mediante la ingesta programática de recursos, AEM indexará automáticamente e incrementalmente el nuevo contenido binario con texto completo. Debido a que la cantidad de datos es incremental y relativamente pequeña (aproximadamente la cantidad de datos que se puede mantener en el repositorio en 5 segundos), AEM realizar la extracción de texto completo de los binarios durante la indexación sin afectar el rendimiento general del sistema.
Se volverá a indexar un índice de lucene que realiza una extracción binaria de texto completo o se implementará un nuevo índice que incluirá binarios de índice de texto completo de contenido existente
El contenido (binarios) del que se debe extraer texto previamente debe estar en el repositorio
Ventana de mantenimiento para generar el archivo CSV Y para realizar la reindexación final
Versión Oak: 1.0.18+, 1.2.3+
oak-run.jarversion 1.7.4+
Una carpeta o un recurso compartido del sistema de archivos para almacenar el texto extraído al que se puede acceder desde las instancias de AEM de indexación
Los comandos oak-run.jar que se describen a continuación están totalmente enumerados en https://jackrabbit.apache.org/oak/docs/query/pre-extract-text.html
El diagrama y los pasos anteriores sirven para explicar y complementar los pasos de preextracción de texto técnico descritos en la documentación de Apache Oak.
Generar lista de contenido para extraer previamente
Ejecute el paso 1(a-b) durante una ventana de mantenimiento/período de bajo uso a medida que se atraviesa el almacén de nodos durante esta operación, lo que puede suponer una carga significativa en el sistema.
1 bis. Ejecute oak-run.jar --generate
para crear una lista de nodos que preextraerán su texto.
1 ter. La lista de nodos (1a) se almacena en el sistema de archivos como archivo CSV
Tenga en cuenta que todo el almacén de nodos se recorre (según lo especificado por las rutas en el comando oak-run) cada vez que se ejecuta --generate
y se crea un archivo CSV nuevo. El archivo CSV se no se reutiliza entre ejecuciones discretas del proceso de extracción previa del texto (pasos 1 a 2).
Extraer texto previamente al sistema de archivos
El paso 2(a-c) se puede ejecutar durante el funcionamiento normal de AEM si sólo interactúa con el almacén de datos.
2 bis. Ejecute oak-run.jar --tika
para extraer previamente texto para los nodos binarios enumerados en el archivo CSV generado en (1b)
2 ter. El proceso iniciado en (2a) accede directamente a los nodos binarios definidos en el CSV en el Almacén de datos y extrae texto.
2 quater. El texto extraído se almacena en el sistema de archivos en un formato que el proceso de reindexación Oak no permite (3a)
El texto extraído previamente se identifica en el CSV mediante la huella digital binaria. Si el archivo binario es el mismo, se puede utilizar el mismo texto preextraído en AEM instancias. Dado que AEM Publish suele ser un subconjunto de AEM Author, el texto extraído previamente de AEM Author también se puede utilizar para volver a indexar AEM Publish (suponiendo que AEM Publish tiene acceso al sistema de archivos a los archivos de texto extraídos).
El texto extraído previamente se puede añadir de forma incremental a lo largo del tiempo. La extracción previa del texto omitirá la extracción de los binarios extraídos anteriormente, por lo que es recomendable mantener el texto extraído previamente en caso de que la reindexación deba volver a producirse en el futuro (suponiendo que el contenido extraído no sea demasiado grande. Si es así, evalúe el compactado del contenido en el interín, ya que el texto se comprime bien).
Volver a indexar índices Oak, abastecimiento de texto completo a partir de archivos de texto extraído
Ejecute la reindexación (pasos 3a-b) durante un período de mantenimiento/bajo uso, ya que durante esta operación se atraviesa el almacén de nodos, lo que puede suponer una carga significativa en el sistema.
3 bis. La reindexación de los índices de Lucene se invoca en AEM
3 ter. La configuración OSGi de Apache Jackrabbit Oak DataStore PreExtractTextProvider (configurada para apuntar el texto extraído a través de una ruta de sistema de archivos) indica a Oak que debe buscar texto completo a partir de los Archivos extraídos y evita directamente ingresar y procesar los datos almacenados en el repositorio.