即時串流 Azure Spring 應用程式的應用程式主控台記錄

發行項
11/20/2024

注意

基本、標準和企業方案將從 2025 年 3 月中旬開始淘汰，並停用 3 年。建議您轉換至 Azure Container Apps。如需詳細資訊，請參閱 Azure Spring Apps 淘汰公告。

標準 耗用量和專用 方案將從 2024 年 9 月 30 日起淘汰，並在六個月後完成關閉。建議您轉換至 Azure Container Apps。如需詳細資訊，請參閱將 Azure Spring Apps 標準取用和專用方案遷移至 Azure Container Apps。

本文適用於：✅ Java ✅ C#

本文適用於：✅ 基本/標準 ✅ 企業

本文說明如何在 Azure CLI 中啟用記錄串流，以取得即時的應用程式主控台記錄來進行疑難排解。您也可以使用診斷設定，分析 Azure Spring 應用程式中的診斷資料。若要深入了解，請參閱使用診斷設定分析記錄和計量。如需串流記錄的詳細資訊，請參閱即時串流 Azure Spring Apps 作業記錄和即時串流 Azure Spring Apps 受控元件記錄。

必要條件

具有 Azure Spring Apps 延伸模組的 Azure CLI 1.0.0 版或更高版本。您可以使用下列命令來安裝擴充功能：az extension add --name spring
具有執行中應用程式的 Azure Spring Apps 執行個體。如需詳細資訊，請參閱快速入門：將第一個應用程式部署至 Azure Spring Apps。

在 Azure 入口網站中遵循下列步驟以串流記錄：

移至 Azure Spring Apps 服務執行個體 [蓋棺] 頁面，然後在瀏覽窗格中選取 [Apps]。
尋找您的目標應用程式，然後選取操作功能表。
在彈跳操作功能表中，選取 [檢視記錄串流]。

根據預設，記錄會開始串流隨機選取的應用程式執行個體。之後，您可以選擇您的項目。

為了方便起見，串流記錄有許多進入點。您可以在下列窗格中找到他們：

[應用程式清單] 窗格
[部署清單] 窗格
[應用程式執行個體清單] 窗格

本節提供使用 Azure CLI 來產生結尾記錄的範例。若要避免重複指定您的資源群組和服務執行個體名稱，請使用以下命令，設定預設的資源群組名稱和叢集名稱：

az config set defaults.group=<service-group-name>
az config set defaults.spring=<service-instance-name>

下列範例會省略資源群組和服務名稱。

檢視具有單一執行個體的應用程式結尾記錄

如果名為 auth-service 的應用程式只有一個執行個體，您可以使用下列命令來檢視應用程式執行個體的記錄：

az spring app logs --name <application-name>

此命令會傳回類似下列範例的記錄，其中 auth-service 是應用程式名稱。

...
2020-01-15 01:54:40.481  INFO [auth-service,,,] 1 --- [main] o.apache.catalina.core.StandardService  : Starting service [Tomcat]
2020-01-15 01:54:40.482  INFO [auth-service,,,] 1 --- [main] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.22]
2020-01-15 01:54:40.760  INFO [auth-service,,,] 1 --- [main] o.a.c.c.C.[Tomcat].[localhost].[/uaa]  : Initializing Spring embedded WebApplicationContext
2020-01-15 01:54:40.760  INFO [auth-service,,,] 1 --- [main] o.s.web.context.ContextLoader  : Root WebApplicationContext: initialization completed in 7203 ms

...

檢視具有多個執行個體的應用程式結尾記錄

如果名為 auth-service 的應用程式有多個執行個體，則可以使用 -i/--instance 選項來檢視執行個體記錄。

首先，請執行下列命令以取得應用程式執行個體名稱：

az spring app show --name auth-service --query properties.activeDeployment.properties.instances --output table

命令產生的結果與以下輸出類似：

Name                                         Status    DiscoveryStatus
-------------------------------------------  --------  -----------------
auth-service-default-12-75cc4577fc-pw7hb  Running   UP
auth-service-default-12-75cc4577fc-8nt4m  Running   UP
auth-service-default-12-75cc4577fc-n25mh  Running   UP

然後，您可以使用 -i/--instance 選項來串流應用程式執行個體的記錄，如下所示：

az spring app logs --name auth-service --instance auth-service-default-12-75cc4577fc-pw7hb

您也可以從 Azure 入口網站取得應用程式執行個體的詳細資料。在 Azure Spring 應用程式服務的左側瀏覽窗格中選取 [應用程式] 之後，請選取 [應用程式執行個體]。

持續串流新的記錄

依預設，az spring app logs 只會列印串流至應用程式主控台的現有記錄，然後結束。如果您想要串流新的記錄，請新增 -f/--follow 引數，如下列範例所示：

az spring app logs --name auth-service --follow

當您使用 --follow 引數追蹤立即記錄時，除非應用程式持續寫入記錄，否則 Azure Spring 應用程式記錄串流服務會每隔一分鐘會將活動訊號記錄傳送至用戶端。活動訊號記錄訊息會使用下列格式：2020-01-15 04:27:13.473: No log from server。

使用下列命令來檢查支援的所有記錄選項：

az spring app logs --help

格式化 JSON 結構化記錄

注意

將 JSON 結構化記錄格式化需要 Spring 延伸模組 2.4.0 版或更新版本。

結構化應用程式記錄會以 JSON 格式顯示，此格式可能會難以閱讀。您可以使用 --format-json 引數，將 JSON 格式的記錄格式化為更容易閱讀的格式。如需詳細資訊，請參閱 Azure Spring 應用程式的結構化應用程式記錄。

下列範例顯示如何使用 --format-json 引數：

# Raw JSON log
$ az spring app logs --name auth-service
{"timestamp":"2021-05-26T03:35:27.533Z","logger":"com.netflix.discovery.DiscoveryClient","level":"INFO","thread":"main","mdc":{},"message":"Disable delta property : false"}
{"timestamp":"2021-05-26T03:35:27.533Z","logger":"com.netflix.discovery.DiscoveryClient","level":"INFO","thread":"main","mdc":{},"message":"Single vip registry refresh property : null"}

# Formatted JSON log
$ az spring app logs --name auth-service --format-json
2021-05-26T03:35:27.533Z  INFO [           main] com.netflix.discovery.DiscoveryClient   : Disable delta property : false
2021-05-26T03:35:27.533Z  INFO [           main] com.netflix.discovery.DiscoveryClient   : Single vip registry refresh property : null

--format-json 引數也會採用選擇性的自訂格式，並使用格式字串語法。如需詳細資訊，請參閱格式字串語法。

下列範例說明如何使用格式字串語法：

# Custom format
$ az spring app logs --name auth-service --format-json="{message}{n}"
Disable delta property : false
Single vip registry refresh property : null

所使用的預設格式為：

{timestamp} {level:>5} [{thread:>15.15}] {logger{39}:<40.40}: {message}{n}{stackTrace}

將 Azure Spring 應用程式的應用程式記錄串流至虛擬網路插入執行個體

針對部署在自訂虛擬網路中的 Azure Spring 應用程式執行個體，您可以根據預設從私人網路存取記錄串流。如需詳細資訊，請參閱在虛擬網路中部署 Azure Spring Apps

Azure Spring 應用程式也可讓您使用 Azure 入口網站或 Azure CLI，從公用網路存取即時應用程式記錄。

注意

在公用網路上啟用記錄串流端點，會將公用輸入 IP 新增至您的虛擬網路。如果您對此有所顧慮，使用時請務必小心。

Azure 入口網站
Azure CLI

使用下列步驟在公用網路上啟用記錄串流端點：

選取虛擬網路中部署的 Azure Spring 應用程式服務執行個體，然後在導覽功能表中選取 [網路]。
選取 [Vnet 插入] 索引標籤。
將 [公用網路上的資料平面資源] 狀態切換為 [啟用]，以啟用公用網路上的記錄串流端點。此程序會需要幾分鐘的時間。

使用下列命令來啟用記錄串流公用端點：

az spring update \
    --resource-group <resource-group-name> \
    --service <service-instance-name> \
    --enable-dataplane-public-endpoint true

啟用記錄串流公用端點之後，您可以從公用網路存取應用程式記錄，正如同存取一般執行個體。

保護記錄串流公用端點的流量

記錄串流所用的金鑰，與在 Azure Spring 應用程式中設定預備環境所述的測試端點使用相同金鑰，藉此驗證您部署的連線。因此，只有具備測試金鑰讀取權限的使用者才能存取記錄串流。

若要在公開應用程式的公用端點時確保其安全性，請使用網路安全性群組，藉由篩選服務的網路流量來保護端點。如需詳細資訊，請檢閱教學課程：使用 Azure 入口網站透過網路安全性群組篩選網路流量。網路安全性群組包含安全性規則，用來允許或拒絕進出多種 Azure 資源類型的輸入和輸出網路流量。針對每個規則，您可以指定來源與目的地、連接埠和通訊協定。

注意

如果您在啟用記錄串流公用端點之後，無法從網際網路存取虛擬網路插入執行個體中的應用程式記錄，請檢查您的網路安全性群組，查看是否已允許這類輸入流量。

下表顯示我們建議的基本規則範例。您可以使用 nslookup 之類的命令搭配端點 <service-name>.private.azuremicroservices.io 來取得服務的目標 IP 位址。

優先順序	名稱	連接埠	通訊協定	來源	Destination	動作
100	規則名稱	80	TCP	網際網路	服務 IP 位址	允許
110	規則名稱	443	TCP	網際網路	服務 IP 位址	允許

共用方式為