操作儀表板

簡介

6中的Operations Dashboard可AEM協助系統營運商一覽AEM系統狀況。 它還提供有關相關方面的自動生成的診斷資訊AEM，並允許配置和運行獨立的維護自動化，以顯著減少項目操作和支援案例。 The Operations Dashboard can be extended with custom health checks and maintenance tasks. 此外，您也可透過JMX從外部監控工具存取「作業控制面板」資料。

操作儀表板：

• 是單鍵系統狀態，可協助營運部門提高效率
• 在單一集中位置提供系統運行狀況概述
• 縮短尋找、分析和修正問題的時間
• 提供獨立的維護自動化功能，協助大幅降低專案作業成本

可從「歡迎」螢幕轉至​Tools - Operations​來訪問該AEM選項。

健全狀態報表

The Health Report system provides on the health of an AEM instance through Sling Health Checks. 這可以透過OSGI、JMX、HTTP要求（透過JSON）或Touch UI來完成。 它提供特定可設定計數器的度量和臨界值，在某些情況下，將提供如何解決問題的資訊。

它有幾項功能，說明如下。

健康狀態檢查

健康報告​是指特定產品區域健康狀況良好或不良的卡片系統。 這些卡片是Sling Health Checks的視覺化，可匯整來自JMX和其他來源的資料，並將處理的資訊再次公開為MBeans。 這些MBeans也可在JMX網頁主控台的​org.apache.sling.healthcheck​網域下進行檢查。

The Health Reports interface can be accessed by the Tools - Operations - Health Reports menu on the AEM Welcome screen, or directly through the following URL:

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

卡系統會顯示三種可能的狀態：確定、警告​和​關鍵。 狀態是規則和臨界值的結果，可將滑鼠暫留在卡片上，然後按一下動作列中的齒輪圖示來設定：

運行狀況檢查類型

6中有兩種健康檢查類AEM型：

1. Individual Health Checks
2. Composite Health Checks

Individual Health Check​是與狀態卡相對應的單一健康檢查。 Individual Health Checks can be configured with rules or thresholds and they can provide one or more hints and links to solve indited health issues. 讓我們以「記錄錯誤」檢查為例：如果實例日誌中有ERROR條目，您將在運行狀況檢查的詳細資訊頁面上找到它們。 在頁面頂部，您將在「診斷工具」部分看到指向「日誌消息」分析器的連結，該連結將使您能夠更詳細地分析這些錯誤並重新配置記錄器。

A Composite Health Check​是一項檢查，可匯總來自多個單獨檢查的資訊。

Composite health checks are configured with the aid of filter tags. 在實質中，所有具有相同篩選標籤的單一檢查都將分組為複合健康檢查。 A Composite Health Check will an OK status only if all the single checks it aggregates as OK statuses ass.

How to create Health Checks

在「操作儀表板」中，您可以直觀地顯示單個和複合健康檢查的結果。

Creating an individual Health Check

Creating an individual Health Check inverted two steps:實作a Sling Health Check，並新增Dashboard設定節點中Health Check的項目。

1. 若要建立Sling Health Check，您必須建立實作Sling HealthCheck介面的OSGI元件。 您會將此元件新增至套件中。 元件的屬性將完全標識Health Check。 在安裝此元件後，將自動為Health Check（運行狀況檢查）建立JMX MBean。 如需詳細資訊，請參閱Sling Health Check Documentation。

   Example of a Sling Health Check component, writted with OSGI service component annotations:

   @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     
       }
    }
   

   注意

   MBEAN_NAME屬性定義將為此運行狀況檢查生成的mbean的名稱。

2. 建立Health Check後，需要建立新的配置節點，以便在Operations Dashboard介面中訪問該節點。 對於此步驟，必須知道Health Check（MBEAN_NAME屬性）的JMX Mbean名稱。 要建立健康檢查的配置，請開啟CRXDE並在以下路徑下添加新節點（類型為​nt:unstructured）:/apps/settings/granite/operations/hc

   在新節點上應設定以下屬性：

   • 名稱： sling:resourceType

     • 類型： String
     • 值： granite/operations/components/mbean

   • 名稱： resource

     • 類型： String
     • 值： /system/sling/monitoring/mbeans/org/apache/sling/healthcheck/HealthCheck/exampleHealthCheck
   注意

   上面的資源路徑建立如下：如果Health Check的mbean名稱為"test"，請將"test"添加到路徑/system/sling/monitoring/mbeans/org/apache/sling/healthcheck/HealthCheck的末尾

   因此，最終的路徑是：

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

   注意

   請確定/apps/settings/granite/operations/hc路徑的下列屬性設為true:

   sling:configCollectionInherit

   sling:configPropertyInherit

   這將通知配置管理器將新配置與/libs中現有配置合併。

Creating a Composite Health Check

A Composite Health Check's role is to aggregate a number of individual Health Checks sharing a set of common features. 例如， Security Composite Health Check將所有個別的健康狀況檢查組一起執行安全相關驗證。 建立複合檢查的第一步是添加新的OSGI配置。 要在「操作儀表板」中顯示該節點，需要添加新的配置節點，這與我們對簡單檢查的方式相同。

1. 前往OSGI主控台的Web組態管理器。 您可以存取https://serveraddress:port/system/console/configMgr來執行此動作

2. 搜尋名為​Apache Sling Composite Health Check​的項目。 在找到它後，請注意已有兩種配置可供使用：一個代表系統檢查，另一個代表安全檢查。

3. 按配置右側的「+」按鈕，建立新配置。 將會出現新視窗，如下所示：

   

4. 建立設定並儲存。 將使用新配置建立一個Mbean。

   每個配置屬性的用途如下：

   • 名稱(hc.name): Composite Health Check的名稱。建議使用有意義的名稱。
   • Tags(hc.tags): the tags for this Health Check.如果此複合健康狀況檢查是另一個複合健康狀況檢查的一部分（例如，在健康狀況檢查的層次中），請添加與此複合相關的標籤。
   • MBean Name(hc.mbean.name): 將提供給此組合健康檢查的JMX MBean的Mbean的名稱。
   • Filter Tags(filter.tags): This is a property specific to composite health checks.這些是複合應該聚合的標籤。 The composite health check will aggregate under its group all the health checks that have any tag matching any of the filter tags of this composite. 例如，具有過濾器標籤​test​和​check​的複合健康檢查將匯總所有具有​test​和​check​標籤的個別和複合健康檢查(hc.tags)。
   注意

   A new JMX Mbean is created for each new configuration of the Apache Sling Composite Health Check.**

5. 最後，剛建立的複合健康檢查項需要添加到「操作儀表板」配置節點中。 此過程與使用單個健康檢查的過程相同：nt:unstructured​類型的節點需要在/apps/settings/granite/operations/hc下建立。 節點的資源屬性將由OSGI配置中的​hc.mean.name​值定義。

   例如，如果您建立了配置並將​hc.mbean.name​值設定為​diskusage，則配置節點將如下所示：

   • 名稱： Composite Health Check

     • 類型： nt:unstructured

   使用下列屬性：

   • 名稱： sling:resourceType

     • 類型： String
     • 值： granite/operations/components/mbean

   • 名稱： resource

     • 類型： String
     • 值： /system/sling/monitoring/mbeans/org/apache/sling/healthcheck/HealthCheck/diskusage
   注意

   如果您建立邏輯上屬於複合檢查的個別健康檢查（預設情況下，該複合檢查已存在於儀表板中），則它們將自動被捕獲並分組到相應的複合檢查下。 因此，無需為這些檢查建立新的配置節點。

   例如，如果您建立個別的安全性健康狀況檢查，您只需要將"security"標籤指派給它，它就會安裝，它就會自動出現在Operations Dashboard中的Security Checks composite檢查下。

Health Checks Provided with AEM

使用Nagios進行監控

Health Check Dashboard可透過Granite JMX Mbeans與Nagios整合。 以下示例說明如何添加一個檢查，該檢查顯示正在運行的伺服器上已用的內AEM存。

1. 在監控伺服器上安裝和安裝Nagios。

2. 接著，安裝Nagios Remote Plugin Executor(NRPE)。

   注意

   有關如何在系統上安裝Nagios和NRPE的更多資訊，請參閱Nagios Documentation。

3. 為伺服器添加主AEM機定義。 這可以透過Nagios XI Web介面，使用Configuration Manager:

   1. 開啟瀏覽器並指向Nagios伺服器。
   2. 按頂部菜單中的​Configure​按鈕。
   3. 在左窗格中，按​Advanced Configuration​下的​Core Config Manager。
   4. 按​監視​部分下的​Hosts​連結。
   5. 添加主機定義：

   

   以下是主機配置檔案的示例，以防您使用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. 在伺服器上安裝NagiosAEM和NRPE。

5. 在兩部伺服器上安裝check_http_json外掛程式。

6. 在兩部伺服器上定義一般JSON檢查命令：

   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. 在伺服器上添加已用記憶體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. 檢查您的Nagios儀表板中是否有新建立的服務：

   

診斷工具

「操作儀表板」還提供對診斷工具的訪問，這些工具有助於查找和排除來自健康檢查儀表板的警告的根本原因，並為系統操作員提供重要的調試資訊。

其最重要的功能包括：

• 日誌消息分析器
• 能夠訪問堆和線程轉儲
• 請求和查詢效能分析器

從「歡迎使用」螢幕轉到​工具——操作——診斷，即可進入「診斷工具」AEM螢幕。 您也可以直接存取下列URL，以存取畫面：https://serveraddress:port/libs/granite/operations/content/diagnosis.html

日誌消息

預設情況下，日誌消息用戶介面將顯示所有ERROR消息。 如果要顯示更多日誌消息，則需要使用相應的日誌級別配置日誌程式。

日誌消息使用記憶體日誌附加器，因此與日誌檔案無關。 另一個結果是，更改此UI中的日誌級別不會更改在傳統日誌檔案中記錄的資訊。 在此UI中添加和刪除記錄程式將僅影響in memory記錄程式。 此外，請注意，更改記錄器配置將反映在in memory logger的未來中——已記錄且不再相關的條目不會刪除，但類似條目將不會在將來記錄。

您可從UI的左上角齒輪按鈕提供記錄器設定，以設定記錄的記錄內容。 您可以在此處添加、刪除或更新記錄程式配置。 記錄器配置由​log level(WARN / INFO / DEBUG)和​filter name​組成。 篩選器名稱​具有篩選日誌消息源的角色。 或者，如果記錄器應捕獲指定級別的所有日誌消息，則過濾器名稱應為"root"。 設定記錄器的級別將觸發所有級別等於或高於指定級別的消息的捕獲。

範例：

• 如果您計畫捕獲所有​ERROR​消息，則無需配置。 預設情況下，將捕獲所有ERROR消息。

• 如果您計畫捕獲所有​ERROR、WARN​和​INFO​消息，則記錄器名稱應設定為："root"和logger level to:INFO。

• 如果您計畫擷取來自特定封裝的所有訊息（例如com.adobe.granite）-記錄器名稱應設為："com.adobe.granite"和logger level to:DEBUG（這將捕獲所有​ERROR、WARN、INFO​和​DEBUG​消息），如下圖所示。

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

要求效能

「請求效能」頁面可讓您分析處理的最慢頁面請求。 此頁面上僅會註冊內容要求。 更具體而言，將會擷取下列請求：

1. 訪問/content下的資源的請求
2. 訪問/etc/design下的資源的請求
3. 具有".html"副檔名的請求

頁面會顯示：

• 提出請求的時間
• URL與請求方法
• 持續時間（以毫秒為單位）

依預設，會擷取最慢的20個頁面請求，但可在設定管理員中修改限制。

查詢效能

「查詢效能」頁允許分析系統執行的最慢查詢。 此資訊由JMX Mbean中的儲存庫提供。 在Jackrabbit中，com.adobe.granite.QueryStat JMX Mbean會提供此資訊，而在Oak儲存庫中，它則由org.apache.jackrabbit.oak.QueryStats.提供

頁面會顯示：

• 進行查詢的時間
• 查詢語言
• 發出查詢的次數
• 查詢語句
• 持續時間（以毫秒為單位）

說明查詢

對於任何給定查詢，Oak會嘗試根據在​oak:index​節點下的資料庫中定義的Oak索引找出執行的最佳方式。 根據查詢，Oak可以選擇不同的索引。 瞭解Oak如何執行查詢是最佳化查詢的第一步。

Explain Query是一種工具，可說明Oak如何執行查詢。 您可從「歡迎使用」畫面前往「工具——作業——診斷」，然後按一下「查詢效能​」，並切換至「說明查詢​」標籤，以存取它。

功能

• 支援Xpath、JCR-SQL和JCR-SQL2查詢語言
• 報告提供查詢的實際執行時間
• 檢測慢速查詢並警告可能慢速的查詢
• 報告用於執行查詢的Oak索引
• 顯示實際的Oak查詢引擎說明
• 提供「慢速」和「熱門」查詢的點按載入清單

在「Explain Query UI（解釋查詢UI）」中，您只需輸入查詢，然後按​Explain​按鈕：

「查詢解釋」部分中的第一個條目是實際解釋。 說明將顯示用於執行查詢的索引類型。

第二個條目是執行計畫。

在執行查詢之前，按一下「包含執行時間​」方塊，也會顯示查詢在中執行的時間，以取得可用於最佳化應用程式或部署索引的詳細資訊。

索引管理器

「索引管理器」的作用是幫助進行索引管理，如維護索引或查看其狀態。

您可從「歡迎使用」螢幕轉到​Tools - Operations - Diagnosis，然後按一下​Index Manager​按鈕來訪問它。

您也可以直接在此URL存取它：https://serveraddress:port/libs/granite/operations/content/diagnosistools/indexManager.html

UI可用來篩選表格中的索引，方法是在螢幕左上角的搜尋方塊中輸入篩選條件。

下載狀態ZIP

這將觸發下載包含系統狀態和配置有用資訊的zip。 封存包含例項設定、組合清單、OSGI、Sling度量和統計資料，這可能會產生大型檔案。 您可以使用​Download Status ZIP 視窗，來降低大型狀態檔案的影響。 您可從以下網址訪問該窗口：AEM >工具>操作>診斷>下載狀態ZIP。

在此窗口中，您可以選擇要導出的內容（日誌檔案和線程轉儲）以及下載中包含的日誌相對於當前日期的天數。

下載線程轉儲

這將觸發下載包含系統中線程資訊的zip。 提供了有關每個線程的資訊，如其狀態、類載入器和堆棧跟蹤。

下載堆轉儲

您也可以下載堆的快照，以便稍後分析它。 請注意，這將觸發以數百兆位元組為順序的大檔案下載。

自動維護任務

「自動維護任務」頁是一個位置，可以在該位置查看和跟蹤計畫定期執行的建議維護任務。 這些任務與Health Check系統整合。 也可以從介面手動執行這些任務。

要進入「操作儀表板」中的「維護」頁面，您需要從「歡迎」螢幕轉到​工具——操作——儀表板——維護 AEM，或直接遵循以下連結：

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

「操作儀表板」中提供以下任務：

1. 版本清理​任務，位於​每日維護窗口​菜單下。

2. Lucene Binaries Cleanup task ，位於​Daily Maintenance Window​菜單下。

3. Workflow purge task ，位於​Weekly Maintenance Window​菜單下。

4. Data Store Garbage Collection​任務，位於​每週維護窗口​菜單下。

5. 審核日誌維護​任務，位於​每週維護窗口​菜單下。

6. 版本清除維護​任務，位於​每週維護窗口​菜單下。

每日維護視窗的預設時間為2到5 AM。 在週六的上午1點到2點之間，配置為在每週維護窗口中運行的任務將執行。

您也可以按下兩張維護卡上的齒輪圖示來設定計時：

修訂清理

如需執行6.4版修訂清除的詳細資訊，請AEM參閱此專屬文章](/docs/experience-manager-64/sites-deploying/revision-cleanup.html?lang=zh-Hant)。[

Lucene 二進位清理

通過使用Lucene二進位檔案清除任務，可以清除lucene二進位檔案並降低運行中的資料儲存大小要求。 這是因為Lucene的二進位混亂將每日重新聲明，而不是先前對成功執行資料儲存廢棄項目收集的依賴。

雖然維護任務是為了減少與Lucene相關的修訂垃圾，但在運行任務時，總體效率有所提高：

• 每週執行資料儲存廢棄項目收集工作會更快完成
• 它也會略微改善整體效AEM能

您可以從以下位置訪問Lucene二進位檔案清除任務：AEM >工具>操作>維護>每日維護窗口> Lucene二進位檔案清理。

資料存放庫廢棄項目收集

有關Data Store Garbage Collection的詳細資訊，請參閱專用的檔案頁面。

工作流清除

您也可以從維護控制面板清除工作流程。 要運行「工作流清除」任務，您需要：

1. 按一下​每週維護窗口​頁。
2. 在以下頁面中，按一下​Workflow purge​卡中的​Play​按鈕。

審核日誌維護

有關審核日誌維護，請參閱單獨的文檔頁。

版本清除

您可以計畫「版本清除」維護任務，以自動刪除舊版。 因此，這將手動使用版本清除工具的需要降至最低。 您可以通過訪問​工具>操作>維護>每週維護窗口​並遵循以下步驟來計畫和配置「版本清除」任務：

1. 按一下​添加​按鈕。

2. 從下拉菜單中選擇​版本清除。

   

3. 要配置「版本清除」任務，請按一下新建立的「版本清除」維護卡上的​gears​表徵圖。

   

使用AEM6.4，您可以按如下方式停止「版本清除」維護任務：

• 自動——如果計畫維護窗口在任務完成之前關閉，則任務將自動停止。 下次維護視窗開啟時，它會繼續。
• 手動——要手動停止任務，請在「版本清除」維護卡上按一下​Stop​表徵圖。 在下次執行時，任務將安全恢復。

自定義維護任務

自訂維護工作可以實作為OSGi服務。 由於維護任務基礎架構是以Apache Sling的工作處理為基礎，因此維護任務必須實作java interface [org.apache.sling.event.jobs.consumer.JobExecutor](https://sling.apache.org/apidocs/sling7/org/apache/sling/event/jobs/consumer/JobExecutor.html)。 此外，它必須聲明多個服務註冊屬性以作為維護任務被檢測，如下所列：

除了上述服務屬性外，JobConsumer介面的process()方法還需要通過添加應為維護任務執行的代碼來實現。 提供的JobExecutionContext可用於輸出狀態資訊，檢查用戶是否停止了作業並建立結果（成功或失敗）。

如果維護任務不應在所有安裝上運行（例如，僅在發佈實例上運行），則可通過添加@Component(policy=ConfigurationPolicy.REQUIRE)使服務需要配置才能處於活動狀態。 然後，您可以將相應的配置標籤為從屬於儲存庫中的運行模式。 如需詳細資訊，請參閱設定OSGi。

以下是自訂維護工作的範例，從可設定的臨時目錄中刪除檔案（過去24小時內已修改）:

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

experiencemanager-java-maintenancetask-sample- src/main/java/com/adobe/granite/samples/maintenance/impl/DeleteTempFilesTask.java

在部署服務後，它將會顯示在Operations Dashboard UI，並可新增至其中一個可用的維護排程：

這將在/apps/granite/operations/config/maintenance/schedule/taskname中新增對應的資源。 如果任務與運行模式相關，則需要在該節點上設定granite.operations.conditions.runmode屬性，其中需要為此維護任務激活的運行模式值。

系統綜覽

系統概述儀表板​顯示實例的配置、硬體和運行狀況的高級概AEM述。 這表示系統健康狀態是透明的，所有資訊都會匯總在單一儀表板中。

如何訪問

要訪問「系統概述儀表板」，請導航至​工具>操作>系統概述。

系統概述控制面板說明

下表說明「系統概述控制面板」中顯示的所有資訊。 請記住，當沒有要顯示的相關資訊（例如，備份未進行，沒有重要的運行狀況檢查）時，各節將顯示「無條目」消息。

您也可以按一下控制面板右上角的​下載​按鈕，下載匯總控制面板資訊的JSON檔案。JSON端點是/libs/granite/operations/content/systemoverview/export.json，可用於curl指令檔，以進行外部監控。