Linux 用の Log Analytics 仮想マシン拡張機能

[アーティクル]
03/11/2023

概要

Azure Monitor ログは、クラウドとオンプレミスの資産全体にまたがる監視、アラート、アラート修復の機能を提供します。 Linux 用の Log Analytics 仮想マシン拡張機能は、Microsoft によって発行およびサポートされています。この拡張機能では、Azure 仮想マシンに Log Analytics エージェントがインストールされ、仮想マシンが既存の Log Analytics ワークスペースに登録されます。このドキュメントでは、Linux 用の Log Analytics 仮想マシン拡張機能でサポートされているプラットフォーム、構成、デプロイオプションについて詳しく説明します。

Note

Azure Arc 対応サーバーを使用すると、Log Analytics エージェント VM 拡張機能を Azure 以外の Windows や Linux マシンにデプロイ、削除、更新して、ハイブリッドマシンのライフサイクルを通じた管理を簡素化できます。詳細については、「Azure Arc 対応サーバーを使用した仮想マシン拡張機能の管理」を参照してください。

前提条件

オペレーティングシステム

サポートされる Linux ディストリビューションの詳細については、Azure Monitor エージェントの概要に関する記事をご覧ください。

エージェントおよび VM 拡張機能のバージョン

次の表は、Log Analytics VM 拡張機能と Log Analytics エージェントバンドルのバージョンのマッピングをリリースごとに示しています。 Log Analytics エージェントバンドルのバージョンのリリースノートへのリンクが含まれます。リリースノートには、特定のエージェントリリースでのバグ修正と利用可能な新機能の詳細が記載されています。

Log Analytics Linux VM 拡張機能のバージョン	Log Analytics Agent バンドルのバージョン
1.19.0	1.19.0
1.18.1	1.18.1
1.17.2	1.17.2
1.17.1	1.17.1
1.16.0	1.16.0
1.14.23	1.14.23
1.14.20	1.14.20
1.14.19	1.14.19
1.14.16	1.14.16
1.14.13	1.14.13
1.14.11	1.14.11
1.14.9	1.14.9
1.13.40	1.13.40
1.13.35	1.13.35
1.13.33	1.13.33
1.13.27	1.13.27
1.13.15	1.13.9-0
1.12.25	1.12.15-0
1.11.15	1.11.0-9
1.10.0	1.10.0-1
1.9.1	1.9.0-0
1.8.11	1.8.1-256
1.8.0	1.8.0-256
1.7.9	1.6.1-3
1.6.42.0	1.6.0-42
1.4.60.2	1.4.4-210
1.4.59.1	1.4.3-174
1.4.58.7	14.2-125
1.4.56.5	1.4.2-124
1.4.55.4	1.4.1-123
1.4.45.3	1.4.1-45
1.4.45.2	1.4.0-45
1.3.127.5	1.3.5-127
1.3.127.7	1.3.5-127
1.3.18.7	1.3.4-15

Microsoft Defender for Cloud

Microsoft Defender for Cloud は自動的に Log Analytics エージェントをプロビジョニングし、お使いの Azure サブスクリプションの Defender for Cloud によって作成される既定の Log Analytics ワークスペースに接続します。 Microsoft Defender for Cloud を使用している場合は、このドキュメントの手順は実行しないでください。実行すると、構成されているワークスペースが上書きされ、Microsoft Defender for Cloud との接続が中断されます。

インターネット接続

Linux 用の Log Analytics エージェント拡張機能では、ターゲットの仮想マシンがインターネットに接続されている必要があります。

拡張機能のスキーマ

次の JSON は、Log Analytics エージェント拡張機能のスキーマを示しています。この拡張機能では、ターゲット Log Analytics ワークスペースのワークスペース ID とワークスペースキーが必要です (これらの値は Azure Portal の Log Analytics ワークスペースで確認できます)。ワークスペースキーは機密データとして取り扱う必要があるため、保護された設定構成に格納される必要があります。 Azure VM 拡張機能の保護された設定データは暗号化され、ターゲットの仮想マシンでのみ、暗号化が解除されます。 workspaceId と workspaceKey の大文字と小文字は区別されることに注意してください。

注意

コンテナー監視ソリューションは廃止されているため、次のドキュメントでは省略可能な設定 "skipDockerProviderInstall": true を使用します。

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "name": "OMSExtension",
  "apiVersion": "2018-06-01",
  "location": "<location>",
  "dependsOn": [
    "[concat('Microsoft.Compute/virtualMachines/', <vm-name>)]"
  ],
  "properties": {
    "publisher": "Microsoft.EnterpriseCloud.Monitoring",
    "type": "OmsAgentForLinux",
    "typeHandlerVersion": "1.16",
    "autoUpgradeMinorVersion": true,
    "settings": {
      "workspaceId": "myWorkspaceId",
      "skipDockerProviderInstall": true
    },
    "protectedSettings": {
      "workspaceKey": "myWorkSpaceKey"
    }
  }
}

注意

上のスキーマは、テンプレートのルートレベルに配置されると仮定しています。テンプレートの仮想マシンリソース内に配置する場合は、type説明するように、type および name プロパティを変更する必要があります。

プロパティ値

名前	値/例
apiVersion	2018-06-01
publisher	Microsoft.EnterpriseCloud.Monitoring
type	OmsAgentForLinux
typeHandlerVersion	1.16
workspaceId (例)	6f680a37-00c6-41c7-a93f-1437e3462574
workspaceKey (例)	z4bU3p1/GrnWpQkky4gdabWXAhbWSTz70hm4m2Xt92XI+rSRgE8qVvRhsGo9TXffbrTahyrwv35W0pOqQAU7uQ==

テンプレートのデプロイ

注意

Log Analytics VM 拡張機能の特定のコンポーネントは、Diagnostics VM 拡張機能にも付属しています。このアーキテクチャが原因で、両方の拡張機能が同じ ARM テンプレートでインスタンス化されると、競合が発生する可能性があります。このようなインストール時の競合を回避するには、dependsOn ディレクティブを使用して、拡張機能が順番にインストールされるようにします。拡張機能は、どちらの順序でもインストールできます。

Azure VM 拡張機能は、Azure Resource Manager テンプレートでデプロイできます。テンプレートは、デプロイ後の構成 (Azure Monitor ログへのオンボードなど) が必要な仮想マシンを 1 つ以上デプロイするときに最適です。 Log Analytics エージェント VM 拡張機能を含む Resource Manager テンプレートのサンプルは、Azure クイックスタートギャラリーにあります。

仮想マシン拡張機能の JSON 構成は、仮想マシンリソース内に入れ子にすることも、Resource Manager JSON テンプレートのルートまたは最上位レベルに配置することもできます。 JSON 構成の配置は、リソースの名前と種類の値に影響します。詳細については、子リソースの名前と種類の設定に関する記事を参照してください。

次の例では、VM 拡張機能が仮想マシンリソース内で入れ子になっていることを前提としています。拡張機能リソースを入れ子にすると、JSON は仮想マシンの "resources": [] オブジェクトに配置されます。

{
  "type": "extensions",
  "name": "OMSExtension",
  "apiVersion": "2018-06-01",
  "location": "<location>",
  "dependsOn": [
    "[concat('Microsoft.Compute/virtualMachines/', <vm-name>)]"
  ],
  "properties": {
    "publisher": "Microsoft.EnterpriseCloud.Monitoring",
    "type": "OmsAgentForLinux",
    "typeHandlerVersion": "1.16",
    "settings": {
      "workspaceId": "myWorkspaceId",
      "skipDockerProviderInstall": true
    },
    "protectedSettings": {
      "workspaceKey": "myWorkSpaceKey"
    }
  }
}

拡張機能 JSON をテンプレートのルートに配置すると、リソース名には親仮想マシンへの参照が含まれて、種類は入れ子になっている構成を反映します。

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "name": "<parentVmResource>/OMSExtension",
  "apiVersion": "2018-06-01",
  "location": "<location>",
  "dependsOn": [
    "[concat('Microsoft.Compute/virtualMachines/', <vm-name>)]"
  ],
  "properties": {
    "publisher": "Microsoft.EnterpriseCloud.Monitoring",
    "type": "OmsAgentForLinux",
    "typeHandlerVersion": "1.16",
    "settings": {
      "workspaceId": "myWorkspaceId",
      "skipDockerProviderInstall": true
    },
    "protectedSettings": {
      "workspaceKey": "myWorkSpaceKey"
    }
  }
}

Azure CLI でのデプロイ

Azure CLI を使用して、Log Analytics エージェント VM 拡張機能を既存の仮想マシンにデプロイすることができます。下の myWorkspaceKey 値をワークスペースキーに、myWorkspaceId 値をワークスペース ID に置き換えます。これらの値は、 [詳細設定] の下にある Azure portal の Log Analytics ワークスペースにあります。 latestVersion 値を Log Analytics Linux VM 拡張機能バージョンのバージョンに置換します。

az vm extension set \
  --resource-group myResourceGroup \
  --vm-name myVM \
  --name OmsAgentForLinux \
  --publisher Microsoft.EnterpriseCloud.Monitoring \
  --protected-settings '{"workspaceKey":"myWorkspaceKey"}' \
  --settings '{"workspaceId":"myWorkspaceId","skipDockerProviderInstall": true}' \
  --version latestVersion

Azure PowerShell でのデプロイ

Azure Powershell コマンドレットを使用して、Log Analytics エージェント VM 拡張機能を既存の仮想マシンにデプロイすることができます。下の myWorkspaceKey 値をワークスペースキーに、myWorkspaceId 値をワークスペース ID に置き換えます。これらの値は、 [詳細設定] の下にある Azure portal の Log Analytics ワークスペースにあります。 latestVersion 値を Log Analytics Linux VM 拡張機能バージョンのバージョンに置換します。

Set-AzVMExtension \
  -ResourceGroupName myResourceGroup \
  -VMName myVM \
  -ExtensionName OmsAgentForLinux \
  -ExtensionType OmsAgentForLinux \
  -Publisher Microsoft.EnterpriseCloud.Monitoring \
  -TypeHandlerVersion latestVersion \
  -ProtectedSettingString '{"workspaceKey":"myWorkspaceKey"}' \
  -SettingString '{"workspaceId":"myWorkspaceId","skipDockerProviderInstall": true}'

トラブルシューティングとサポート

トラブルシューティング

拡張機能のデプロイ状態に関するデータを取得するには、Azure portal、Azure CLI、または Azure Powershell を使用します。特定の VM の拡張機能のデプロイ状態を確認するには、Azure CLI を使用している場合は、次のコマンドを実行します。

az vm extension list --resource-group myResourceGroup --vm-name myVM -o table

拡張機能の実行の出力は、次のファイルにログ記録されます。

/var/log/azure/Microsoft.EnterpriseCloud.Monitoring.OmsAgentForLinux/extension.log

Azure CLI を使用している場合、VM にインストールされている OMS 拡張機能のバージョンを取得するには、次のコマンドを実行します。

az vm extension show --resource-group myResourceGroup --vm-name myVM --instance-view

Azure PowerShell を使用している場合、VM にインストールされている OMS 拡張機能のバージョンを取得するには、次のコマンドを実行します。

Get-AzVMExtension -ResourceGroupName my_resource_group  -VMName my_vm_name -Name OmsAgentForLinux -Status

エラーコードとその意味

エラーコード	意味	可能なアクション
9	Enable が予定よりも早く呼び出されました	入手できる最新のバージョンに Azure Linux エージェントを更新します。
10	VM は既に Log Analytics ワークスペースに接続されています	拡張スキーマに指定されたワークスペースに VM を接続するには、パブリック設定で stopOnMultipleConnections を false に設定するか、このプロパティを削除します。この VM は、各ワークスペースに接続された後、課金されます。
11	拡張機能に提供された構成が無効です	前の例に従って、デプロイするために必要なすべてのプロパティ値を設定します。
17	Log Analytics パッケージのインストールが失敗しました
18	OMSConfig パッケージのインストールに失敗しました。	コマンド出力で根本的な障害を調べてください。
19	OMI パッケージのインストールが失敗しました
20	SCX パッケージのインストールが失敗しました
33	omsconfig のメタ構成の生成でエラーが発生しました。	出力の詳細情報を添えて GitHub の問題を提出してください。
51	VM のオペレーティングシステムでは、この拡張機能はサポートされていません
52	依存関係またはアクセス許可が不足しているため、この拡張機能は失敗しました	不足している依存関係またはアクセス許可に関する詳細情報を出力とログで確認します。
53	構成パラメーターが不足しているか正しくないため、この拡張機能は失敗しました	正しくない処理に関する詳細情報を出力とログで確認します。さらに、ワークスペース ID が正しいこと、およびコンピューターがインターネットに接続されていることを確認します。
55	Azure Monitor サービスに接続できない、必要なパッケージが見つからない、または dpkg パッケージマネージャーがロックされています	システムがインターネットにアクセスしていること、または有効な HTTP プロキシが指定されていることを確認します。さらに、ワークスペース ID が正しいこと、および curl ユーティリティと tar ユーティリティがインストールされていることを確認します。

その他のトラブルシューティング情報については、Log Analytics エージェントのトラブルシューティングに関する記事を参照してください。

サポート

この記事についてさらにヘルプが必要な場合は、いつでも MSDN の Azure フォーラムと Stack Overflow フォーラムで Azure エキスパートに問い合わせることができます。または、Azure サポートインシデントを送信できます。その場合は、Azure サポートのサイトに移動して、[サポートの要求] をクリックします。 Azure サポートの使用方法の詳細については、「 Microsoft Azure サポートに関する FAQ」を参照してください。