ウィジェットリファレンス

このページについて

このページは調べものをするためのページです。CloudWatchの各種類のウィジェットが各サイズでどのように描かれるか、そしてCloudPeekがダッシュボードのJSONのどの部分を使うかを正確に説明します。プリセットとAIウィジェットも同じJSONで書かれているため、これらにも当てはまります。ウィジェットの作成方法については、ウィジェットを作成するを参照してください。

ウィジェットの作成は、専用のページに移動しました：ウィジェットを作成する。

プリセットは、専用のページに移動しました：プリセット。

AIウィジェットは、専用のページに移動しました：AIウィジェット。

「ウィジェット」タブの説明は、ホーム画面とロック画面に移動しました。

更新とデータの鮮度の説明は、CloudPeekの仕組みに移動しました。

ウィジェットの種類

CloudWatchのメトリクスウィジェットのすべての表示形式と、テキストウィジェット、アラームステータスウィジェットは、iPhone、iPad、Androidのネイティブウィジェットになり、ダッシュボードの色、しきい値、軸の範囲で描かれます。

リストが収まらない場合

• 棒：残りの棒を合算することに意味がある場合（通貨、または同じメトリクスのカウントや合計）、最後の棒がそれらの合計を示す灰色のその他の棒になります。それ以外の場合は「+N件」と表示されます。表示される棒はゼロから最も離れたものですが、ウィジェットのレベルが下回るの場合は最も低いものになります（警告レベルとアラームレベルを参照）。
• 合計：ダッシュボードに合計がある場合（アカウント全体のEstimatedChargesの行やSUM(METRICS())式など）、棒グラフや円グラフのウィジェットには合計が表示されます。その行は独立した棒としては描かれません。複数の棒がある通貨のウィジェットでは、CloudPeekが自分で合計を計算します。
• 円グラフ：すべてのスライスが描かれます。凡例には収まるだけ表示され、その後に「+N件」と表示されます。合計がスライスの合算より大きい場合、その差は灰色のその他のスライスになります。
• 折れ線グラフと積み上げ面グラフの凡例には、中サイズのウィジェットでは最大4つ（文字サイズが大きい場合はそれより少なく）、大サイズでは4つの系列が、それぞれの最新の値とともに表示され、その後に「+N件」と表示されます。小サイズのウィジェットには凡例はありません。
• 表とアラームリストには収まるだけの行が表示され、その後に「+N件」と表示されます。期間ごとに1行を表示する表では、新しいものから表示され、その後に「以前のN件」と表示されます。

サイズ

どのウィジェットもすべてのサイズで使えます。CloudPeekでは、追加する前に各サイズをプレビューできます。Androidでは、ホーム画面ウィジェットのサイズを変更してサイズを選び、そのスペースに合ったレイアウトが表示されます。110 × 110 dpから小サイズ、250 × 110 dpから中サイズ、250 × 250 dpから大サイズです。横にアプリが4つ並ぶホーム画面では、それぞれ2 × 2、4 × 2、4 × 4セルです。

• 小サイズのウィジェットには、凡例とフッターがありません。アラームウィジェットでは、「1件がアラーム状態」のような見出しが先頭に表示されます。
• 中サイズ以上のウィジェットには、更新ボタン、凡例、そして「過去3時間 · 14:05に更新」のように時間範囲と更新時刻を示すフッターが加わります。アラームリストには、各アラームが変化してからの経過時間が表示されます。
• 大サイズのウィジェットでは、軸ラベルが増えます。iPadの特大サイズは、大サイズのレイアウトをより広いスペースで表示したものです。Androidでは、各レイアウトが与えられたスペースいっぱいに描かれます。
• 合計がある棒グラフのウィジェットでは、小サイズと中サイズで棒1本分の枠が合計に使われます。
• 収まる行数は文字サイズによって変わります。収まらない分は「+N件」として数えられます。
• iPhoneのスタンバイでは小サイズのウィジェットが黒い背景に大きく表示され、Macのデスクトップには、iPhoneの小サイズ、中サイズ、大サイズのウィジェットが表示されます（スタンバイとMacで表示するを参照）。

アラームリスト

アラームウィジェットには、アラームが次の順序で、それぞれの状態とともに表示されます：

• 同じ状態のアラームは、ウィジェットに記載された順序のままです。"sortBy": "stateUpdatedTimestamp"を指定すると、最近変化したものが先頭になります。
• 中サイズ以上のウィジェットには、各アラームの状態が変化してからの経過時間が表示されます。
• 小サイズのウィジェットとロック画面の見出しには、アラーム状態のアラームがある場合は赤でN件がアラーム状態、すべてOKの場合は緑ですべてOK、どのアラームにもまだ十分なデータがない場合はデータなし、それ以外の場合はN件が不明（データがないものと見つからないものの数）と表示されます。
• アラームサマリープリセットでは、代わりに「2件がアラーム状態、4件がデータ不足、14件がOK」のように各状態のアラームの数が表示されます（プリセットを参照）。
• すべてのアカウントを対象にしたアラームのプリセットでは、アカウントごとに1行が深刻な順に表示され、「prod：2件がアラーム状態」のように、最も深刻な状態の記号が付きます。アラームプリセットでは、OKでないアカウントのアラームがその行の下に一覧表示されます。すべてのアカウントのアラームを参照してください。

ロック画面

iPhoneとiPadのロック画面ウィジェットには代表値が1つ表示されるので、ロックを解除せずに確認できます。Androidスマートフォンにはロック画面ウィジェットはありません。

• 長方形：タイトル、値、その値の系列または棒（データが古い場合は警告）。
• 円形：値と、タイトルから取った約8文字のキャプション。
• 時計の上のインライン：値とタイトル。タイトルは約18文字で、単語の途中で切れないように短縮されます。
• レベル：ロック画面は単色で描かれるため、ウィジェットの警告レベルまたはアラームレベルを超えた値には、そのレベルの記号が横に付きます（警告レベルとアラームレベルを参照）。

概要ウィジェット

概要ウィジェットは、2〜4個のウィジェットをそれぞれの最新の値で表示します（1つのウィジェットに複数の値を参照）。小サイズでは2個、中サイズ以上では4個、iPhoneとiPadのロック画面では最初の1個が表示されます。

• 値は、上の表にある各ウィジェットのロック画面の代表値です。アラームウィジェット（アラームサマリープリセットも含む）では、赤い三角形付きの赤い「1件がアラーム状態」、緑のチェックマーク付きの緑の「すべてOK」、アラームがない場合は「アラームなし」のように見出しが表示されます。すべてのアカウントを対象にしたアラームウィジェットでは、代わりに確認が必要なアカウントのうち最も深刻なものの行が「prod：2件がアラーム状態」や「dev：サインインして更新」のように表示されるため、読み取れなかったアカウントがほかのアカウントの「すべてOK」に隠れることはありません。
• レベル：ウィジェット自体と同様に、ウィジェットの警告レベルを超えた値は丸囲みの「!」付きの黄色で、アラームレベルを超えた値は三角形付きの赤で表示されます（警告レベルとアラームレベルを参照）。判定の対象は表示される値です。棒の合計は判定の対象ではないため、いずれかの棒が超えたレベルのうち最も深刻なものが適用されます。
• 推移は、「+12%」のような矢印とパーセンテージで、前のデータポイントからの値の変化を示します。推移を表示する数値ウィジェット、ゲージ、折れ線グラフ、積み上げ面グラフに表示されます。棒グラフ、円グラフ、表、アラーム、縦棒で描かれるグラフには表示されません。縦棒は通常、今日のこれまでの支出のように、まだ進行中の期間を表すためです。
• テキストウィジェットには値がないため、概要ウィジェットの選択肢には表示されません。
• 更新できなかったウィジェットは最後の値を表示したまま、推移の代わりにオレンジ色でその理由を表示します：「サインインして更新」、「アカウント未追加」、「14:05以降更新なし」など。表示し続ける値がない場合は、「アクセス拒否」、「AWSに接続できません」などと表示されます。1日以上前のデータは薄く表示されます。

CloudPeekが使うダッシュボード設定

CloudPeekはダッシュボードのJSONを読み取り、CloudWatchコンソールと同じ方法でクエリを実行します。プリセットとAIウィジェットも同じJSONで書かれているため、以下の内容はすべてこれらにも当てはまります。

対応している設定

• メトリクス："."と"..."の省略記法を使ったメトリクスの行。メトリクス数式、SEARCH、Metrics Insights（SELECT … FROM SCHEMA(…)）の式。描画しない入力用の"visible": false。
• メトリクスごと：id、label（${PROP('Dim.ServiceName')}や${LAST}などの動的ラベルを含む）、color、stat、period、region、accountId、yAxis。
• ウィジェットごと：title、view、stacked、stat（未設定の場合はAverage）、period、region、accountId、start、end、setPeriodToTimeRange、sparkline、trend、Y軸（左右とも）のminとmax、水平のannotations（値、色、軸、visible）、"legend": {"position": "hidden"}。
• 右Y軸："yAxis": "right"を指定したメトリクスは独自のスケールで描かれ、右側にラベルが付きます。
• ダッシュボードごと：start、end、periodOverride。
• アラームウィジェット：alarms、sortBy。

使われない設定

• 注釈のラベルとY軸のラベル（線と範囲は描かれますが、テキストは表示されません）、注釈の帯（最初の端だけが描かれます）、垂直注釈。
• hidden以外の凡例の位置、liveData、singleValueFullPrecision、表のサマリーオプション。
• ダッシュボード変数：ウィジェットでは、ダッシュボードに保存されている値が使われます。

時間範囲と期間

• 時間範囲：ウィジェットにstartがあればそれを使い、なければダッシュボードの設定、それもなければ過去3時間を使います。-PT3Hや-P7Dのような相対範囲と、絶対タイムスタンプのどちらも使えます。すべてのウィジェットに、「過去3時間」のように対象の時間範囲が表示されます。
• 期間：メトリクスのperiod、なければウィジェットの設定、それもなければ5分を使います。コンソールと同様に、範囲に必要なデータポイントが多すぎる場合（300個超、"periodOverride": "inherit"の場合は1,440個超）、CloudPeekは期間を1分、5分、15分、1時間、3時間、6時間、1日、1週間、30日の順に大きくします。
• CloudWatchでは古いデータほど解像度が粗くなるため、15日より前から始まる範囲では5分以上の期間、63日より前から始まる範囲では1時間以上の期間が使われます。
• setPeriodToTimeRangeを指定すると、コンソールと同様に、数値、ゲージ、棒グラフ、円グラフ、表のウィジェットで範囲全体を1つの期間として扱います。

値の表示方法

• 数値は有効数字3桁で表示され、千、百万、十億、兆にはK、M、B、Tが付きます（1.23K、45.6M）。3桁に丸めると誤解を招くほど切りのよい数になる値は桁数を増やして表示されるため、99.96が100と表示されることはありません。CloudWatchの単位は表示されないため、「レイテンシー（秒）」のように単位をラベルに含めてください。
• 通貨：ウィジェットのすべてのメトリクスが同じ通貨のAWS/Billing EstimatedChargesである場合、値は金額として表示されます。100未満はセント単位まで、10,000までは整数、それ以上は$12.3Kのような短縮形で表示されます。Currencyを指定しないAWS/BillingのSEARCHは、米ドルで表示されます。AWSが料金を発行する通貨は米ドルだけです。
• 請求ウィジェットのサービス名は短縮されます。AmazonEC2はEC2に、AWSLambdaはLambdaになります。
• ラベル：ラベルのないメトリクスには、メトリクス名か、ウィジェット上のほかのメトリクスと区別できるディメンションの値が名前として付きます。
• 数値の推移は、最新のデータポイントをその前のデータポイントと比較したものです。
• 色：各メトリクスのcolorが使われ、指定がなければCloudWatchのデフォルトのパレットが使われます。
• 警告レベルとアラームレベル：数値、ゲージ、棒グラフ、グラフの最新の値が、CloudPeekで設定したレベルを超えると、記号付きの黄色または赤で表示されます（警告レベルとアラームレベルを参照）。CloudPeekはレベルを"cloudPeekLevel"の印が付いた水平注釈としてウィジェットに書き込み、グラフではそれが破線として描かれます。ダッシュボード独自の注釈も線として描かれますが、値の色が変わることはありません。

アカウント、リージョン、上限

• リージョン：各メトリクスは、そのメトリクスのregion、なければウィジェットの設定、それもなければCloudPeekでのアカウントのデフォルトリージョンを使います。1つのウィジェットで複数のリージョンを混在させることができ、CloudPeekは各リージョンに並行してクエリを実行します。
• アカウント：各ウィジェットは、作成対象のアカウントで更新されます。1つのウィジェットに別のアカウントのメトリクスを表示するには、CloudWatchクロスアカウントオブザーバビリティを設定してメトリクスにaccountIdを指定するか、そのアカウントをCloudPeekに追加して、そのアカウント用のウィジェットを作成します。
• アラームは、ウィジェットの作成対象のアカウントで、各ARNのリージョンから検索されます。アラームのプリセットは、追加したリージョンで最大1,000件のアラームを読み取ります（表示でテキストを選んだ場合は、名前がそのテキストで始まるものだけ）。それを超える場合は、ALARM状態のものが優先して残されます。
• サイズ：1つのウィジェットは、リージョンごとに一度に最大500件のメトリクスをリクエストでき、線1本あたり最大400個のデータポイントを保持します。グラフに描かれる系列は最大30個です。折れ線グラフでは値の大きい30個が表示され、積み上げグラフでは残りが「その他」にまとめられます。

テキストウィジェット

テキストウィジェットは、グラフの横にランブックのメモを置くのに便利です。CloudPeekでは次のものが表示されます：

• 太字、斜体、code、リンク。
• 見出し（太字の行として表示）。
• 箇条書きリスト（*、-、+）。行頭記号付きで表示。
• CloudWatchのボタン（[button:Label](https://…)）。通常のリンクとして表示。

水平線は省略され、連続する空行は詰められます。表、画像、コードブロックは、コンソールのダッシュボードだけで使うことをおすすめします。タイトルのないテキストウィジェットには、最初の行が名前として付きます。