Promitor Scraper設定ファイル（metrics-declaration.yaml）

version

バージョンとして固定値「v1」を指定します。

△

−

v1

azureMetadata:

接続先Azureの情報を設定します。

−

−

−

tenantId:

テナントIDを指定します。

◎

テナントID

指定なし

subscriptionId:

デフォルトのサブスクリプションIDを指定します。

◎

サブスクリプションID

指定なし

resourceGroupName:

デフォルトのリソースグループ名を指定します。

◎

リソースグループ名

指定なし

[cloud:]

Azureクラウドの名前を指定します。

Global，China，UsGoy，Germanyを指定できます。

指定を省略した場合，「Global」が仮定されます。

○

−

指定なし

metricDefaults:

メトリックのデフォルトを設定します。

−

−

−

aggregation:

集約の設定をします。

○

−

−

[interval]:

メトリクスの測定値を集計するインターバルの値を指定します。

○

−

00:05:00

[limit]:

ディメンションやフィルタを指定したときの最大のリソース数を指定します。

指定を省略した場合，「10000」が仮定されます。

○

−

指定なし

labels:

すべてのメトリクスに付与するラベルを設定します。

−

−

−

<key>: <value>

キーとバリューの値をそれぞれ1〜255文字の文字列で指定します。

キーは，正規表現[a-z _:][a-z0-9_:]*と一致する文字で指定する必要があります。

バリューは，マルチバイト文字は使用できません。

○

−

指定なし

scraping:

スクレイピングを設定します。

−

−

−

schedule:

Azureからメトリクスを取得するスケジュール（毎分，毎時など）をAzureのCRON式で指定します。

＜設定例＞

スケジュールを毎分とする場合

0 * * ? * *

○

−

"0 * * ? * *"

Promitorの設定例，および，JP1/IM - Agentが提供するPrometheusとAzure Monitorの収集間隔のデフォルトは1分です。

metrics:

メトリクスを設定します。

−

−

−

-

name:

Prometheusで表示されるメトリクス名を1〜255文字の文字列で指定します。

正規表現[a-zA-Z_:][a-zA-Z0-9_:]*と一致する文字で指定する必要があります。

○

−

metricに応じて異なります。

description:

メトリクスの説明を，1〜255文字の制御文字以外の文字で指定します

○

−

metricに応じて異なります。

resourceType:

リソース種別を指定します。

指定できる値を次に示します。

• VirtualMachine

• FunctionApp

• ContainerInstance

• KubernetesService

• FileStorage

• BlobStorage

• ServiceBusNamespace

• CosmosDb

• SqlDatabase

• SqlManagedInstane

• SqlElasticPool

• LogicApp

○

−

metricに応じて異なります。

[labels:]

メトリクスに付与するラベルを設定します。

−

−

−

<key>: <value>

キーとバリューの値をそれぞれ1〜255文字の文字列で指定します。

キーは，正規表現[a-z _:][a-z0-9_:]*と一致する文字で指定する必要があります。

バリューは，マルチバイト文字は使用できません。

○

−

指定なし

[scraping:]

スクレイピングを設定します。

−

−

−

schedule:

Azureからメトリクスを取得するスケジュール（毎分，毎時など）をAzureのCRON式で指定します。

＜設定例＞

スケジュールを毎分とする場合

0 * * ? * *

○

−

指定なし

azureMetricConfiguration:

Azureのメトリクス定義を設定します。

−

−

−

metricName:

Azureでのメトリクス名を指定します。

指定できる値については，マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.15.1(1)(h)Promitor（Azure Monitor性能情報収集機能）」の「収集できるメトリック」を参照してください。

○

−

metricに応じて異なります。

[limit:]

ディメンションやフィルタを指定したときの最大のリソース数を指定します。

指定を省略した場合，metricDefault.limitの値が仮定されます。

○

−

指定なし

[dimension:]

マルチディメンションのメトリクスの場合に取得するディメンションを設定します。

−

−

−

name:

ディメンション名を指定します。

○

−

metricに応じて異なります。

aggregation:

集約を設定します。

−

−

−

type:

集約タイプを指定します。

○

−

metricに応じて異なります。

[interval:]

メトリクスの測定値を集計するインターバルの値を指定します。

○

−

指定なし

[resources:]

リソースを設定します。

リソースディスカバリを使用しないときに指定します。

−

−

−

-

<property>

リソース名などを指定します。指定方法はリソース種別に応じて異なります。

指定する値を次に示します。

• リソース種別がVirtualMachineの場合

  virtualMachineName

• リソース種別がFunctionAppの場合

  functionAppName, slotName（任意）

• リソース種別がContainerInstanceの場合

  containerGroup

• リソース種別がKubernetesServiceの場合

  clusterName

• リソース種別がFileStorageの場合

  accountName

• リソース種別がBlobStorageの場合

  accountName

• リソース種別がServiceBusNamespaceの場合

  namespace, queueName（任意）, topicName（任意）

• リソース種別がCosmosDbの場合

  dbName

• リソース種別がSqlDatabaseの場合

  serverName, databaseName

• リソース種別がSqlServerの場合

  serverName

• リソース種別がSqlManagedInstanceの場合

  instanceName

• リソース種別がSqlElasticPoolの場合

  serverName, poolName

• リソース種別がLogicAppの場合

  workflowName

○

−

metricに応じて異なります。

[resourceGroupName:]

リソースグループ名（デフォルトと異なるとき）を指定します。

○

−

指定なし

[subscriptionId:]

サブスクリプションID（デフォルトと異なるとき）を指定します。

○

−

指定なし

[resourceDiscoveryGroups:]

ディスカバリグループの設定をします。リソースディスカバリを使用するときに指定します。

−

−

−

-

name:

ディスカバリグループ名を指定します。

○

−

metricに応じて異なります。