Azure App 服務和 Java 的應用程式監視

發行項
04/07/2024

監視在 Azure App 服務上執行的 Java Web 應用程式不需要修改程式碼。本文將逐步引導您啟用 Azure 監視器 Application Insights 監視，並提供將大規模部署程式自動化的初步指引。

注意

使用 Spring Boot 原生映射應用程式時，請使用 Spring Boot 原生映射 Java 應用程式專案中的 Azure 監視器 OpenTelemetry Distro/ Application Insights，而不是下面所述的 Application Insights Java 代理程式解決方案。

啟用 Application Insights

針對在 Azure App 服務上執行的 Java 應用程式啟用應用程式監視的建議方式是透過 Azure 入口網站。在 Azure 入口網站中開啟應用程式監視會自動使用 Application Insights 檢測您的應用程式，而且不需要變更任何程式碼。您可以套用額外的設定，然後根據您的特定案例，視需要新增自己的自定義遙測。

透過 Azure 入口網站自動建構

您可以針對在 Azure App 服務中執行的 Java 應用程式開啟監視功能，只要選取一個選項，就不需要變更程式代碼。整合會新增 Application Insights Java 3.x ，並自動收集遙測。

如需支援自動結構案例的完整清單，請參閱支援的環境、語言和資源提供者。

在 App Service 的 Azure 控制面板中選取 [Application Insights ]，然後選取 [ 啟用]。
選擇建立新的資源，或為此應用程式選取現有的 Application Insights 資源。

注意

當您選取 [ 確定 ] 以建立新的資源時，系統會提示您套 用監視設定。選取 [ 繼續] 會將新的 Application Insights 資源連結到您的應用程式服務，這麼做也會 觸發 App Service 的重新啟動。
最後一個步驟是選擇性的。指定要使用的資源之後，您可以設定 Java 代理程式。如果您未設定 Java 代理程式，則會套用預設組態。

完整的組態可供使用，您只需要貼上有效的 json 檔案。 排除連接字串和處於預覽狀態的任何組態 - 您可以在專案正式推出時新增目前處於預覽狀態的專案。

一旦您透過 Azure 入口網站修改組態，APPLICATIONINSIGHTS_CONFIGURATION_FILE環境變數會自動填入並出現在 App Service 設定面板中。此變數包含您貼在 Java 應用程式的 Azure 入口網站組態文字框中的完整 json 內容。

啟用用戶端監視

若要啟用 Java 應用程式的用戶端監視，您必須手動將用戶端 JavaScript SDK 新增至您的應用程式。

自動化監視

若要使用Application Insights 啟用遙測收集，只需要設定下列應用程式設定：

App Service Application 設定的螢幕快照，其中包含可用的 Application Insights 設定。

應用程式設定定義

應用程式設定名稱	定義	值
ApplicationInsightsAgent_EXTENSION_VERSION	主要延伸模組，控制運行時間監視。	`~2` 在 Windows 或 `~3` Linux 中。
XDT_MicrosoftApplicationInsights_Java	旗標以控制是否包含 Java 代理程式。	0 或 1 （僅適用於 Windows）。

注意

分析工具和快照調試程式不適用於Java應用程式

搭配 Azure Resource Manager 的 App Service 應用程式設定

您可以使用 Azure Resource Manager 樣本來管理和設定 Azure App 服務的應用程式設定。當您使用 Resource Manager 自動化部署新的 App Service 資源，或修改現有資源的設定時，可以使用此方法。

App Service 資源的應用程式設定 JSON 基本結構：

      "resources": [
        {
          "name": "appsettings",
          "type": "config",
          "apiVersion": "2015-08-01",
          "dependsOn": [
            "[resourceId('Microsoft.Web/sites', variables('webSiteName'))]"
          ],
          "tags": {
            "displayName": "Application Insights Settings"
          },
          "properties": {
            "key1": "value1",
            "key2": "value2"
          }
        }
      ]

如需 Resource Manager 範例，其中已針對 Application Insights 設定應用程式設定，此範本會很有説明。具體來說，請參閱從第 238 行開始的區段。

自動建立 Application Insights 資源，並連結至新建立的 App Service 資源

若要使用預設 Application Insights 設定建立 Resource Manager 範本，請開始程式，就像您要建立已啟用 Application Insights 的新 Web 應用程式一樣。

使用所需的 Web 應用程式資訊建立新的 App Service 資源。在 [ 監視] 索引標籤上啟用 Application Insights。
選取 [檢閱 + 建立]。然後選取 [ 下載自動化的範本]。

此選項會產生已設定所有必要設定的最新 Resource Manager 範本。

在下列範例中 AppMonitoredSite ，以您的網站名稱取代的所有實例：

注意

如果使用 Windows，請將設定 ApplicationInsightsAgent_EXTENSION_VERSION 為 ~2。如果使用 Linux，請將設定 ApplicationInsightsAgent_EXTENSION_VERSION 為 ~3。

{
    "resources": [
        {
            "name": "[parameters('name')]",
            "type": "Microsoft.Web/sites",
            "properties": {
                "siteConfig": {
                    "appSettings": [
                        {
                            "name": "APPINSIGHTS_INSTRUMENTATIONKEY",
                            "value": "[reference('microsoft.insights/components/AppMonitoredSite', '2015-05-01').InstrumentationKey]"
                        },
                        {
                            "name": "APPLICATIONINSIGHTS_CONNECTION_STRING",
                            "value": "[reference('microsoft.insights/components/AppMonitoredSite', '2015-05-01').ConnectionString]"
                        },
                        {
                            "name": "ApplicationInsightsAgent_EXTENSION_VERSION",
                            "value": "~2"
                        }
                    ]
                },
                "name": "[parameters('name')]",
                "serverFarmId": "[concat('/subscriptions/', parameters('subscriptionId'),'/resourcegroups/', parameters('serverFarmResourceGroup'), '/providers/Microsoft.Web/serverfarms/', parameters('hostingPlanName'))]",
                "hostingEnvironment": "[parameters('hostingEnvironment')]"
            },
            "dependsOn": [
                "[concat('Microsoft.Web/serverfarms/', parameters('hostingPlanName'))]",
                "microsoft.insights/components/AppMonitoredSite"
            ],
            "apiVersion": "2016-03-01",
            "location": "[parameters('location')]"
        },
        {
            "apiVersion": "2016-09-01",
            "name": "[parameters('hostingPlanName')]",
            "type": "Microsoft.Web/serverfarms",
            "location": "[parameters('location')]",
            "properties": {
                "name": "[parameters('hostingPlanName')]",
                "workerSizeId": "[parameters('workerSize')]",
                "numberOfWorkers": "1",
                "hostingEnvironment": "[parameters('hostingEnvironment')]"
            },
            "sku": {
                "Tier": "[parameters('sku')]",
                "Name": "[parameters('skuCode')]"
            }
        },
        {
            "apiVersion": "2015-05-01",
            "name": "AppMonitoredSite",
            "type": "microsoft.insights/components",
            "location": "West US 2",
            "properties": {
                "ApplicationId": "[parameters('name')]",
                "Request_Source": "IbizaWebAppExtensionCreate"
            }
        }
    ],
    "parameters": {
        "name": {
            "type": "string"
        },
        "hostingPlanName": {
            "type": "string"
        },
        "hostingEnvironment": {
            "type": "string"
        },
        "location": {
            "type": "string"
        },
        "sku": {
            "type": "string"
        },
        "skuCode": {
            "type": "string"
        },
        "workerSize": {
            "type": "string"
        },
        "serverFarmResourceGroup": {
            "type": "string"
        },
        "subscriptionId": {
            "type": "string"
        }
    },
    "$schema": "https://schema.management.azure.com/schemas/2014-04-01-preview/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0"
}

透過 PowerShell 啟用

若要透過PowerShell啟用應用程式監視，必須變更基礎應用程式設定。下列範例會針對資源群組 AppMonitoredRG中名為 AppMonitoredSite 的網站啟用應用程式監視。它會設定要傳送至 012345678-abcd-ef01-2345-6789abcd 檢測金鑰的數據。

注意

建議您使用 Azure Az PowerShell 模組來與 Azure 互動。請參閱安裝 Azure PowerShell 以開始使用。若要了解如何移轉至 Az PowerShell 模組，請參閱將 Azure PowerShell 從 AzureRM 移轉至 Az。

注意

如果使用 Windows，請將 ApplicationInsightsAgent_EXTENSION_VERSION 設定為 ~2。如果使用 Linux，請將 ApplicationInsightsAgent_EXTENSION_VERSION 設定為 ~3。

$app = Get-AzWebApp -ResourceGroupName "AppMonitoredRG" -Name "AppMonitoredSite" -ErrorAction Stop
$newAppSettings = @{} # case-insensitive hash map
$app.SiteConfig.AppSettings | %{$newAppSettings[$_.Name] = $_.Value} # preserve non Application Insights application settings.
$newAppSettings["APPINSIGHTS_INSTRUMENTATIONKEY"] = "012345678-abcd-ef01-2345-6789abcd"; # set the Application Insights instrumentation key
$newAppSettings["APPLICATIONINSIGHTS_CONNECTION_STRING"] = "InstrumentationKey=012345678-abcd-ef01-2345-6789abcd"; # set the Application Insights connection string
$newAppSettings["ApplicationInsightsAgent_EXTENSION_VERSION"] = "~2"; # enable the ApplicationInsightsAgent
$app = Set-AzWebApp -AppSettings $newAppSettings -ResourceGroupName $app.ResourceGroup -Name $app.Name -ErrorAction Stop

疑難排解

使用我們的逐步指南，針對在 Azure App 服務上執行的 Java 型應用程式進行疑難解答。

ApplicationInsightsAgent_EXTENSION_VERSION檢查應用程式設定是否設定為 Windows 上的 “~2” 值，Linux 上的 “~3”
檢查記錄檔，以查看代理程式已成功啟動：流覽至『https://yoursitename.scm.azurewebsites.net/，在 SSH 變更根目錄下，記錄檔位於 LogFiles/ApplicationInsights 之下。
為 Java 應用程式啟用應用程式監視之後，您可以藉由查看即時計量來驗證代理程式是否正常運作，即使在您將應用程式部署至 App Service 之前，您也會看到來自環境的一些要求。請記住，只有您的應用程式已部署並執行時，才能使用完整的遙測集。
如果您沒有看到任何錯誤且沒有遙測，請將APPLICATIONINSIGHTS_SELF_DIAGNOSTICS_LEVEL環境變數設定為 [偵錯]

Application Insights 的標準計量與 Azure App 服務計量之間的差異為何？

Application Insights 會收集對應用程式提出要求的遙測。如果 WebApps/WebServer 中發生失敗，且要求未連線到使用者應用程式，Application Insights 就不會有任何遙測數據。

Application Insights 所計算的 serverresponsetime 持續時間不一定符合 Web Apps 觀察到的伺服器回應時間。此行為是因為 Application Insights 只會計算要求實際到達使用者應用程式的持續時間。如果要求在 WebServer 中停滯或排入佇列，等候時間會包含在 Web Apps 計量中，但不包含在 Application Insights 計量中。

測試應用程式主機與擷取服務之間的連線

應用程式深入剖析 SDK 和代理程式會傳送遙測，以擷取為 REST 呼叫擷取到我們擷取的端點。您可以使用來自 PowerShell 或 curl 命令的原始 REST 用戶端，測試從 Web 伺服器或應用程式主機電腦到擷取服務端點的連線。請參閱針對 Azure 監視器 Application Insights 中遺失的應用程式遙測進行疑難排解。

手動部署最新的 Application Insights Java 版本

Application Insights Java 版本會在 App Services 更新時自動更新。

如果您在最新版的 Application Insights Java 中遇到已修正的問題，您可以手動更新它。

若要手動更新，請遵循下列步驟：

將 Java 代理程式 jar 檔案上傳至 App Service

a. 首先，遵循這裡的指示，取得最新版的 Azure CLI。

b. 接下來，遵循這裡的指示，取得最新版的 Application Insights Java 代理程式。

c. 然後，使用下列命令將 Java 代理程式 jar 檔案部署至 App Service： az webapp deploy --src-path applicationinsights-agent-{VERSION_NUMBER}.jar --target-path java/applicationinsights-agent-{VERSION_NUMBER}.jar --type static --resource-group {YOUR_RESOURCE_GROUP} --name {YOUR_APP_SVC_NAME}。或者，您可以使用本指南透過 Maven 外掛程式來部署代理程式。
透過 Azure 入口網站中的 [Application Insights] 索引標籤停用 Application Insights。
上傳代理程式 jar 檔案之後，請移至 App Service 組態。如果您需要使用 Linux 啟動命令 ，請包含 jvm 自變數：

啟動命令 不適用於 JAVA_OPTS JavaSE 或 CATALINA_OPTS Tomcat。

如果您未使用啟動命令，請為 JavaSE 或 CATALINA_OPTS Tomcat 建立新的環境變數JAVA_OPTS，並使用值 -javaagent:{PATH_TO_THE_AGENT_JAR}/applicationinsights-agent-{VERSION_NUMBER}.jar。
重新啟動應用程式以套用變更。

注意

如果您為 JavaSE 或 CATALINA_OPTS Tomcat 環境變數設定 JAVA_OPTS ，則必須在入口網站中停用 Application Insights。或者，如果您想要從入口網站啟用Application Insights，請確定您未在App Service組態設定中設定 JAVA_OPTS For JavaSE 或 CATALINA_OPTS Tomcat 變數。

版本資訊

如需最新的更新和錯誤修正，請參閱版本資訊。

下一步

使用 Application Insights 監視 Azure Functions。
啟用 Azure 診斷以傳送至 Application Insights。
監視服務健康情況計量，以確保您的服務可供使用且有回應。
每當發生作業事件或計量超過閾值時，就會接收警示通知。
使用 Application Insights for JavaScript 應用程式和網頁，從瀏覽網頁的瀏覽器取得客戶端遙測。
可用性概觀