Azure Monitor CLI を使用して Load Balancer のメトリックを取得する

[アーティクル]
06/27/2024

この記事では、Azure Monitor CLI を使用して Load Balancer メトリックを一覧表示するいくつかの例について説明します。

Azure Monitor CLI を使用してメトリックを取得するための完全なリファレンスドキュメントとその他のサンプルについては、az monitor metrics リファレンスを参照してください。

CLI 経由のメトリック名の表

CLI を使用する場合、Load Balancer メトリックで、CLI パラメーター値に異なるメトリック名が使用されることがあります。 --metric dimension パラメーターを使用してメトリック名を指定する場合は、代わりに CLI メトリック名を使用してください。たとえば、メトリックのデータパス可用性は、--metric VipAvaialbility のパラメーターを指定することによって使用されます。

一般的な Load Balancer メトリック、CLI メトリック名、クエリの推奨集計値の表を次に示します。

メトリック	CLI メトリック名	推奨される集計
データパスの可用性	VipAvailability	Average
正常性プローブの状態	DipAvailability	Average
SYN (同期) 数	SYNCount	Average
SNAT 接続数	SnatConnectionCount	SUM
割り当てられる SNAT ポート	AllocatedSnatPorts	Average
使用された SNAT ポート	UsedSnatPorts	Average
バイト数	ByteCount	SUM
パケット数	PacketCount	SUM

メトリックの定義とその他の詳細については、「Load Balancer データの監視のリファレンス」を参照してください。

Load Balancer メトリックの CLI の例

az monitor metrics コマンドは、Azure リソースのメトリックを表示するために使用されます。 Standard Load Balancer で使用できるメトリック定義を確認するには、az monitor metrics list-definitions コマンドを実行します。

# Display available metric definitions for a Standard Load Balancer resource

az monitor metrics list-definitions --resource <resource_id>

注意

以下のすべての例で、<resource_id> は、お使いの Standard Load Balancer の一意なリソース ID に置き換えてください。

リソースの Standard Load Balancer メトリックを取得するには、az monitor metrics list コマンドを使用できます。たとえば、--metric DipAvailability オプションを使用して、"正常性プローブの状態" メトリックを Standard Load Balancer から収集します。


# List the Health Probe Status metric from a Standard Load Balancer

az monitor metrics list --resource <resource_id> --metric DipAvailability

上記のコマンドを実行すると、正常性プローブの状態の出力は次のようになります。

user@Azure:~$ az monitor metrics list --resource <resource_id> --metric DipAvailability
{
  "cost": 59,
  "interval": "0:01:00",
  "namespace": "Microsoft.Network/loadBalancers",
  "resourceregion": "eastus2",
  "timespan": "2022-06-30T15:22:39Z/2022-06-30T16:22:39Z",
  "value": [
    {
      "displayDescription": "Average Load Balancer health probe status per time duration",
      "errorCode": "Success",
      "errorMessage": null,
      "id": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLoadBalancer/providers/Microsoft.Insights/metrics/DipAvailability",
      "name": {
        "localizedValue": "Health Probe Status",
        "value": "DipAvailability"
      },
      "resourceGroup": "myResourceGroup",
      "timeseries": [],
      "type": "Microsoft.Insights/metrics",
      "unit": "Count"
    }
  ]
}
...

–-aggregation パラメーターを使用して、メトリックの集計の種類を指定できます。推奨される集計については、Load Balancer データの監視のリファレンス](./monitor-load-balancer-reference.md)を参照してください。


# List the average Health Probe Status metric from a Standard Load Balancer

az monitor metrics list --resource <resource_id> --metric DipAvailability --aggregation Average

メトリックの間隔を指定するには、--interval パラメーターを使用して ##h##m 形式で値を指定します。既定の間隔は 1m です。


# List the average List the average Health Probe Status metric from a Standard Load Balancer in 5 minute intervals

az monitor metrics list --resource <resource_id> --metric DipAvailability --aggregation Average --interval 5m

既定では、az monitor metrics list は、過去 1 時間のリソースの集計メトリックを返します。日付 (yyyy-mm-dd) 時刻 (hh:mm:ss.xxxxx) タイムゾーン (+/-hh:mm) の形式で --start-time と --end-time を使用して、一定期間にわたるメトリックデータを照会できます。 2022 年 5 月 5 日から 2022 年 5 月 10 日までの正常性プローブの状態を 1 日単位で集計した平均を一覧表示するには、次のコマンドを使用します。

# List average Health Probe Status metric aggregated per day from May 5, 2022 and May 10, 2022. 

az monitor metrics list --resource <resource_id> --metric DipAvailability --start-time 2022-05-01T00:00:00Z --end-time 2022-05-10T00:00:00Z --interval PT24H --aggregation Average

注意

開始時刻と終了時刻は、yyyy-mm-dd の形式を使用して表されます。たとえば、2022 年 5 月 5 日から 2022 年 5 月 10 日までの毎日は、2022-05-01 および 2022-05-10 と表されます。

"BackendIPAddress" などのディメンションでメトリックを分割するには、--filter フラグでディメンションを指定します。メトリックのディメンションは、メトリックの値を記述するためのより多くのデータを含む名前と値のペアです。各メトリックでサポートされるディメンションの詳細については、「Load Balancer データの監視のリファレンス」を参照してください。

# List average Health Probe Status metric and filter for all BackendIPAddress dimensions

az monitor metrics list --resource $res --metric DipAvailability --filter "BackendIPAddress eq '*'" --aggregation Average

特定のディメンション値を指定することもできます。

# List average Health Probe Status metric and filter for the 10.1.0.4 BackendIPAddress dimension

az monitor metrics list --resource <resource_id> --metric DipAvailability --filter "BackendIPAddress eq '10.1.0.4'" --aggregation Average

複数のディメンション値でフィルター処理する必要がある場合は、値の間に and を使用して --filter の値を指定します。

# List average Health Probe Status metric and filter for all BackendIPAddress and BackendPort dimensions

az monitor metrics list --resource <resource_id> --metric DipAvailability --filter "BackendIPAddress eq '*' and BackendPort eq '*'" --aggregation Average

次のステップ

メトリックの定義を確認して、それぞれの生成方法についての理解を深める
Load Balancer に対する接続モニターを作成します
独自のブックを作成します。詳細なメトリックダッシュボードで編集ボタンをクリックして、インスピレーションを得ることができます

次の方法で共有

Azure Monitor CLI を使用して Load Balancer のメトリックを取得する

CLI 経由のメトリック名の表

Load Balancer メトリックの CLI の例

次のステップ

フィードバック

その他のリソース