Yet another cloudwatch exporter設定ファイル（jpc_ya_cloudwatch_exporter.yml）

形式

YAML形式で記述します。

discovery:
  exportedTagsOnMetrics:
    AWS/EC2:
      - jp1_pc_nodelabel
    AWS/Lambda:
      - jp1_pc_nodelabel
    AWS/S3:
      - jp1_pc_nodelabel
    AWS/DynamoDB:
      - jp1_pc_nodelabel
    AWS/States:
      - jp1_pc_nodelabel
    AWS/SQS:
      - jp1_pc_nodelabel
    AWS/ESC:
      - jp1_pc_nodelabel
    AWS/EBS:
      - jp1_pc_nodelabel
    AWS/EFS:
      - jp1_pc_nodelabel
    AWS/FSx:
      - jp1_pc_nodelabel
    AWS/SNS:
      - jp1_pc_nodelabel
    AWS/RDS:
      - jp1_pc_nodelabel
  jobs:
  - type: AWS/EC2
    regions:
      - ap-northeast-1
    period: 0
    length: 600
    delay: 120
    metrics:
      - name: CPUUtilization
        statistics:
        - Average
      - name: DiskReadBytes
        statistics:
        - Sum
      - name: DiskWriteBytes
        statistics:
        - Sum

ページの先頭へ

ファイル名

jpc_ya_cloudwatch_exporter.yml

jpc_ya_cloudwatch_exporter.yml.model（モデルファイル）

ページの先頭へ

格納先ディレクトリ

■統合エージェントホスト

Windowsの場合

• 物理ホストのとき

  Agentパス\conf\

• 論理ホストのとき

  共有フォルダ\jp1ima\conf\

Linuxの場合

• 物理ホストのとき

  /opt/jp1ima/conf/

• 論理ホストのとき

  共有ディレクトリ/jp1ima/conf/

■統合マネージャーホスト（モデルファイルだけ）

/opt/jp1pccspkg/jp1_pc_agent_cloud/jp1_pc_agent_cloud_linux_JP1/IM - Agentのバージョン番号（VVRRSS形式）/ya_cloudwatch_exporter/conf/

■監視エージェントホスト

• 物理ホストの場合

  監視エージェントのインストール先ディレクトリ/jp1pccs/conf/

• 論理ホストの場合

  共有ディレクトリ/jp1pccs/conf/

ページの先頭へ

説明

Yet another cloudwatch exporterの動作を規定する設定ファイルです。

ページの先頭へ

文字コード

UTF-8（BOM無し）

ページの先頭へ

改行コード

Windowsの場合：CR+LF

Linuxの場合：LF

ページの先頭へ

定義の反映時期

Yet another cloudwatch exporterを再起動したときに，Yet another cloudwatch exporterの動作に反映されます。

また，上記の操作を行ったあと，jddcreatetreeコマンドおよびjddupdatetreeコマンドを実行したときに，統合オペレーション・ビューアーのツリーの表示内容に反映されます。

ページの先頭へ

記述内容

• 最上位のパラメーター

  次の表に示すdiscoveryを記載します。

  項目名	説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
  discovery	Auto-discoveryを設定します。 詳細については，下記の<Auto-discovery configuration>を参照してください。	〇	<Auto-discovery configuration>を参照してください。	なし

（凡例）

〇：変更可

• <Auto-discovery configuration>

  項目名		説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
  <Auto-discovery configuration>		−	−	−	−
  	exportedTagsOnMetrics	すべてのメトリックにエクスポートするサービスごとのタグのリストを指定します。 jp1_pc_nodelabelタグは必ず指定してください。 ＜リストの例＞ exportedTagsOnMetrics: AWS/EC2: - jp1_pc_nodelabel - type 注意事項 タグ付けされたAWSリソースだけが検出されます。	〇	すべてのメトリックにエクスポートするサービスごとのタグのリスト	exportedTagsOnMetrics: AWS/EC2: - jp1_pc_nodelabel AWS/Lambda: - jp1_pc_nodelabel AWS/S3: - jp1_pc_nodelabel AWS/DynamoDB: - jp1_pc_nodelabel AWS/States: - jp1_pc_nodelabel AWS/SQS: - jp1_pc_nodelabel AWS/EBS: - jp1_pc_nodelabel AWS/ECS: - jp1_pc_nodelabel AWS/EFS: - jp1_pc_nodelabel AWS/FSx: - jp1_pc_nodelabel AWS/RDS: - jp1_pc_nodelabel AWS/SNS: - jp1_pc_nodelabel ECS/ContainerInsights: - jp1_pc_nodelabel
  	jobs	Auto-discovery jobのリストを設定します。 下記の<Auto-discovery job>を参照してください。	◎	<Auto-discovery job>を参照してください。	−

（凡例）

◎：設定必須　〇：変更可　−：該当なし

• <Auto-discovery job>

  項目名		説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
  <Auto-discovery job>		−	−	−	−
  	regions	AWSリージョンのリストを指定します。	◎	AWSリージョンのリスト	ap-northeast-1
  	type	名前空間名（"AWS / EC2"， "AWS / S3"など）を指定します。 指定できる名前空間（サービス）については，マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.15.6(1)(k)Yet another cloudwatch exporterのIM管理ノードの作成」の，JP1/IM - AgentのYet another cloudwatch exporterが監視対象としてサポートするAWSの名前空間について説明している個所を参照してください。	◎	名前空間名	AWS/EC2 AWS/Lambda AWS/S3 AWS/DynamoDB AWS/States AWS/SQS AWS/EBS AWS/ECS AWS/EFS AWS/FSx AWS/RDS AWS/SNS ECS/ContainerInsights
  	length	CloudWatchからデータを取得する期間を秒数で指定します。 取得開始時刻は「現在時刻−（length＋delay）」となります。	〇	データを要求するまでの時間（秒単位）	AWS/S3以外の設定 length: 600 AWS/S3の設定 length: 172800
  	delay	現在時刻に対して何秒前までのデータを要求するかを指定します。 取得終了時刻は「現在時刻−delay」となります。	〇	−	delay: 120
  	roles	引き受けるIAMロールを指定します。 ロールは2つまで記述できます。 ＜設定例＞ roles: - roleArn: "arn:aws:iam::1111111111111:role/cross_access_role" - roleArn: "arn:aws:iam::2222222222222:role/cross_access_role"	〇	引き受けるIAMロールのリスト	指定なし
  	searchTags	特定のタグを持つデータだけを収集する場合に，使用するキーと値のペアのリスト（すべて一致する必要があります）を指定します。 値は正規表現にできます。 なお，デフォルトで設定されているエントリーは削除しないでください。 ＜設定例＞ searchTags: - key: env value: production	〇	キーと値のペアのリスト	searchTags: - key: jp1_pc_nodelabel value: .*
  	period	CloudWatchから取得するデータの粒度を秒単位で指定します。	〇	秒単位の統計期間	0
  	customTags	キーと値のペアのリストとして追加するカスタムタグを指定します。 ＜設定例＞ customTags: - key: CustomTag value: CustomValue	〇	カスタムタグ	指定なし
  	metrics	メトリック定義のリストを設定します。 詳細については，下記の<metric definitions>を参照してください。	◎	メトリクス定義のリスト	メトリック定義ファイルの初期値で定義されているメトリックを設定します。 メトリック定義ファイルの初期値については，「Yet another cloudwatch exporterのメトリック定義ファイル（metrics_ya_cloudwatch_exporter.conf）」の「モデルファイルの設定内容（初期状態）」について説明している個所を参照してください。

（凡例）

◎：設定必須　〇：変更可　−：該当なし

• <metric definitions>

  項目名			説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
  <metric definitions>			−	−	−	−
  		name	CloudWatchメトリック名を指定します。	◎	CloudWatchメトリック名	なし
  		statistics	統計タイプをリスト形式で指定します。 「Minimum」，「Maximum」などを指定します。 ＜設定例＞ statistics: - Average	◎	統計タイプ	なし
  		period	CloudWatchから取得するデータの粒度を秒単位で指定します。 この定義はジョブレベル設定を上書きします。	〇	秒単位の統計期間	<Auto-discovery job>のperiodが0の場合 300 <Auto-discovery job>のperiodが0以外の場合 <Auto-discovery job>のperiodの設定値
  		nilToZero	CloudWatchから情報を取得できなかったときに0と扱う場合はTrueを指定します。 デフォルトはFalseです。	〇	有効にする場合はTrueを指定します。	指定なし

（凡例）

◎：設定必須　〇：変更可　−：該当なし

ページの先頭へ