共通事項

用語説明

本章のAPIで使用する用語を説明します。

用語	説明
監視項目	リソースに対する測定項目(性能情報や起動状態など)を表します。
アラーム	監視項目に対するしきい値監視の設定です。しきい値条件に対するアクションを設定することができます。
リソース	測定対象。本章ではインスタンス、ボリューム等を指します。
ソース	測定データの収集元を示す情報です。
集合体	特定のインスタンスを指定し、識別するために分類した測定対象群(単体でも指定可能)です。 アラームの対象に集合体を設定することで、複数のインスタンスを同じ条件で監視することができます。

アラーム設定に関する共通パラメータ

TargetType

アラーム作成時または更新時、アラーム設定対象のタイプ(target_type)と、タイプに応じたアラーム設定対象のオブジェクトID(object_id) を指定します。

アラーム設定対象のタイプ(target_type)の一覧を以下に示します。

target_type設定値	アラームの設定対象	object_idに設定する値
project	プロジェクト内の全仮想サーバ	プロジェクトID
aggregate	集合体(aggregate)内の仮想サーバ	集合体ID (Aggregate ID)
stack	スタックによって作成された仮想サーバ	スタックID
auto_scaling_group	スタックのオートスケールグループ内の仮想サーバ	OS::Heat::AutoScalingGroup タイプのリソースのID

スタックについては、機能説明書の オーケストレーション機能 のページを参照してください。

MetricType

アラームに設定する監視項目(metric_type)の値を以下に示します。

Threshold項目には、下記の表の「単位」に対応した値を設定してください(80%のcpu使用率を指定したい場合は"80"を指定します)。

metric_type設定値	単位	説明
instance.cpu.usage	%	CPU使用率
instance.memory.usage	%	メモリ使用率
instance.network.egress.bit_rate	Mbps	ネットワーク帯域（出力）
instance.network.egress.drops	drops/s	1秒間当たりにドロップした出力パケット数
instance.network.egress.errors	errors/s	1秒間当たりのパケットエラー数（出力）
instance.network.egress.packet_rate	packet/s	1秒間当たりの送信パケット数
instance.network.ingress.bit_rate	Mbps	ネットワーク帯域（入力）
instance.network.ingress.drops	drops/s	1秒間当たりにドロップした入力パケット数
instance.network.ingress.errors	errors/s	1秒間当たりのパケットエラー数（入力）
instance.network.ingress.packet_rate	packet/s	1秒間当たりの受信パケット数

Aggregation Function

アラームに設定する集計関数(aggregation_function)の値を以下に示します。

aggregation_function設定値	説明
avg	平均（各仮想サーバ毎に集計）
max	最大（各仮想サーバ毎に集計）
min	最小（各仮想サーバ毎に集計）
sum	合計（各仮想サーバ毎に集計）
grp_avg	アラーム設定対象のすべての仮想サーバの平均
grp_max	アラーム設定対象のすべての仮想サーバの最大
grp_min	アラーム設定対象のすべての仮想サーバの最小
grp_sum	アラーム設定対象のすべての仮想サーバの合計

📒注: grp_avg、grp_max、grp_min、grp_sumを指定した場合、アラーム設定対象のすべての仮想サーバの集計期間内の監視データを指定された集計関数で集計して1つの値を算出し、しきい値(Threshold)とを比較します。
avg、max、min、sumを指定した場合、仮想サーバごとに集計期間内のデータを指定された集計関数で集計し、しきい値(Threshold)と比較します。そのため、仮想サーバ単位でアラームが発報されます。