記錄AEMas a Cloud Service

AEM as a Cloud Service是客戶納入自訂程式碼的平台，可為其客戶群建立獨特體驗。 有鑑於此，記錄服務是重要功能，可針對本機開發和雲端環境(尤其是AEMas a Cloud Service的開發環境)進行除錯及了解程式碼執行情形。

AEMas a Cloud Service記錄設定和記錄層級可在組態檔中進行管理，這些組態檔儲存為Git中AEM專案的一部分，並透過Cloud Manager部署為AEM專案的一部分。 登入AEM as a Cloud Service可分割為兩個邏輯集：

• AEM記錄，在AEM應用程式層級執行記錄
• Apache HTTPD Web Server/Dispatcher記錄，可在「發佈」層級上執行Web伺服器和Dispatcher的記錄。

AEM記錄

在AEM應用程式層級記錄，由三個記錄檔處理：

1. AEM Java記錄檔，可轉譯AEM應用程式的Java記錄陳述式。
2. HTTP要求記錄檔，記錄AEM所提供HTTP要求及其回應的相關資訊
3. HTTP存取記錄，記錄由AEM提供的摘要資訊和HTTP要求

AEM Java記錄

AEM as a Cloud Service提供對Java日誌陳述式的訪問。 AEM應用程式的開發人員應遵循一般Java記錄最佳實務，在下列記錄層級記錄與自訂程式碼執行相關的陳述式：

雖然Java記錄支援其他數種記錄粒度層級，但AEM as a Cloud Service建議使用上述三個層級。

AEM記錄層級是透過OSGi設定，依環境類型而設定，而OSGi設定則會提交至Git，並透過Cloud Manager部署至AEMas a Cloud Service。 因此，最好保持日誌陳述式一致且為環境類型所知，以確保通過AEM作為Cloud Service的可用日誌在最佳日誌級別可用，而不需要使用更新的日誌級別配置重新部署應用程式。

日誌輸出示例

22.06.2020 18:33:30.120 [cm-p12345-e6789-aem-author-86657cbb55-xrnzq] *ERROR* [qtp501076283-1809] io.prometheus.client.dropwizard.DropwizardExports Failed to get value from Gauge
22.06.2020 18:33:30.229 [cm-p12345-e6789-aem-author-86657cbb55-xrnzq] *INFO* [qtp501076283-1805] org.apache.sling.auth.core.impl.SlingAuthenticator getAnonymousResolver: Anonymous access not allowed by configuration - requesting credentials
22.06.2020 18:33:30.370 [cm-p12345-e6789-aem-author-86657cbb55-xrnzq] *INFO* [73.91.59.34 [1592850810364] GET /libs/granite/core/content/login.html HTTP/1.1] org.apache.sling.i18n.impl.JcrResourceBundle Finished loading 0 entries for 'en_US' (basename: <none>) in 4ms
22.06.2020 18:33:30.372 [cm-p12345-e6789-aem-author-86657cbb55-xrnzq] *INFO* [FelixLogListener] org.apache.sling.i18n Service [5126, [java.util.ResourceBundle]] ServiceEvent REGISTERED
22.06.2020 18:33:30.372 [cm-p12345-e6789-aem-author-86657cbb55-xrnzq] *WARN* [73.91.59.34 [1592850810364] GET /libs/granite/core/content/login.html HTTP/1.1] libs.granite.core.components.login.login$jsp j_reason param value 'unknown' cannot be mapped to a valid reason message: ignoring

記錄格式

配置記錄器

AEM Java記錄檔定義為OSGi設定，因此可使用執行模式資料夾鎖定特定AEMas a Cloud Service環境。

透過Sling LogManager工廠的OSGi設定，為自訂Java套件設定Java記錄。 支援兩種配置屬性：

更改其他LogManager OSGi配置屬性可能會導致AEMas a Cloud Service中出現可用性問題。

以下是建議記錄設定的範例(使用的預留位置Java套件 com.example)，適用於三種AEMas a Cloud Service環境類型。

開發

/apps/my-app/config/org.apache.sling.commons.log.LogManager.factory.config-example.cfg.json

{
    "org.apache.sling.commons.log.names": ["com.example"],
    "org.apache.sling.commons.log.level": "debug"
}

測試

/apps/my-app/config.stage/org.apache.sling.commons.log.LogManager.factory.config-example.cfg.json

{
    "org.apache.sling.commons.log.names": ["com.example"],
    "org.apache.sling.commons.log.level": "warn"
}

生產

/apps/my-app/config.prod/org.apache.sling.commons.log.LogManager.factory.config-example.cfg.json

{
    "org.apache.sling.commons.log.names": ["com.example"],
    "org.apache.sling.commons.log.level": "error"
}

AEM HTTP要求記錄

AEM as a Cloud Service的HTTP要求記錄功能可依時序深入分析對AEM提出的HTTP要求及其HTTP回應。 此記錄有助於了解對AEM提出的HTTP要求，以及處理和回應的順序。

了解此記錄檔的關鍵，是透過其ID對應HTTP要求和回應配對，以方括弧中的數值表示。 請注意，在記錄中，要求及其對應回應之間通常會插入其他HTTP要求和回應。

記錄範例

29/Apr/2020:19:14:21 +0000 [137] -> POST /conf/global/settings/dam/adminui-extension/metadataprofile/ HTTP/1.1 [cm-p1234-e5678-aem-author-59555cb5b8-q7l9s]
...
29/Apr/2020:19:14:22 +0000 [139] -> GET /mnt/overlay/dam/gui/content/processingprofilepage/metadataprofiles/editor.html/conf/global/settings/dam/adminui-extension/metadataprofile/main HTTP/1.1 [cm-p1234-e5678-aem-author-59555cb5b8-q7l9s]
...
29/Apr/2020:19:14:21 +0000 [137] <- 201 text/html 111ms [cm-p1234-e5678-aem-author-59555cb5b8-q7l9s]
...
29/Apr/2020:19:14:22 +0000 [139] <- 200 text/html;charset=utf-8 637ms [cm-p1234-e5678-aem-author-59555cb5b8-q7l9s]

記錄格式

配置日誌

AEM HTTP要求記錄檔無法在AEMas a Cloud Service中設定。

AEM HTTP存取記錄

AEM asCloud ServiceHTTP存取記錄會依時序顯示HTTP要求。 每個記錄項目代表存取AEM的HTTP要求。

此記錄有助於快速了解對AEM提出的HTTP要求、查看隨附的HTTP回應狀態代碼是否成功，以及HTTP要求完成所需的時間。 此記錄檔也可協助您依使用者篩選記錄項目，以偵錯特定使用者的活動。

日誌輸出示例

cm-p1234-e26813-aem-author-59555cb5b8-8kgr2 - example@adobe.com 30/Apr/2020:17:37:14 +0000  "GET /libs/granite/ui/references/clientlibs/references.lc-5188e85840c529149e6cd29d94e74ad5-lc.min.css HTTP/1.1" 200 1141 "https://author-p10711-e26813.adobeaemcloud.com/mnt/overlay/dam/gui/content/assets/metadataeditor.external.html?item=/content/dam/en/images/example.jpeg&_charset_=utf8" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.122 Safari/537.36"
cm-p1234-e26813-aem-author-59555cb5b8-8kgr2 - example@adobe.com 30/Apr/2020:17:37:14 +0000  "GET /libs/dam/gui/coral/components/admin/customthumb/clientlibs.lc-60e4443805c37afa0c74b674b141f1df-lc.min.css HTTP/1.1" 200 809 "https://author-p10711-e26813.adobeaemcloud.com/mnt/overlay/dam/gui/content/assets/metadataeditor.external.html?item=/content/dam/en/images/example.jpeg&_charset_=utf8" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.122 Safari/537.36"
cm-p1234-e26813-aem-author-59555cb5b8-8kgr2 - example@adobe.com 30/Apr/2020:17:37:14 +0000  "GET /libs/dam/gui/coral/components/admin/metadataeditor/clientlibs/metadataeditor.lc-4a2226d8232f8b7ab27d24820b9ddd64-lc.min.js HTTP/1.1" 200 7965 "https://author-p10711-e26813.adobeaemcloud.com/mnt/overlay/dam/gui/content/assets/metadataeditor.external.html?item=/content/dam/en/images/example.jpeg&_charset_=utf8" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.122 Safari/537.36"

配置HTTP訪問日誌

AEMas a Cloud Service中無法設定HTTP存取記錄。

Apache Web伺服器和Dispatcher記錄

AEM as a Cloud Service提供發佈上Apache Web伺服器和dispatcher層的三個記錄：

• Apache HTTPD Web伺服器訪問日誌
• Apache HTTPD Web伺服器錯誤日誌
• Dispatcher記錄檔

請注意，這些記錄檔僅適用於發佈層級。

這組記錄檔可在AEMas a Cloud Service發佈層級的HTTP要求傳至AEM應用程式前，提供這些要求的深入分析。 請務必了解，理想情況下，對Publish層級伺服器的大部分HTTP請求都是由Apache HTTPD Web Server和AEM Dispatcher快取的內容提供，且絕不能觸及AEM應用程式本身。 因此，AEM Java、Request或Access記錄中沒有這些要求的記錄陳述式。

Apache HTTPD Web伺服器訪問日誌

Apache HTTP Web Server存取記錄檔會針對到達發佈層級之Web伺服器/Dispatcher的每個HTTP要求提供陳述式。 請注意，從上游CDN提供的請求不會反映在這些記錄中。

請參閱 官方apache檔案.

日誌輸出示例

cm-p1234-e5678-aem-publish-b86c6b466-qpfvp - - 17/Jul/2020:09:14:41 +0000  "GET /etc.clientlibs/wknd/clientlibs/clientlib-site/resources/images/favicons/favicon-32.png HTTP/1.1" 200 715 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:78.0) Gecko/20100101 Firefox/78.0"
cm-p1234-e5678-aem-publish-b86c6b466-qpfvp - - 17/Jul/2020:09:14:41 +0000  "GET /etc.clientlibs/wknd/clientlibs/clientlib-site/resources/images/favicons/favicon-512.png HTTP/1.1" 200 9631 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:78.0) Gecko/20100101 Firefox/78.0"
cm-p1234-e5678-aem-publish-b86c6b466-qpfvp - - 17/Jul/2020:09:14:42 +0000  "GET /etc.clientlibs/wknd/clientlibs/clientlib-site/resources/images/country-flags/US.svg HTTP/1.1" 200 810 "https://publish-p6902-e30226.adobeaemcloud.com/content/wknd/us/en.html" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:78.0) Gecko/20100101 Firefox/78.0"

記錄格式

配置Apache HTTPD Web伺服器訪問日誌

此日誌在AEMas a Cloud Service中不可配置。

Apache HTTPD Web伺服器錯誤日誌

Apache HTTP Web Server錯誤記錄會針對發佈層級的Web伺服器/Dispatcher中的每個錯誤提供陳述式。

請參閱 官方apache檔案.

日誌輸出示例

Fri Jul 17 02:19:48.093820 2020 [mpm_worker:notice] [pid 1:tid 140272153361288] [cm-p1234-e30226-aem-publish-b86c6b466-b9427] AH00292: Apache/2.4.43 (Unix) Communique/4.3.4-20200424 mod_qos/11.63 configured -- resuming normal operations
Fri Jul 17 02:19:48.093874 2020 [core:notice] [pid 1:tid 140272153361288] [cm-p1234-e30226-aem-publish-b86c6b466-b9427] AH00094: Command line: 'httpd -d /etc/httpd -f /etc/httpd/conf/httpd.conf -D FOREGROUND -D ENVIRONMENT_PROD'
Fri Jul 17 02:29:34.517189 2020 [mpm_worker:notice] [pid 1:tid 140293638175624] [cm-p1234-e30226-aem-publish-b496f64bf-5vckp] AH00295: caught SIGTERM, shutting down

記錄格式

配置Apache HTTPD Web伺服器錯誤日誌

mod_rewrite日誌級別由檔案中的變數REWRITE_LOG_LEVEL定義 conf.d/variables/global.var.

它可設為error、warn、info、debug和trace1 - trace8，預設值為warn。 若要對RewriteRules進行除錯，建議將記錄層級提升為trace2。

請參閱 mod_rewrite模組檔案 以取得更多資訊。

若要根據環境設定記錄層級，請在global.var檔案中使用適當的條件分支，如下所述：

Define REWRITE_LOG_LEVEL debug

<IfDefine ENVIRONMENT_STAGE>
  ...
  Define REWRITE_LOG_LEVEL warn
  ...
</IfDefine>
<IfDefine ENVIRONMENT_PROD>
  ...
  Define REWRITE_LOG_LEVEL error
  ...
</IfDefine>

Dispatcher記錄檔

範例

[17/Jul/2020:23:48:06 +0000] [I] [cm-p12904-e25628-aem-publish-6c5f7c9dbd-mzcvr] "GET /content/wknd/us/en/adventures.html" - 475ms [publishfarm/0] [action miss] "publish-p12904-e25628.adobeaemcloud.com"
[17/Jul/2020:23:48:07 +0000] [I] [cm-p12904-e25628-aem-publish-6c5f7c9dbd-mzcvr] "GET /content/wknd/us/en/adventures/climbing-new-zealand/_jcr_content/root/responsivegrid/carousel/item_1571266094599.coreimg.jpeg/1473680817282/sport-climbing.jpeg" 302 10ms [publishfarm/0] [action none] "publish-p12904-e25628.adobeaemcloud.com"
[17/Jul/2020:23:48:07 +0000] [I] [cm-p12904-e25628-aem-publish-6c5f7c9dbd-mzcvr] "GET /content/wknd/us/en/adventures/ski-touring-mont-blanc/_jcr_content/root/responsivegrid/carousel/item_1571168419252.coreimg.jpeg/1572047288089/adobestock-238230356.jpeg" 302 11ms [publishfarm/0] [action none] "publish-p12904-e25628.adobeaemcloud.com"

記錄格式

設定Dispatcher錯誤記錄

Dispatcher記錄層級由檔案中的變數DISP_LOG_LEVEL定義 conf.d/variables/global.var.

它可設為error、warn、info、debug和trace1，預設值為warn。

雖然AEM記錄支援數個其他記錄粒度層級，但Dispatcheras a Cloud Service建議使用下列層級。

若要根據環境設定記錄層級，請在 global.var 檔案，如下所述：

Define DISP_LOG_LEVEL debug

<IfDefine ENVIRONMENT_STAGE>
  ...
  Define DISP_LOG_LEVEL warn
  ...
</IfDefine>
<IfDefine ENVIRONMENT_PROD>
  ...
  Define DISP_LOG_LEVEL error
  ...
</IfDefine>

如何存取記錄檔

雲端環境

AEM雲端服務的as a Cloud Service記錄檔可透過Cloud Manager介面下載，或使用Adobe I/O命令列介面追蹤命令列的記錄檔，以存取。 如需詳細資訊，請參閱 Cloud Manager記錄檔案.

本機 SDK

AEMas a Cloud ServiceSDK提供記錄檔以支援本機開發。

AEM記錄檔位於資料夾中 crx-quickstart/logs，可在此檢視下列記錄檔：

• AEM Java日誌： error.log
• AEM HTTP請求記錄： request.log
• AEM HTTP存取記錄： access.log

Apache層記錄檔（包括Dispatcher）位於Docker容器中，該容器保有Dispatcher。 請參閱 Dispatcher檔案 ，以了解如何啟動Dispatcher。

若要擷取記錄檔：

1. 在命令列上，輸入 docker ps 列出容器
2. 若要登入容器，請輸入「docker exec -it <container> /bin/sh"，其中 <container> 是上一步中的dispatcher容器id
3. 導覽至下方的快取根 /mnt/var/www/html
4. 記錄在 /etc/httpd/logs
5. Inspect記錄檔：可在資料夾XYZ下存取這些檔案，以便檢視下列記錄：
   • Apache HTTPD Web伺服器訪問日誌 — httpd_access.log
   • Apache HTTPD Web伺服器錯誤日誌 — httpd_error.log
   • Dispatcher記錄檔 — dispatcher.log

日誌也直接打印到終端輸出。 大部分情況下，這些記錄檔都應為DEBUG，這可在執行Docker時以參數形式傳入Debug層級來完成。 例如：

DISP_LOG_LEVEL=Debug ./bin/docker_run.sh out docker.for.mac.localhost:4503 8080

調試生產和預備

在特殊情況下，需要更改日誌級別，以在Stage或Production環境中以更精細的粒度登錄。

雖然如此，但您仍須將Git中組態檔的記錄層級從「警告」和「錯誤」變更為「除錯」，並執行AEMas a Cloud Service部署，以便向環境註冊這些組態變更。

根據Debug所寫入的流量和記錄陳述式數量，這可能會對環境造成不利的效能影響，因此，建議對Stage和Production偵錯層級進行以下變更：

• 審慎行事，只有在絕對必要時
• 恢復到適當級別並盡快重新部署

Splunk日誌

擁有Splunk帳戶的客戶可透過客戶支援票證要求，將其AEM Cloud Service記錄檔轉送至適當的索引。 記錄資料等同於透過Cloud Manager記錄檔下載取得的功能，但客戶可能會發現，運用Splunk產品中可用的查詢功能相當方便。

與發送到Splunk的日誌關聯的網路頻寬被視為客戶網路I/O使用的一部分。

啟用Splunk轉送

在支援請求中，客戶應指出：

• Splunk HEC端點地址。 此端點必須具備有效的SSL憑證，且可公開存取。
• Splunk索引
• Splunk埠
• Splunk HEC代號。 請參閱 本頁 以取得更多資訊。

應為每個相關程式/環境類型組合指定上述屬性。 例如，如果客戶想要開發、測試和生產環境，他們應提供三組資訊，如下所示。

除了預備/生產環境外，您還應確定初始要求包含所有應啟用的開發環境。 Splunk必須有SSL憑證，且必須公開。

如果在初始要求後建立的任何新開發環境都要有Splunk轉送，但未啟用，則應提出其他要求。

另請注意，如果已請求開發環境，請求或甚至沙箱環境中以外的其他開發環境可能會啟用Splunk轉送，且會共用Splunk索引。 客戶可使用 aem_env_id 欄位來區分這些環境。

以下是客戶支援請求的範例：

方案123，生產環境

• Splunk HEC端點地址： splunk-hec-ext.acme.com
• Splunk索引：acme_123prod（客戶可選擇想要的任何命名慣例）
• Splunk埠：443
• Splunk HEC令牌：ABC123

方案123，階段環境

• Splunk HEC端點地址： splunk-hec-ext.acme.com
• Splunk索引：acme_123stage
• Splunk埠：443
• Splunk HEC令牌：ABC123

方案123, Dev Envs

• Splunk HEC端點地址： splunk-hec-ext.acme.com
• Splunk索引：acme_123dev
• Splunk埠：443
• Splunk HEC令牌：ABC123

這可能足以讓每個環境使用相同的Splunk索引，在此情況下， aem_env_type 欄位可用來根據dev、stage和prod值進行區分。 如果有多個開發環境， aem_env_id 欄位也可供使用。 如果關聯的索引限制了對精簡的Splunk用戶集的訪問，則某些組織可能會為生產環境的日誌選擇單獨的索引。

以下是記錄項目的範例：

aem_env_id: 1242
aem_env_type: dev
aem_program_id: 12314
aem_tier: author
file_path: /var/log/aem/error.log
host: 172.34.200.12
level: INFO
msg: [FelixLogListener] com.adobe.granite.repository Service [5091, [org.apache.jackrabbit.oak.api.jmx.SessionMBean]] ServiceEvent REGISTERED
orig_time: 16.07.2020 08:35:32.346
pod_name: aemloggingall-aem-author-77797d55d4-74zvt
splunk_customer: true

Business.Adobe.com 資源