疑難排解緩慢查詢

查詢分類緩慢

AEM中有三個主要分類為緩慢查詢，依嚴重程度列出：

無索引查詢
- 有此功能的查詢 not 解析為索引並遍歷JCR的內容以收集結果
限制不良（或設定範圍）的查詢
- 解析為索引，但必須遍歷所有索引專案以收集結果的查詢
大型結果集查詢
- 傳回大量結果的查詢

查詢的前兩個分類（無索引和限制不佳）很慢。速度較慢，因為它們強制Oak查詢引擎檢查每個潛在識別屬於下列專案之結果（內容節點或索引專案）：實際結果集。

檢查每個潛在結果的動作稱為周遊動作。

由於必須檢查每個潛在結果，所以確定實際結果集的成本會隨著潛在結果的數目線性增長。

新增查詢限制和調整索引可讓索引資料以最佳化格式儲存，以便快速擷取結果，並減少或免除線性檢查潛在結果集的需要。

在AEM 6.3中，依預設，當達到100,000的周遊時，查詢會失敗並擲回例外狀況。在AEM 6.3之前的AEM版本中，此限制預設不存在，但可透過Apache Jackrabbit查詢引擎設定OSGi設定和QueryEngineSettings JMX bean （屬性LimitReads）設定。

偵測無索引查詢

開發期間

說明全部查詢並確保其查詢計畫不包含 /&ast；周遊 說明書。周遊查詢計畫範例：

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

部署後

監視 error.log 對於無索引周遊查詢：
- *INFO* org.apache.jackrabbit.oak.query.QueryImpl Traversal query (query without index) ... ; consider creating and index
- 只有在沒有可用的索引且查詢可能穿越許多節點時，才會記錄此訊息。如果索引可用，則不會記錄訊息，但周遊的量很小，因此很快。
造訪AEM 查詢效能操作控制檯和說明尋找周遊或無索引查詢說明的緩慢查詢。

偵測限制不佳的查詢

開發期間

說明所有查詢並確保它們解析為調整為符合查詢屬性限制的索引。

理想的查詢計畫涵蓋範圍有 indexRules 用於所有屬性限制，以及查詢中最嚴格的屬性限制。
排序結果的查詢應解析為Lucene屬性索引，其中包含按設定的屬性排序的索引規則 orderable=true.

例如，預設值 `cqPageLucene` 沒有索引規則 `jcr:content/cq:tags`

新增cq：tags索引規則之前

cq：tags索引規則
- 不存在現成可用的

查詢產生器查詢

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

查詢計畫

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

此查詢解析為 cqPageLucene 索引，但因為沒有屬性索引規則存在 jcr:content 或 cq:tags，評估此限制時， cqPageLucene 會檢查索引以判斷相符專案。因此，如果索引包含1百萬 cq:Page 節點，則會檢查100萬筆記錄以確定結果集。

新增cq：tags索引規則後

cq：tags索引規則

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

查詢產生器查詢

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

查詢計畫

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

新增indexRule for jcr:content/cq:tags 在 cqPageLucene 索引允許 cq:tags 以最佳化方式儲存的資料。

當查詢使用 jcr:content/cq:tags 執行限制，索引可以按值查詢結果。這表示如果是100 cq:Page 節點具有 myTagNamespace:myTag 作為值，只會傳回這100個結果，而其他999,000個結果會排除在限制檢查之外，效能會以10,000的係數提升。

更多的查詢限制會減少符合條件的結果集，並進一步最佳化查詢最佳化。

同樣地，不需要額外的索引規則 cq:tags 屬性，甚至是對具有限制的全文查詢 cq:tags 會表現不佳，因為來自索引的結果會傳回所有全文匹配。 cq：tags上的限制會在之後被篩選。

索引後篩選的另一個原因是開發期間經常遺漏的存取控制清單。請嘗試確保查詢未傳回使用者可能無法存取的路徑。若要這麼做，可透過更好的內容結構以及對查詢提供相關的路徑限制來完成。

若要識別Lucene索引是否傳回許多結果以傳回小子集作為查詢結果，一個有效方法是啟用DEBUG記錄 org.apache.jackrabbit.oak.plugins.index.lucene.LucenePropertyIndex. 這樣做可讓您檢視正在從索引載入多少檔案。最終結果數量與載入檔案數量不應不相稱。如需詳細資訊，請參閱記錄.

部署後

監視 error.log 若為周遊查詢：
- *WARN* org.apache.jackrabbit.oak.spi.query.Cursors$TraversingCursor Traversed ### nodes ... consider creating an index or changing the query
造訪AEM 查詢效能操作控制檯和說明尋找查詢計畫的查詢速度緩慢，查詢計畫無法解決查詢屬性限制以索引屬性規則。

偵測大型結果集查詢

開發期間

設定oak.queryLimitInMemory (例如10000)和oak.queryLimitReads （例如5000）的低臨界值，並在遇到顯示「查詢讀取超過x個節點……」的UnsupportedOperationException時最佳化昂貴的查詢

設定低臨界值有助於避免資源密集的查詢（亦即，不受任何索引支援，或受較少涵蓋範圍索引支援）。例如，讀取一百萬個節點的查詢會導致大量IO，並對整體應用程式效能造成負面影響。因此，應分析和最佳化任何因上述限制而失敗的查詢。

部署後

監控查詢記錄以觸發大型節點周遊或大型棧積記憶體消耗：」
- *WARN* ... java.lang.UnsupportedOperationException: The query read or traversed more than 100000 nodes. To avoid affecting other tasks, processing was stopped.
- 最佳化查詢，以減少周遊的節點數。
監視觸發大型棧積記憶體消耗的查詢記錄：
- *WARN* ... java.lang.UnsupportedOperationException: The query read more than 500000 nodes in memory. To avoid running out of memory, processing was stopped
- 最佳化查詢，以減少棧積記憶體消耗。

對於AEM 6.0 - 6.2版本，您可以透過AEM開始指令碼中的JVM引數調整節點周遊的臨界值，以防止大型查詢使環境過載。建議值為：

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

在AEM 6.3中，上述兩個引數預設為預先設定，並可透過OSGi QueryEngineSettings進行修改。

如需詳細資訊，請前往： https://jackrabbit.apache.org/oak/docs/query/query-engine.html#Slow_Queries_and_Read_Limits

查詢效能調整

AEM中查詢效能最佳化的座右銘為：

「限制越多，越好。」

以下概述為確保查詢效能而建議的調整。首先，調整查詢，減少干擾的活動，然後視需要調整索引定義。

調整查詢陳述式

AEM支援下列查詢語言：

查詢產生器
JCR-SQL2
XPath

下列範例使用Query Builder，因為這是AEM開發人員最常使用的查詢語言，但是相同的原則適用於JCR-SQL2和XPath。

新增節點型別限制，讓查詢解析為現有的Lucene屬性索引。

未最佳化的查詢

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

最佳化的查詢
```
type=cq:Page
property=jcr:content/contentType
property.value=article-page
```
缺少節點型別限制的查詢強制AEM假設 nt:base nodetype (AEM中的每個節點都是其子型別)，實際上不會產生任何節點型別限制。

設定 type=cq:Page 將此查詢限製為僅限 cq:Page 節點，並將查詢解析為AEM cqPageLucene，將結果限製為節點子集(僅限 cq:Page AEM節點)。

調整查詢的節點型別限制，讓查詢解析為現有的Lucene屬性索引。

未最佳化的查詢

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

最佳化的查詢
```
type=cq:Page
property=jcr:content/contentType
property.value=article-page
```
nt:hierarchyNode 為的父節點型別 cq:Page. 假設 jcr:content/contentType=article-page 僅套用至 cq:Page 節點透過Adobe的自訂應用程式，此查詢只會傳回 cq:Page 節點，其中 jcr:content/contentType=article-page. 不過，此流程並非最佳限制，因為：
- 其他節點繼承自 nt:hierarchyNode (例如， dam:Asset)會不必要地新增至潛在結果集。
- 「」沒有AEM提供的索引 nt:hierarchyNode，但由於有為 cq:Page.
設定 type=cq:Page 將此查詢限製為僅限 cq:Page 節點，並將查詢解析為AEM cqPageLucene，將結果限製為AEM中的節點子集（僅限cq：Page節點）。

或者，調整屬性限制，讓查詢解析為現有的屬性索引。

未最佳化的查詢

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

最佳化的查詢
```
property=jcr:content/sling:resourceType
property.value=my-site/components/structure/article-page
```
變更屬性限制 jcr:content/contentType （自訂值）至已知屬性 sling:resourceType 讓查詢解析為屬性索引 slingResourceType 以下條件索引所有內容 sling:resourceType.

當查詢未依節點型別識別，且單一屬性限制主導結果集時，最好使用屬性索引（與Lucene屬性索引相對）。

將最嚴格的路徑限制新增至查詢。例如，偏好設定 /content/my-site/us/en 超過 /content/my-site，或 /content/dam 超過 /.

未最佳化的查詢

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

最佳化的查詢
```
type=cq:Page
path=/content/my-site/us/en
property=jcr:content/contentType
property.value=article-page
```
設定路徑限制的範圍 path=/content至 path=/content/my-site/us/en 允許索引減少必須檢查的索引專案數。當查詢可以限制路徑時，不僅僅是 /content 或 /content/dam，確認索引具有 evaluatePathRestrictions=true.

注意使用 evaluatePathRestrictions 增加索引大小。

可能的話，請避免查詢函式和查詢操作，例如： LIKE 和 fn:XXXX 因為它們的成本會隨著限制型結果數量而調整。

未最佳化的查詢

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

最佳化的查詢
```
type=cq:Page
fulltext=article
fulltext.relPath=jcr:content/contentType
```
LIKE條件的評估緩慢，因為如果文字的開頭是萬用字元("%。…')，則無法使用索引。 jcr：contains條件允許使用全文檢索，因此是推薦使用。需要解析的Lucene屬性索引才能有indexRule jcr:content/contentType 替換為 analayzed=true.

使用類似以下的查詢函式 fn:lowercase(..) 因為沒有速度更快的對等專案（在更複雜且干擾較大的索引分析器設定之外），可能更難最佳化。最好找出其他範圍限制，以改善整體查詢效能，這要求函式儘可能對最小的潛在結果集進行操作。

此調整是Query Builder專用，不適用於JCR-SQL2或XPath。

使用查詢產生器的guessTotal 當完整的結果集為 not 立即需要。
- 未最佳化的查詢
```
type=cq:Page
path=/content
```
- 最佳化的查詢
```
type=cq:Page
path=/content
p.guessTotal=100
```
對於查詢執行速度較快但結果數量很大的情況，p。 guessTotal 是Query Builder查詢的重要最佳化。

p.guessTotal=100 告知Query Builder只收集前100個結果。此外，若要設定布林值標幟，指出是否至少還有一個結果（但不表示還有多少個結果，因為計算此數字會導致速度變慢）。此最佳化不適用於分頁或無限載入的使用案例，這類使用案例只會以累加方式顯示結果子集。

現有索引調整

如果最佳查詢解析為「屬性索引」，則沒有剩下的事情可做，因為「屬性索引」最低可調整。
否則，查詢應解析為Lucene屬性索引。如果無法解析索引，請跳至建立新索引。

視需要將查詢轉換為XPath或JCR-SQL2。

查詢產生器查詢

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

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

將XPath （或JCR-SQL2）提供給Oak索引定義產生器，位於 https://oakutils.appspot.com/generate/index 以便產生最佳化的Lucene屬性索引定義。

產生的Lucene屬性索引定義

- 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"

以累加方式手動將產生的定義合併到現有Lucene屬性索引中。請注意不要移除現有的設定，因為這些設定可能用於滿足其他查詢。
1. 找到涵蓋cq：Page （使用索引管理員）的現有Lucene屬性索引。在這種情況下， /oak:index/cqPageLucene.
2. 識別最佳化索引定義(步驟#4)和現有索引(/oak%EF%BC%9Aindex/cqPageLucene?lang=zh-Hant)之間的設定差異，並將最佳化索引中遺漏的設定新增至現有索引定義。
3. 根據AEM重新索引最佳實務，重新整理或重新索引會根據現有內容是否可能受此索引設定變更影響而順序。

建立新索引

確認查詢未解析為現有的Lucene屬性索引。如果確實如此，請參閱上述調整與現有索引一節。
視需要將查詢轉換為XPath或JCR-SQL2。
- 查詢產生器查詢
```
type=myApp:Author
property=firstName
property.value=ira
```
- 從查詢產生器查詢產生的XPath
```
//element(*, myApp:Page)[@firstName = 'ira']
```

將XPath （或JCR-SQL2）提供給Oak索引定義產生器，位於 https://oakutils.appspot.com/generate/index 以便產生最佳化的Lucene屬性索引定義。

產生的Lucene屬性索引定義

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

部署產生的Lucene屬性索引定義。

將Oak索引定義產生器為新索引提供的XML定義新增到管理Oak索引定義的AEM專案（記住，將Oak索引定義視為程式碼，因為程式碼取決於它們）。

在通常的AEM軟體開發生命週期之後部署和測試新索引，並確認查詢解析至索引且查詢執行正常。

在此索引的初始部署中，AEM會使用必要資料填入索引。

無索引查詢和周遊查詢何時正常？

由於AEM靈活的內容架構，很難預測並確保內容結構的周遊不會隨著時間發展而變得異常龐大。

因此，請確保索引滿足查詢，除非路徑限制和節點型別限制的組合保證 曾經周遊的節點少於20個。

查詢開發工具

支援的Adobe

Query Builder Debugger
- 用於執行Query Builder查詢並產生支援XPath的WebUI （用於Explain Query或Oak Index Definition Generator）。
- 在AEM上 /libs/cq/search/content/querydebug.html
CRXDE Lite — 查詢工具
- 用於執行XPath和JCR-SQL2查詢的WebUI。
- 在AEM上 /crx/de/index.jsp >工具>查詢……
說明查詢
- 「AEM作業」控制面板，針對任何指定的XPATH或JCR-SQL2查詢，提供詳細的說明（查詢計畫、查詢時間及結果數）。
緩慢/熱門查詢
- AEM Operations儀表板，列出最近在AEM上執行的緩慢且熱門的查詢。
索引管理員
- 顯示AEM執行個體上索引的AEM Operations WebUI；有助於瞭解存在哪些索引；可以定位或擴充。
記錄
- 查詢產生器記錄
  - DEBUG @ com.day.cq.search.impl.builder.QueryImpl
- Oak查詢執行記錄
  - DEBUG @ org.apache.jackrabbit.oak.query
Apache Jackrabbit查詢引擎設定OSGi設定
- 用於設定周遊查詢的失敗行為的OSGi設定。
- 在AEM上 /system/console/configMgr#org.apache.jackrabbit.oak.query.QueryEngineSettingsService
NodeCounter JMX Mbean
- JMX MBean用於估算AEM內容樹狀結構中的節點數量。
- 在AEM上 /system/console/jmx/org.apache.jackrabbit.oak%3Aname%3DnodeCounter%2Ctype%3DNodeCounter

社群支援

Oak索引定義產生器位於https://oakutils.appspot.com/generate/index
- 從XPath或JCR-SQL2查詢陳述式產生最佳的Lucence屬性索引。
AEM Chrome外掛程式
- Google Chrome網頁瀏覽器擴充功能，可在瀏覽器的開發工具主控台中公開每個請求的記錄資料，包括已執行的查詢及其查詢計畫。
- 需要 Sling Log Tracer 1.0.2+ ，並會在AEM上安裝和啟用。

Business.Adobe.com 資源

Content Insights Automated Onboarding Style System Auto Form Fill Theme Editor Managed Cloud

疑難排解緩慢查詢

查詢分類緩慢

偵測無索引查詢

開發期間

部署後

偵測限制不佳的查詢

開發期間

例如，預設值 `cqPageLucene` 沒有索引規則 `jcr:content/cq:tags`

部署後

偵測大型結果集查詢

開發期間

部署後

查詢效能調整

調整查詢陳述式

現有索引調整

建立新索引

無索引查詢和周遊查詢何時正常？

查詢開發工具

支援的Adobe

社群支援

Business.Adobe.com 資源

本頁內容

檢視下一個:

學習

說明文件

社群

技術支援

資源

Adobe 帳戶

Adobe

疑難排解緩慢查詢

查詢分類緩慢

偵測無索引查詢

開發期間

部署後

偵測限制不佳的查詢

開發期間

例如，預設值 cqPageLucene 沒有索引規則 jcr:content/cq:tags

部署後

偵測大型結果集查詢

開發期間

部署後

查詢效能調整

調整查詢陳述式

現有索引調整

建立新索引

無索引查詢和周遊查詢何時正常？

查詢開發工具

支援的Adobe

社群支援

Business.Adobe.com 資源

本頁內容

檢視下一個:

學習

說明文件

社群

技術支援

資源

Adobe 帳戶

Adobe

例如，預設值 `cqPageLucene` 沒有索引規則 `jcr:content/cq:tags`