第7章 alarm


この章では、alarm コマンドに含まれるコマンドを説明します。

7.1. alarm create

アラームの作成

使用方法

openstack alarm create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] --name <NAME> -t <TYPE>
                              [--project-id <PROJECT_ID>]
                              [--user-id <USER_ID>]
                              [--description <DESCRIPTION>] [--state <STATE>]
                              [--severity <SEVERITY>] [--enabled {True|False}]
                              [--alarm-action <Webhook URL>]
                              [--ok-action <Webhook URL>]
                              [--insufficient-data-action <Webhook URL>]
                              [--time-constraint <Time Constraint>]
                              [--repeat-actions {True|False}]
                              [--query <QUERY>]
                              [--comparison-operator <OPERATOR>]
                              [--evaluation-periods <EVAL_PERIODS>]
                              [--threshold <THRESHOLD>]
                              [--event-type <EVENT_TYPE>] [-m <METER NAME>]
                              [--period <PERIOD>] [--statistic <STATISTIC>]
                              [--granularity <GRANULARITY>]
                              [--aggregation-method <AGGR_METHOD>]
                              [--metric <METRIC>]
                              [--resource-type <RESOURCE_TYPE>]
                              [--resource-id <RESOURCE_ID>]
                              [--composite-rule <COMPOSITE_RULE>]
                              [--stack-id <STACK_NAME_OR_ID>]
                              [--pool-id <LOADBALANCER_POOL_NAME_OR_ID>]
                              [--autoscaling-group-id <AUTOSCALING_GROUP_NAME_OR_ID>]

表7.1 コマンド引数
概要

-h、--help

help メッセージを表示して終了します

--name <NAME>

アラームの名前

-t <TYPE>, --type <TYPE>

アラームのタイプは、event、composite、threshold、gnocchi_resources_threshold、gnocchi_aggregation_by_metrics_threshold、gnocchi_aggregation_by_resources_threshold、loadbalancer_member_health のいずれかになります。

--project-id <PROJECT_ID>

アラームに関連付けるプロジェクト (管理ユーザーだけが設定可能)

--user-id <USER_ID>

アラームに関連付けるユーザー (管理ユーザーだけが設定可能)

--description <DESCRIPTION>

アラームのフリーテキストの説明

--state <STATE>

アラームの状態。以下のいずれか:[ok, alarm, insufficient data]

--severity <SEVERITY>

アラームの重大度。以下のいずれか [low, moderate,critical]

--enabled {True|False}

アラーム評価が有効な場合は true。

--alarm-action <Webhook URL>

状態が alarm に切り替わったときに呼び出す URL。複数回使用できます。

--ok-action <Webhook URL>

状態が ok に切り替わったときに呼び出す URL。複数回使用できます。

--insufficient-data-action <Webhook URL>

状態が insufficient data に切り替わったときに呼び出す URL。複数回の使用が可能です。

--time-constraint <Time Constraint>

評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]] です。

--repeat-actions {True|False}

アラームがターゲット状態にある時にアクションを繰り返し通知する場合は True

表7.2 出力フォーマット設定オプション
概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

表7.3 JSON フォーマット設定オプション
概要

--noindent

JSON のインデントを無効にするかどうか。

表7.4 シェルフォーマット設定オプション
概要

--prefix PREFIX

すべての変数名に接頭辞を追加します。

表7.5 テーブルフォーマット設定オプション
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

表7.6 common alarm rules
概要

--query <QUERY>

タイプが threshold または event のアラームの場合、key[op]data_type::value; list. data_type はオプションですが、指定する場合は文字列、整数、浮動小数点またはブール値にする必要があります。gnocchi_aggregation_by_resources_threshold タイプのアラーム: {"and": [{"=": {"ended_at": null}}, …​]} のように、複雑なクエリー json 文字列を指定する必要があります。

--comparison-operator <OPERATOR>

比較するオペレーター:[lt,le,eq,ne,ge,gt] のいずれか。

--evaluation-periods <EVAL_PERIODS>

評価する期間の数

--threshold <THRESHOLD>

評価するしきい値。

表7.7 event alarm
概要

--event-type <EVENT_TYPE>

評価対象のイベントタイプ

表7.8 しきい値アラーム
概要

-m <METER NAME>, --meter-name <METER NAME>

評価対象の Meter

--period <PERIOD>

評価する各期間の長さ (秒単位)。

--statistic <STATISTIC>

評価する統計で、[maxminavgsumcount] のいずれかになります

表7.9 common gnocchi alarm rules
概要

--granularity <GRANULARITY>

クエリーを行う時間範囲 (秒単位)。

--aggregation-method <AGGR_METHOD>

しきい値と比較する aggregation_method

--metric <METRIC>, --metrics <METRIC>

アラームタイプに応じたメトリック ID または名前

表7.10 gnocchi resource threshold alarm
概要

--resource-type <RESOURCE_TYPE>

リソースのタイプ。

--resource-id <RESOURCE_ID>

リソースの ID。

表7.11 composite alarm
概要

--composite-rule <COMPOSITE_RULE>

JSON 形式の複合しきい値ルール。形式として、"and" や "or" で threshold/gnocchi ルールを組み合わせた、ネスト化ディクショナリーを指定できます。たとえば、形式は {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]} のようになります。RULEx は基本的な threshold ルールにすることができますが、{"threshold": 0.8,"meter_name":"cpu_util","type":"threshold"} のように "type" フィールドを含む必要があります。

表7.12 loadbalancer member health alarm
概要

--stack-id <STACK_NAME_OR_ID>

ロードバランサープールおよびメンバーが含まれる、ルート/トップレベル heat スタックの名前または ID。ロードバランサープールに正常でないメンバーが検出されると、ルート Stack に対して更新がトリガーされます。

--pool-id <LOADBALANCER_POOL_NAME_OR_ID>

各メンバーの正常性が評価されるロードバランサープールの名前または ID。

--autoscaling-group-id <AUTOSCALING_GROUP_NAME_OR_ID>

ロードバランサーメンバーが含まれる heat 自動スケーリンググループの ID。ルートスタックで更新がトリガーされる前に、正常ではないメンバーにはその旨マークが付けられます。

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

© 2024 Red Hat, Inc.