Résolution des problèmes de lenteur des requêtes

Classifications des requêtes lentes

Dans AEM, les requêtes lentes sont classées dans 3 catégories principales, suivant le degré de gravité :

  1. Requêtes sans index

    • Requêtes qui ne sont pas résolues sur un index et qui parcourent le contenu du JCR pour collecter des résultats

  2. Requêtes mal limitées

    • Requêtes qui sont résolues sur un index, mais qui doivent parcourir toutes les entrées d’index pour collecter des résultats

  3. Requêtes avec jeu de résultats volumineux

    • Requêtes qui renvoient un très grand nombre de résultats

Les 2 premières catégories de requêtes (sans index et mal limitées) sont lentes car elles contraignent le moteur de requête Oak à inspecter chaque résultat potentiel (nœud de contenu ou entrée d’index) afin d’identifier celui qui fait partie du jeu de résultats réel.

Le fait d’inspecter chaque résultat potentiel est désigné sous le nom de traversée.

Chaque résultat potentiel devant être inspecté, le coût lié à l’identification du jeu de résultats réel augmente de façon linéaire avec le nombre de résultats potentiels.

L’ajout de restrictions de requête et l’optimisation des index permettent de stocker les données d’index dans un format optimisé, ce qui se traduit par une récupération rapide des résultats. En outre, cela réduit la nécessité de recourir à une inspection linéaire des jeux de résultats potentiels, voire permet de s’en passer complètement.

Par défaut, dans AEM 6.3, lorsqu’une traversée de 100 000 est atteinte, la requête échoue et génère une exception. Cette limite n’existe pas par défaut dans les versions antérieures à AEM 6.3 mais elle peut être définie via la configuration OSGi des paramètres du moteur de requête Apache Jackrabbit et le bean JMX QueryEngineSettings (propriété LimitReads).

Détection des requêtes sans index

Pendant le développement

Expliquez toutes les requêtes et assurez-vous que leurs plans de requête ne contiennent pas l’explication /* traverse. Exemple de traversée du plan de requête :

  • PLAN : [nt:unstructured] as [a] /* traverse "/content//*" where ([a].[unindexedProperty] = 'some value') and (isdescendantnode([a], [/content])) */

Après le déploiement

  • Contrôlez le journal error.log à la recherche de requêtes de traversée sans index :

    • *INFO* org.apache.jackrabbit.oak.query.QueryImpl Traversal query (query without index) ... ; consider creating and index
    • Ce message n’est consigné que si aucun index n’est disponible et si la requête traverse potentiellement de nombreux nœuds. Les messages ne sont pas consignés si un index est disponible, mais que la quantité à traverser est faible et, par conséquent, rapide.

  • Rendez-vous sur la console des opérations Performances des requêtes d’AEM et expliquez les requêtes lentes en recherchant les explications de traversée ou de requête sans index.

Détection des requêtes mal limitées

Pendant le développement

Expliquez toutes les requêtes et assurez-vous qu’elles sont résolues sur un index optimisé afin de correspondre aux restrictions de propriété de la requête.

  • Dans une couverture de plan de requête idéale, indexRules est défini pour toutes les restrictions de propriété et, au minimum, pour les restrictions de propriété les plus strictes de la requête.
  • Les requêtes qui trient les résultats doivent être résolues sur un index de propriété Lucene avec des règles d’index pour les propriétés de tri qui définissent orderable=true..

Par exemple, l’index cqPageLucene par défaut ne comprend pas de règle d’index pour jcr:content/cq:tags.

Avant d’ajouter la règle d’index cq:tags

  • Règle d’index cq:tags

    • N’existe pas en version prête à l’emploi.

  • Requête Query Builder

    type=cq:Page
property=jcr:content/cq:tags
property.value=my:tag

  • Plan de requête

    [cq:Page] as [a] /* lucene:cqPageLucene(/oak:index/cqPageLucene?lang=fr) *:* where [a].[jcr:content/cq:tags] = 'my:tag' */

Cette requête est résolue sur l’index cqPageLucene. Cependant, étant donné qu’il n’existe pas de règle d’index de propriété pour jcr:content ou cq:tags, lorsque cette restriction est évaluée, chaque enregistrement de l’index cqPageLucene est vérifié afin de déterminer une correspondance. Cela signifie que si l’index contient un million de nœuds cq:Page, un million d’enregistrements sont vérifiés pour déterminer le jeu de résultats.

Après avoir ajouté la règle d’index cq:tags

  • Règle d’index cq:tags

    /oak:index/cqPageLucene/indexRules/cq:Page/properties/cqTags
@name=jcr:content/cq:tags
@propertyIndex=true

  • Requête Query Builder

    type=cq:Page
property=jcr:content/cq:tags
property.value=myTagNamespace:myTag

  • Plan de requête

    [cq:Page] as [a] /* lucene:cqPageLucene(/oak:index/cqPageLucene?lang=fr) jcr:content/cq:tags:my:tag where [a].[jcr:content/cq:tags] = 'my:tag' */

L’ajout de la règle d’index pour jcr:content/cq:tags dans l’index cqPageLucene permet de stocker les données cq:tags dans un format optimisé.

Lors de l’exécution d’une requête avec la restriction jcr:content/cq:tags, l’index peut rechercher des résultats en fonction de leur valeur. Cela signifie que si 100 nœuds cq:Page ont myTagNamespace:myTag comme valeur, seuls ces 100 résultats sont renvoyés. Les 999 000 autres résultats sont exclus des contrôles de restriction, ce qui améliore les performances d’un facteur 10 000.

Il va sans dire que des restrictions de requête supplémentaires réduisent les jeux de résultats éligibles et améliorent encore l’optimisation des requêtes.

De même, en l’absence de règle d’index supplémentaire pour la propriété cq:tags, même une requête en texte intégral avec une restriction définie sur cq:tags s’avérerait peu performante, dans la mesure où les résultats de l’index renverraient toutes les correspondances en texte intégral. La restriction définie sur cq:tags serait filtrée par la suite.

Les listes de contrôle d’accès constituent une autre cause de filtrage post index. Bien souvent, il n’en est pas tenu compte en cours de développement. Tâchez de vous assurer que la requête ne renvoie pas de chemins d’accès auxquels l’utilisateur risque ne pas avoir accès. En règle générale, cela passe par une meilleure structure de contenu, ainsi que la définition d’une restriction de chemin d’accès appropriée sur la requête.

Pour déterminer si l’index Lucene renvoie un grand nombre de résultats pour un sous-ensemble de très petite taille en tant que résultat de la requête, une méthode pratique consiste à activer les journaux DÉBOGUER pour org.apache.jackrabbit.oak.plugins.index.lucene.LucenePropertyIndex et à observer le nombre de documents chargés depuis l’index. Le nombre de résultats finaux par rapport au nombre de documents chargés ne devrait pas être disproportionné. Pour plus d’informations, consultez la section Journalisation.

Après le déploiement

  • Contrôlez le error.log à la recherche de requêtes de traversée :

    • *WARN* org.apache.jackrabbit.oak.spi.query.Cursors$TraversingCursor Traversed ### nodes ... consider creating an index or changing the query

  • Rendez-vous sur la console des opérations Performances des requêtes d’AEM et expliquez les requêtes lentes en recherchant les plans de requête qui ne résolvent pas les restrictions de propriété de requête sur des règles de propriété d’index.

Détection des requêtes avec jeu de résultats volumineux

Pendant le développement

Définissez des seuils bas pour oak.queryLimitInMemory (par exemple, 10000) et oak.queryLimitReads (par exemple, 5000) et optimisez les requêtes coûteuses lorsque vous obtenez une exception UnsupportedOperationException indiquant : « la requête lit plus de x nœuds… » ("The query read more than x nodes…").

Cela permet d’éviter les requêtes gourmandes en ressources (c’est-à-dire non soutenues par un index ou soutenues par un index moins étendu). Par exemple, une requête qui lit 1 million de nœuds générerait un grand nombre d’E/S et aurait un impact négatif sur les performances globales de l’application. Par conséquent, toute requête qui échoue en raison des limites ci-dessus doit être analysée et optimisée.

Après le déploiement

  • Surveillez les journaux à la recherche de requêtes déclenchant une traversée de nœuds importante ou une consommation élevée de mémoire de tas : ``

    • *WARN* ... java.lang.UnsupportedOperationException: The query read or traversed more than 100000 nodes. To avoid affecting other tasks, processing was stopped.
    • Optimisez la requête afin de réduire le nombre de nœuds parcourus transversalement.

  • Surveillez les journaux à la recherche de requêtes déclenchant une consommation importante de mémoire de tas :

    • *WARN* ... java.lang.UnsupportedOperationException: The query read more than 500000 nodes in memory. To avoid running out of memory, processing was stopped
    • Optimisez la requête pour réduire la consommation de mémoire de tas.

Pour les versions d’AEM 6.0 à 6.2, vous pouvez ajuster le seuil du parcours transversal des nœuds à l’aide des paramètres JVM du script de démarrage AEM pour éviter que les requêtes volumineuses ne surchargent l’environnement. Les valeurs recommandées sont les suivantes :

  • -Doak.queryLimitInMemory=500000
  • -Doak.queryLimitReads=100000

Dans AEM 6.3, les 2 paramètres ci-dessus sont préconfigurés par défaut et peuvent être modifiés dans les paramètres OSGi QueryEngineSettings.

Plus d’informations disponibles sous : https://jackrabbit.apache.org/oak/docs/query/query-engine.html#Slow_Queries_and_Read_Limits.

Optimisation des performances des requêtes

S’agissant de l’optimisation des performances des requêtes dans AEM, la devise est :

« Plus il y a de restrictions, mieux c’est ! »

Voici un aperçu des réglages recommandés pour garantir les performances des requêtes. Commencez par optimiser la requête, qui est une opération plus discrète, puis, si nécessaire, optimisez les définitions d’index.

Réglage de l’instruction de requête

AEM prend en charge les langages de requête suivants :

  • Query Builder
  • JCR-SQL2
  • XPath

Query Builder est utilisé dans l’exemple suivant, car il s’agit du langage de requête employé le plus couramment par les développeurs AEM. Cependant, les mêmes principes s’appliquent également à JCR-SQL2 et XPath.

  1. Ajoutez une restriction de type de nœud, de sorte que la requête soit résolue sur un index de propriété Lucene existant.

  • Requête non optimisée

    property=jcr:content/contentType
property.value=article-page

  • Requête optimisée

    type=cq:Page
property=jcr:content/contentType
property.value=article-page

    Dans le cas des requêtes dépourvues d’une restriction du type de nœud, AEM suppose qu’il s’agit du type de nœud nt:base, dont chaque nœud d’AEM est un sous-type, ce qui se traduit effectivement par l’absence de restriction de ce type.

    Le fait de définir type=cq:Page limite cette requête aux seuls nœuds cq:Page et résout la requête sur l’index cqPageLucene d’AEM, ce qui limite les résultats à un sous-ensemble de nœuds (uniquement les nœuds cq:Page) dans AEM.

  1. Réglez la restriction de type de nœud de la requête, de sorte que cette dernière soit résolue sur un index de propriété Lucene existant.

  • Requête non optimisée

    type=nt:hierarchyNode
property=jcr:content/contentType
property.value=article-page

  • Requête optimisée

    type=cq:Page
property=jcr:content/contentType
property.value=article-page

    nt:hierarchyNode est le type de nœud parent de cq:Page. En supposant que jcr:content/contentType=article-page soit appliqué uniquement aux nœuds cq:Page au moyen de notre application personnalisée, cette requête ne renverra que des nœuds cq:Page, où jcr:content/contentType=article-page. Il s’agit toutefois d’une restriction sous-optimale, pour les raisons suivantes :

    • Un autre nœud hérite de nt:hierarchyNode (par exemple, dam:Asset) augmentant ainsi inutilement le jeu de résultats potentiels.
    • Il n’existe aucun index fourni par AEM pour nt:hierarchyNode, car il y en a un qui est fourni pour cq:Page.
      Le fait de définir type=cq:Page limite cette requête aux seuls nœuds cq:Page et résout la requête sur l’index cqPageLucene d’AEM, ce qui limite les résultats à un sous-ensemble de nœuds (uniquement les nœuds cq:Page) dans AEM.
  1. Vous pouvez également régler la ou les restrictions de propriété, de sorte que la requête soit résolue sur un index de propriété existant.

  • Requête non optimisée

    property=jcr:content/contentType
property.value=article-page

  • Requête optimisée

    property=jcr:content/sling:resourceType
property.value=my-site/components/structure/article-page

    Le fait de définir la restriction de propriété jcr:content/contentType (une valeur personnalisée) sur la propriété bien connue sling:resourceType permet à la requête d’être résolue sur l’index de propriété slingResourceType, lequel indexe tout le contenu en fonction de sling:resourceType.

    Les index de propriété (contrairement aux index de propriété Lucene) conviennent mieux lorsque la requête ne fait pas de distinction par type de nœud et qu’une seule restriction de propriété domine le jeu de résultats.

  1. Ajoutez la restriction de chemin la plus stricte possible à la requête. Par exemple, préférez /content/my-site/us/en à /content/my-site, ou /content/dam à /.

  • Requête non optimisée

    type=cq:Page
path=/content
property=jcr:content/contentType
property.value=article-page

  • Requête optimisée

    type=cq:Page
path=/content/my-site/us/en
property=jcr:content/contentType
property.value=article-page

    Limiter la restriction de chemin d’accès de path=/content à path=/content/my-site/us/en permet aux index de réduire le nombre d’entrées d’index qui doivent être inspectées. Lorsque la requête permet une excellente restriction du chemin d’accès, au-delà du simple /content ou /content/dam, assurez-vous que evaluatePathRestrictions=true est associé à l’index.

    Notez que l’utilisation de evaluatePathRestrictions augmente la taille de l’index.

  1. Si possible, évitez d’utiliser des fonctions/opérations de requête telles que LIKE et fn:XXXX, car leur coût évolue en fonction du nombre de résultats basés sur une restriction.

  • Requête non optimisée

    type=cq:Page
property=jcr:content/contentType
property.operation=like
property.value=%article%

  • Requête optimisée

    type=cq:Page
fulltext=article
fulltext.relPath=jcr:content/contentType

    L’évaluation de la condition LIKE est lente car aucun index ne peut être utilisé si le texte commence par un caractère générique ("%…’). La condition jcr:contains autorise un index en texte intégral et est, de ce fait, à privilégier. Pour cela, l’index de propriété Lucene doit présenter indexRule pour jcr:content/contentType avec analayzed=true.

    L’utilisation de fonctions de requêtes telles que fn:lowercase(..) peut rendre l’optimisation plus difficile car il n’existe pas d’équivalents plus rapides (hormis des configurations d’analyseur d’index plus complexes et moins discrètes). Il est préférable d’identifier d’autres restrictions d’étendue afin d’améliorer les performances globales des requêtes, ce qui exige que les fonctions s’exécutent sur le plus petit jeu possible de résultats potentiels.

  1. Ce réglage est spécifique à Query Builder et ne s’applique pas à JCR-SQL2 ni à XPath.

    Utilisez le paramètre guessTotal de Query Builder si le jeu complet de résultats n’est pas nécessaire immédiatement.

    • Requête non optimisée

      type=cq:Page
path=/content

    • Requête optimisée

      type=cq:Page
path=/content
p.guessTotal=100

    Lorsque la requête s’exécute rapidement mais que le nombre de résultats est élevé, le paramètre guessTotal constitue un élément d’optimisation essentiel pour les requêtes Query Builder.

    Le paramètre p.guessTotal=100 indique à Query Builder de ne collecter que les 100 premiers résultats et de définir un indicateur booléen pour signaler l’existence d’au moins un résultat supplémentaire (sans calculer toutefois ce nombre, car cela entraînerait un ralentissement des performances). Cette optimisation donne d’excellents résultats pour la pagination ou le chargement infini, deux scénarios dans lesquels seul un sous-ensemble de résultats est affiché de manière incrémentielle.

Optimisation d’un index existant

  1. Si la requête optimale est résolue sur un index de propriété, il n’y a rien d’autre à faire, dans la mesure où les index de ce type présentent des capacités de réglage minimales.

  2. Autrement, la requête doit être résolue sur un index de propriété Lucene. Si aucun index ne peut être résolu, passez à la création d’un index.

  3. Le cas échéant, convertissez la requête au format XPath ou JCR-SQL2.

    • Requête Query Builder

      query type=cq:Page
path=/content/my-site/us/en
property=jcr:content/contentType
property.value=article-page
orderby=@jcr:content/publishDate
orderby.sort=desc

    • XPath généré à partir de la requête Query Builder

      /jcr:root/content/my-site/us/en//element(*, cq:Page)[jcr:content/@contentType = 'article-page'] order by jcr:content/@publishDate descending

  4. Fournissez le XPath (ou JCR-SQL2) au Générateur de définitions d’index en Oak afin de générer la définition d’index de propriété Lucene optimisée.

    Définition d’index de propriété Lucene générée

    - evaluatePathRestrictions = true
- compatVersion = 2
- type = "lucene"
- async = "async"
- jcr:primaryType = oak:QueryIndexDefinition
    + indexRules
    + cq:Page
        + properties
        + contentType
            - name = "jcr:content/contentType"
            - propertyIndex = true
        + publishDate
            - ordered = true
            - name = "jcr:content/publishDate"

  5. Fusionnez manuellement la définition générée dans l’index de propriété Lucene qui existe de manière additive. Veillez à ne pas supprimer les configurations existantes, car elles peuvent être utilisées pour accomplir d’autres requêtes.

    1. Définissez l’index de propriété Lucene existant qui couvre cq:Page (à l’aide du gestionnaire d’index). Dans ce cas, /oak:index/cqPageLucene.
    2. Identifiez le delta de configuration entre la définition d’index optimisée (étape n° 4) et l’index existant (/oak:index/cqPageLucene?lang=fr), puis ajoutez les configurations manquantes depuis l’index optimisé à la définition d’index existante.
    3. Conformément aux meilleures pratiques en matière de réindexation d’AEM, une actualisation ou une réindexation est acceptable, selon que le contenu existant est affecté par cette modification de configuration d’index.

Création d’un index

  1. Vérifiez que la requête n’est pas résolue sur un index de propriété Lucene existant. Si tel est le cas, consultez la section précédente traitant de l’optimisation d’un index existant.

  2. Le cas échéant, convertissez la requête au format XPath ou JCR-SQL2.

    • Requête Query Builder

      type=myApp:Author
property=firstName
property.value=ira

    • XPath généré à partir de la requête Query Builder

      //element(*, myApp:Page)[@firstName = 'ira']

  3. Fournissez le XPath (ou JCR-SQL2) au Générateur de définitions d’index en Oak afin de générer la définition d’index de propriété Lucene optimisée.

    Définition d’index de propriété Lucene générée

    - compatVersion = 2
- type = "lucene"
- async = "async"
- jcr:primaryType = oak:QueryIndexDefinition
    + indexRules
    + myApp:AuthorModel
        + properties
        + firstName
            - name = "firstName"
            - propertyIndex = true

  4. Déployez la définition d’index de propriété Lucene générée.

    Ajoutez la définition XML fournie par le Générateur de définitions d’index en Oak du nouvel index au projet AEM qui gère les définitions d’index Oak (pour rappel, traitez les définitions d’index Oak comme du code, car le code dépend de celles-ci).

    Déployez et testez le nouvel index suivant le cycle de vie de développement habituel des logiciels AEM. Vérifiez également que la requête est résolue sur l’index et qu’elle est performante.

    Lors du déploiement initial de cet index, AEM va le remplir avec les données requises.

À quel moment les requêtes de traversée et sans index sont-elles indiquées ?

Compte tenu de l’architecture de contenu flexible d’AEM, il est difficile d’affirmer que les structures de contenu n’évolueront pas au fil du temps pour atteindre des proportions inacceptables.

Dès lors, assurez-vous que les index répondent aux requêtes, sauf si la combinaison des restrictions de type de nœud et de chemin d’accès garantit que le nombre de nœuds parcourus ne sera jamais inférieur à 20.

Outils de développement de requêtes

Prise en charge par Adobe

  • Débogueur Query Builder

    • Interface utilisateur web destinée à exécuter des requêtes Query Builder et à générer le XPath connexe (à utiliser dans l’outil Expliquer la requête ou dans le Générateur de définitions d’index Oak).
    • Situé sur AEM à l’emplacement suivant : /libs/cq/search/content/querydebug.html

  • CRXDE LITE : outil de requête

    • Interface utilisateur web destinée à exécuter des requêtes XPath et JCR-SQL2.
    • Situé sur AEM sous /crx/de/index.jsp > Outils > Requête…

  • Expliquer la requête

    • Tableau de bord des opérations AEM qui fournit une explication détaillée (plan de requête, durée de la requête et nombre de résultats) pour toute requête XPATH ou JCR-SQL2 donnée.

  • Requêtes lentes / les plus courantes

    • Tableau de bord des opérations AEM répertoriant les requêtes lentes et les requêtes les plus courantes exécutées sur AEM.

  • Gestionnaire d’index

    • Interface utilisateur des opérations AEM qui affiche les index sur l’instance AEM ; cela permet d’identifier plus facilement les index qui existent déjà, qui peuvent être ciblés ou augmentés.

  • Journalisation

    • Journalisation de Query Builder

      • DEBUG @ com.day.cq.search.impl.builder.QueryImpl

    • Journalisation de l’exécution des requêtes Oak

      • DEBUG @ org.apache.jackrabbit.oak.query

  • Configuration OSGi des paramètres du moteur de requête Apache Jackrabbit

  • MBean JMX NodeCounter

Prise en charge par la communauté

Sur cette page