クラスターメトリックの構成

  • [アーティクル]

ユーザーがクラスターをデプロイすると、標準のメトリック セットの収集が有効になります。 メトリックの一覧については、収集されるメトリックの一覧に関する記事を参照してください。

ユーザーは、含まれているこれらの標準メトリックの収集動作を制御 (有効化や無効化) できません。 ただし、一覧へのリンクに含まれていないいくつかのオプションのメトリックの収集はユーザーが制御できます。 このエクスペリエンスを有効にするには、ユーザーがクラスターに対して MetricsConfiguration リソースを作成して更新する必要があります。 既定では、この MetricsConfiguration リソースの作成によって、メトリックの収集が変わるわけではありません。 これらのオプションのメトリック収集を有効または無効にするには、ユーザーがリソースを更新する必要があります。

Note

  • クラスターに対して作成できるのは、最大で 1 つの MetricsConfiguration リソースのみです。
  • 制御できるオプションのメトリックの一覧を確認するには、ユーザーが MetricsConfiguration リソースを作成する必要があります。
  • MetricsConfiguration リソースを削除すると、標準のメトリック セットが復元されます。

クラスターのメトリック構成を管理する方法

クラスターのメトリック構成のライフサイクルをサポートするために、次の対話を使用して、クラスターのメトリック構成を作成および管理できます。

メトリック構成を作成する

az network cluster metricsconfiguration create コマンドを使用して、クラスターのメトリック構成を作成します。 複数の Azure サブスクリプションがある場合、ユーザーは CLI コマンドにフラグ --subscription <SUBSCRIPTION_ID> を使用してサブスクリプション ID を渡すか、az account set コマンドを使用して適切なサブスクリプション ID を選択する必要があります。

az networkcloud cluster metricsconfiguration create \
 --cluster-name "<CLUSTER>" \
 --extended-location name="<CLUSTER_EXTENDED_LOCATION_ID>" type="CustomLocation" \
 --location "<LOCATION>" \
 --collection-interval <COLLECTION_INTERVAL (1-1440)> \
 --enabled-metrics "<METRIC_TO_ENABLE_1>" "<METRIC_TO_ENABLE_2>" \
 --tags <TAG_KEY1>="<TAG_VALUE1>" <TAG_KEY2>="<TAG_VALUE2>" \
 --resource-group "<RESOURCE_GROUP>"
  • <> 内の値は、具体的な情報に置き換えてください。
  • クラスター リソースに対してクエリを実行し、properties.clusterExtendedLocation で <CLUSTER-EXTENDED-LOCATION-ID> の値を見つけます
  • collection-interval フィールドは必須フィールドで、enabled-metrics は省略可能なフィールドです。

別の方法として、オペレーターが json または yaml ファイルを使用して、有効なメトリックの一覧を提供できます。

例: enabled-metrics.json ファイル

[
   "metric_1",
   "metric_2"
]

例: enabled-metrics.yaml ファイル

- "metric_1"
- "metric_2"

enabled-metrics json/yaml ファイルを使用するコマンドの例:

az networkcloud cluster metricsconfiguration create \
 --cluster-name "<CLUSTER>" \
 --extended-location name="<CLUSTER_EXTENDED_LOCATION_ID>" type="CustomLocation" \
 --location "<LOCATION>" \
 --collection-interval <COLLECTION_INTERVAL (1-1440)> \
 --enabled-metrics <path-to-yaml-or-json-file> \
 --tags <TAG_KEY1>="<TAG_VALUE1>" <TAG_KEY2>="<TAG_VALUE2>" \
 --resource-group "<RESOURCE_GROUP>"

ここで、<path-to-yaml-or-json-file> を、アクションの実行前に ./enabled-metrics.json または ./enabled-metrics.yaml (現在の作業ディレクトリに下にファイルを配置してください) にできます。

使用可能なすべてのパラメーターとその説明を表示するには、次のコマンドを実行します。

az networkcloud cluster metricsconfiguration create --help

メトリック構成の要素

パラメーター名 説明
CLUSTER クラスターのリソース名
LOCATION クラスターがデプロイされる Azure リージョン
CLUSTER_EXTENDED_LOCATION_ID Azure portal で拡張されたクラスターの場所
COLLECTION_INTERVAL 既定の標準メトリックの収集頻度
RESOURCE_GROUP クラスター リソース グループの名前
TAG_KEY1 MetricsConfiguration create に渡すオプションの tag1
TAG_VALUE1 MetricsConfiguration create に渡すオプションの tag1 の値
TAG_KEY2 MetricsConfiguration create に渡すオプションの tag2
TAG_VALUE2 MetricsConfiguration create に渡すオプションの tag2 の値
METRIC_TO_ENABLE_1 既定のメトリックに加えて有効にするオプションのメトリック "METRIC_TO_ENABLE_1"
METRIC_TO_ENABLE_2 既定のメトリックに加えて有効にするオプションのメトリック "METRIC_TO_ENABLE_2"

az コマンドで --no-wait --debug オプションを指定すると、このコマンドの実行が非同期になります。 詳細については、非同期操作の追跡方法に関する記事を参照してください。

Note

  • 標準のメトリック セットの既定のメトリック収集間隔は、5 分ごとに設定されます。 collectionInterval を変更すると、既定の標準メトリックの収集頻度にも影響します。
  • 定義できるメトリック構成のセットは、クラスターごとに 1 つのみです。 リソースは、default という名前で作成されます。

メトリック構成を一覧表示する

az networkcloud cluster metricsconfiguration list コマンドを使用して、特定のクラスターのメトリック構成リソースを確認できます。

az networkcloud cluster metricsconfiguration list \
 --cluster-name "<CLUSTER>" \
 --resource-group "<RESOURCE_GROUP>"

メトリック構成を取得する

メトリック構成が作成されたら、オペレーターは az networkcloud cluster metricsconfiguration show コマンドを使用してリソースの詳細を確認できます。

az networkcloud cluster metricsconfiguration show \
 --cluster-name "<CLUSTER>" \
 --resource-group "<RESOURCE_GROUP>"

このコマンドは、メトリック構成の JSON 表現を返します。 このコマンドの出力として、収集頻度に加えて、有効および無効なメトリックの一覧を確認できます。

メトリック構成を更新する

メトリック構成の作成と同様に、オペレーターは更新アクションを実行して構成を変更したり、メトリック構成に割り当てられたタグを更新したりできます。

az networkcloud cluster metricsconfiguration update \
 --cluster-name "<CLUSTER>" \
 --collection-interval <COLLECTION_INTERVAL (1-1440)> \
 --enabled-metrics "<METRIC_TO_ENABLE_1>" "<METRIC_TO_ENABLE_2>" \
 --tags <TAG_KEY1>="<TAG_VALUE1>" <TAG_KEY2>="<TAG_VALUE2>" \
 --resource-group "<RESOURCE_GROUP>"

オペレーターは、enabled-metrics リストに関係なく collection-interval を更新できます。 変更されないフィールドは省略してください。

az コマンドで --no-wait --debug オプションを指定すると、このコマンドの実行が非同期になります。 詳細については、非同期操作の追跡方法に関する記事を参照してください。

メトリック構成を削除する

メトリック構成を削除すると、クラスターが変更されていない構成に戻ります。 メトリック構成を削除するには、次のコマンドを使用します。

az networkcloud cluster metricsconfiguration delete \
 --cluster-name "<CLUSTER>" \
 --resource-group "<RESOURCE_GROUP>"

az コマンドで --no-wait --debug オプションを指定すると、このコマンドの実行が非同期になります。 詳細については、非同期操作の追跡方法に関する記事を参照してください。