Azure App Service と Java のアプリケーション監視

[アーティクル]
06/23/2023

Azure App Service で実行されている Java の Web アプリケーションを監視するのに、コードを変更する必要はありません。この記事では、Azure Monitor Application Insights の監視を有効にする手順を説明し、大規模なデプロイプロセスを自動化する準備となるガイダンスを提供します。

Note

Spring Boot ネイティブイメージアプリケーションでは、以下で説明する Application Insights Java エージェントソリューションではなく、Spring Boot ネイティブイメージ Java アプリケーションの Azure Monitor OpenTelemetry Distro/Application Insights プロジェクトを使用します。

Application Insights を有効にする

Azure App Service で実行されている Java アプリケーションのアプリケーション監視を有効にするには、Azure portal を使用することをお勧めします。 Azure portal でアプリケーション監視を有効にすると、Application Insights でアプリケーションが自動的にインストルメント化され、コードの変更は必要ありません。追加の構成を適用し、特定のシナリオに基づいて、必要に応じて独自のカスタムテレメトリを追加できます。

Azure portal を使用した自動インストルメンテーション

1 回選択するだけで、Azure App Service で実行されている Java アプリの監視を有効にすることができ、コードの変更は必要ありません。この統合により、Application Insights Java 3.x が追加され、テレメトリが自動収集されます。

サポートされている自動インストルメンテーションシナリオの全一覧については、「サポートされている環境、言語、リソースプロバイダー」を参照してください。

お使いのアプリサービスの Azure コントロールパネルで [Application Insights] を選択し、 [有効化] を選択します。
新しいリソースを作成するか、このアプリケーションの既存の Application Insights リソースを選択します。

Note

[OK] を選択して新しいリソースを作成すると、監視の設定を適用するように求めるメッセージが表示されます。 [続行] を選択すると、新しい Application Insights リソースがアプリサービスにリンクされ、アプリサービスの再起動がトリガーされます。
この最後の手順は省略可能です。使用するリソースを指定したら、Java エージェントを構成できます。 Java エージェントを構成しない場合は、既定の構成が適用されます。

完全な構成のセットを使用できます。必要なのは、有効な json ファイルを貼り付けることだけです。 プレビュー段階にある接続文字列とすべての構成を除外する - 現在プレビュー段階の項目は、一般提供されたときに追加することができます。

Azure portal で構成を変更すると APPLICATIONINSIGHTS_CONFIGURATION_FILE 環境変数が自動的に設定され、App Service の設定パネルに表示されます。この変数には、Azure portal で Java アプリの構成テキストボックスに貼り付けた完全な json の内容が含まれます。

クライアント側の監視を有効にする

Java アプリケーションでクライアント側の監視を有効にするには、クライアント側の JavaScript SDK をアプリケーションに手動で追加する必要があります。

監視の自動化

Application Insights でのテレメトリ収集を有効にするのに必要なのは、次のアプリケーション設定を設定することだけです。

利用可能な Application Insights の設定が表示された App Service のアプリケーション設定のスクリーンショット。

アプリケーション設定の定義

アプリ設定の名前	定義	値
ApplicationInsightsAgent_EXTENSION_VERSION	メインの拡張機能で、実行時の監視を制御します。	Windows では `~2`、Linux では `~3`。
XDT_MicrosoftApplicationInsights_Java	Java エージェントを含めるかどうかを制御するフラグ。	0 または 1 (Windows にのみ適用)。

Note

プロファイラーとスナップショットデバッガーは Java アプリケーションでは使用できません

Azure Resource Manager を使用した App Service のアプリケーション設定

Azure App Service のアプリケーション設定は、Azure Resource Manager テンプレートを使用して管理および構成できます。この手法は、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"
          }
        }
      ]

アプリケーション設定が Application Insights 用に構成されている Resource Manager テンプレートの例として、このテンプレートが役に立ちます。具体的には、238 行目から始まるセクションを参照してください。

Application Insights のリソースと、新しく作成された App Service リソースへのリンクの作成を自動化します。

既定の Application Insights の設定で Resource Manager テンプレートを作成するには、Application Insights を有効にして新しい Web アプリを作成する場合のようにプロセスを開始します。

目的の Web アプリ情報を含む新しい App Service リソースを作成します。 [監視] タブで Application Insights を有効にします。
[Review + create](レビュー + 作成) を選択します。次に、[オートメーション用のテンプレートをダウンロードする] を選択します。

このオプションにより、必要な設定がすべて設定済みの、最新の Resource Manager テンプレートが生成されます。

次の例で、すべての AppMonitoredSite をサイト名に置き換えてください。

Note

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 という Web サイトのアプリケーション監視を有効にします。これによって、012345678-abcd-ef01-2345-6789abcd インストルメンテーションキーに送信されるようにデータが構成されます。

Note

Azure を操作するには、Azure Az PowerShell モジュールを使用することをお勧めします。作業を開始するには、Azure PowerShell のインストールに関する記事を参照してください。 Az PowerShell モジュールに移行する方法については、「AzureRM から Az への Azure PowerShell の移行」を参照してください。

Note

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 Service 上で実行されている Java ベースのアプリケーションのトラブルシューティングを行います。

ApplicationInsightsAgent_EXTENSION_VERSION アプリ設定が、Windows では "2 以下"、Linux では "3 以下" の値に設定されていることを確認します
ログファイルを調べて、エージェントが正常に開始されたことを確認します。 https://yoursitename.scm.azurewebsites.net/ でルートディレクトリへの SSH の変更の下を見ると、ログファイルは LogFiles/ApplicationInsights の下にあります。
Java アプリのアプリケーション監視を有効にした後、ライブメトリックを確認すると、エージェントが動作していることを検証できます。App Service にアプリをデプロイする前でも、環境からのいくつかの要求が表示されます。テレメトリの完全なセットは、アプリがデプロイされて実行している場合にのみ利用可能であることに注意してください。
エラーが表示されず、テレメトリがない場合は、APPLICATIONINSIGHTS_SELF_DIAGNOSTICS_LEVEL 環境変数を "debug" に設定します

Application Insights の標準メトリックと Azure App Service メトリックの違い

Application Insights では、アプリケーションに対して行われた要求のテレメトリを収集します。 WebApps/WebServer でエラーが発生し、要求がユーザーアプリケーションに到達しなかった場合、それに関するテレメトリは Application Insights に含まれません。

Application Insights によって計算された serverresponsetime の期間は、Web Apps から見たサーバー応答時間とは必ずしも一致しません。この動作は、Application Insights では、要求がユーザーアプリケーションに実際に到達した場合の期間のみがカウントされるためです。 WebServer で要求の送信が滞った場合やキューに入れられた場合、その待機時間は、Web Apps のメトリックに含まれますが Application Insights のメトリックには含まれません。

アプリケーションホストとインジェストサービスの間の接続をテストする

Application Insights SDK とエージェントからテレメトリが送信され、インジェストエンドポイントへの REST 呼び出しとして取り込まれます。 Web サーバーまたはアプリケーションホストマシンからインジェストサービスエンドポイントへの接続は、PowerShell の生の REST クライアントを使用するか、curl コマンドを使用してテストできます。「Azure Monitor Application Insights でアプリケーションテレメトリが見つからない場合のトラブルシューティング」をご覧ください。

リリースノート

最新の更新プログラムとバグ修正については、リリースノートを参照してください。

次のステップ

Application Insights で Azure Functions を監視します。
Azure Diagnostics が Application Insights に送信されるように設定します。
サービスの正常性メトリックを監視して、サービスの可用性と応答性を確認します。
操作イベントが発生したり、メトリックがしきい値を超えたりするたびに、アラート通知を受け取ります。
JavaScript のアプリや Web ページに Application Insights を使用して、Web ページを参照しているブラウザーからクライアントテレメトリを取得します。
可用性の概要

Azure App Service と Java のアプリケーション監視

Application Insights を有効にする

Azure portal を使用した自動インストルメンテーション

クライアント側の監視を有効にする

監視の自動化

アプリケーション設定の定義

Azure Resource Manager を使用した App Service のアプリケーション設定

Application Insights のリソースと、新しく作成された App Service リソースへのリンクの作成を自動化します。

PowerShell を使用して有効にする

トラブルシューティング

Application Insights の標準メトリックと Azure App Service メトリックの違い

アプリケーションホストとインジェストサービスの間の接続をテストする

最新の Application Insights Java バージョンを手動でデプロイする

リリースノート

次のステップ

その他のリソース

Azure App Service と Java のアプリケーション監視

Application Insights を有効にする

Azure portal を使用した自動インストルメンテーション

クライアント側の監視を有効にする

監視の自動化

アプリケーション設定の定義

Azure Resource Manager を使用した App Service のアプリケーション設定

Application Insights のリソースと、新しく作成された App Service リソースへのリンクの作成を自動化します。

PowerShell を使用して有効にする

トラブルシューティング

Application Insights の標準メトリックと Azure App Service メトリックの違い

アプリケーション ホストとインジェスト サービスの間の接続をテストする

最新の Application Insights Java バージョンを手動でデプロイする

リリース ノート

次のステップ

その他のリソース

アプリケーションホストとインジェストサービスの間の接続をテストする

リリースノート