GetMetricWidgetImage: メトリクスウィジェットの構造と構文

全体的な構造メトリクスの配列内の各メトリクスの形式注釈プロパティの形式 yAxis プロパティ形式

MetricWidget は https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricWidgetImage.html API の入力パラメータです。これは JSON 形式の文字列です。

内容

全体的な構造
メトリクスの配列内の各メトリクスの形式
注釈プロパティの形式
yAxis プロパティ形式

MetricWidget 文字列には次のパラメータを含めることができます。

metrics

グラフに含めるメトリクスを metrics 配列として指定します。これには、raw メトリクス式とメトリクス数式の両方を含めることができます。1 つの metrics 配列には、1～100 個のメトリクスと式を含めることができます。metrics の形式の詳細については、「メトリクスの配列内の各メトリクスの形式」を参照してください。

タイプ: 配列の配列

必須: はい。

annotations

注釈配列としてグラフに追加する水平および垂直注釈。この形式の詳細については、注釈プロパティの形式を参照してください。

必須: いいえ

end

グラフに表示されるメトリクスの終了日時。これは、2018-04-25T12:00:00.000Z などの絶対値、または -PID などの相対値として表現できます。

end を指定しない場合、デフォルトの -PT0H (現在の時刻) が使用されます。

タイプ: 文字列

必須: いいえ

height

ピクセルでのウィジェットの高さ。デフォルトは 400 です。

有効な値: 1～2000

タイプ: 整数

必須: いいえ。ただし、width の値も設定する場合は、これを設定する必要があります。

legend

グラフ凡例の場所と可視性を指定します。legend には 1 つのフィールド position が含まれます。position の値は、bottom、right、または hidden のいずれかです。デフォルトは bottom です。

タイプ: 文字列

必須: いいえ

liveData

ウィジェットにライブデータを表示するには、true を指定します。ライブデータとは、直近の 1 分以内に公開された、完全には集計されていないデータです。詳細については、「ライブデータの使用」を参照してください。

タイプ: ブール値

必須: いいえ

期間

このウィジェットのすべてのメトリクスのデフォルトの期間 (秒単位)。このデフォルトは、各メトリクス定義内で上書きできます。デフォルトは 300 です。

有効な値: 1、5、10、30、60、および 60 の倍数。1、5、10、30 は高解像度メトリクス専用です。

タイプ: 整数

必須: いいえ

リージョン

このパラメータはオプションです。含める場合は、ローカルリージョンを指定する必要があります。

タイプ: 文字列

必須: いいえ

積み上げ

グラフを積み上げ線として表示するには true を指定し、別の線として表示するには false を指定します。デフォルトは False です。

タイプ: ブール値

必須: いいえ

開始

グラフに表示されるメトリクスの開始日時。これは、2018-04-25T12:00:00.000Z などの絶対値、または -PID などの相対値として表現できます。

start を指定しない場合、デフォルト値の -PT3H (3 時間前) が使用されます。

タイプ: 文字列

必須: いいえ

統計

配列内の各メトリクスに表示されるデフォルトの統計。このデフォルトは、metrics 配列内の個々のメトリクスの定義内で上書きできます。

これを省略した場合、デフォルトの Average が使用されます。

有効な値: SampleCount | Average | Sum | Minimum | Maximum | p?? | TM(??:??) | TC(??:??) | TS(??:??) | WM(??:??) | PR(??:??) | IQM

タイプ: 有効な CloudWatch 統計である文字列。

必須: いいえ

theme

グラフのスタイル設定に使用されるカラーパレット。デフォルトは light です。

有効な値：light | dark

タイプ: 文字列

必須: いいえ

timezone

グラフに時間を表示するために使用するタイムゾーン。形式は + または - で、その後に 4 桁が続きます。最初の 2 桁は UTC の前後の時間数を示し、最後の 2 桁は分数です。たとえば、+0130 は UTC の 1 時間 30 分前の時間を示します。デフォルトは +0000 です。

タイプ: 文字列

必須: いいえ

title

グラフに表示されるタイトル。

タイプ: 文字列

必須: いいえ

表示

表示形式。このメトリクスを折れ線グラフとして表示するには、timeSeries を指定します。このメトリクスを棒グラフとして表示するには、bar を指定します。このメトリクスを円グラフとして表示するには、pie を指定します。デフォルトは timeSeries です。

有効な値：timeSeries | bar | pie

タイプ: 文字列

必須: いいえ

width

ウィジェットの幅 (ピクセル単位) デフォルトは 600 です。

有効な値: 1～2000

タイプ: 整数

必須: いいえ。ただし、width の値も設定する場合は、これを設定する必要があります。

yAxis

y 軸の最小値と最大値の制限。これは、特定のメトリクスが上書きされない限り、グラフ化されるすべてのメトリクスに適用されます。この形式の詳細については、yAxis プロパティ形式を参照してください。

タイプ: YAxis オブジェクト

必須: いいえ

metrics 配列内の各項目は、グラフに表示する、またはグラフに表示される数式の一部として使用する CloudWatch メトリクスです。数式の詳細については、「Amazon CloudWatch ユーザーガイド」の「数式の使用」を参照してください。

配列内のメトリクスのそれぞれの形式は以下のとおりです。


[Namespace, MetricName, Dimension1Name, Dimension1Value, Dimension2Name, Dimension2Value... 
            {Options Object}]

Namespace

メトリクスを含む AWS 名前空間。配列において前のメトリクスと同じ名前空間を使用するために、最初のメトリクスの後の各エントリに "." を指定することができます。

タイプ: 文字列

必須: はい

MetricName

CloudWatch メトリクスの名前。配列において前のメトリクスと同じ名前を使用するために、最初のメトリクスの後の各エントリに "." を指定することができます。

タイプ: 文字列

必須: はい

DimensionName

表示されるデータをさらに絞り込むディメンションの名前。配列において前のメトリクスと同じディメンション名を使用するために、最初のメトリクスの後の各エントリに "." を指定することができます。メトリクスにゼロのディメンションを指定することも、メトリクスがサポートする最大数のディメンションを指定することもできます。

タイプ: 文字列

必須: いいえ

DimensionValue

メトリクスディメンションで使用する値。対応するディメンション名がある場合に必須です。

タイプ: 文字列

必須: いいえ。対応するディメンション名がある場合を除きます。

OPTIONS オブジェクト

指定された CloudWatch メトリクスに使用するカスタムレンダリングプロパティ、またはグラフに表示する数式を指定します。この形式の詳細については、オプションオブジェクト形式を参照してください。

タイプ: オプションオブジェクト

必須: いいえ

例


// The simplest example, a metric with no dimensions
        [ "AWS/EC2", "CPUUtilization" ]
        
 // A metric with a single dimension
        [ "AWS/EC2", "CPUUtilization", "InstanceId", "i-01234567890123456" ]
        
 // A metric with a single dimension and rendering properties
        [ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-01234567890123456", { yAxis: "right"} ]
       
 // The following example graphs the DiskReadBytes metric for three instances.
        [ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-01234567890123456" ],
        [ ".", ".", ".", "i-abc" ],
        [ ".", ".", ".", "i-123" ]

指定された CloudWatch メトリクスに使用するカスタムレンダリングプロパティ、またはグラフに表示する数式を指定します。

このオブジェクトが metrics 配列の CloudWatch メトリクスの一部として指定されている場合、このメトリクスのカスタムレンダリングプロパティを設定し、グラフ全体に使用されるデフォルトを上書きします。

このオブジェクトを指定して、グラフに数式を追加することもできます。この場合、このオブジェクトの他の設定は、数式の結果の表示オプションを指定します。

このセクションでは、これらのオプションオブジェクトの形式について説明します。

color

このメトリクスまたは式に使用する 6 桁の HTML 16 進数カラーコード。

タイプ: 文字列

必須: いいえ

expression

表示する数式。サポートされる数式の関数と形式の詳細については、「Amazon CloudWatch ユーザーガイド」の「Metric Math 構文と関数」を参照してください。

タイプ: 有効な CloudWatch メトリクス数式である文字列。

必須: 式の場合は、はい。

ラベル

グラフの凡例でこのメトリクスまたは式に表示するラベル。これを指定しない場合、メトリクスには、ウィジェット内の他のメトリクスと区別する自動生成されたラベルが付けられます。

タイプ: 文字列

必須: いいえ

id

このメトリクスまたは式の識別子。このウィジェット内で一意である必要があります。ID は、数式内でこのメトリクスまたは式を表す変数として使用できます。使用できるのは、文字、数字、アンダースコアのみです。1 字目は小文字である必要があります。

タイプ: 文字列

必須: いいえ

期間

このメトリクスの期間 (秒単位)。指定すると、このグラフの他のメトリクスに使用されるデフォルトの期間が上書きされます。このパラメータは数式には適用されません。

有効な値: 1、5、10、30、60、および 60 の倍数。1、5、10、30 は高解像度メトリクス専用です。

タイプ: 整数

必須: いいえ

統計

グラフ内の他のメトリクスに使用される統計と異なる場合の、このメトリクスに表示される統計。このパラメータは数式には適用されません。

タイプ: 有効な CloudWatch 統計である文字列。

必須: いいえ

visible

このメトリクスまたは式をグラフに表示するかどうかを指定します。デフォルトは true です。

visible を false に設定すると、数式で使用される raw メトリクスを非表示にし、グラフに式の結果のみを表示する場合に便利です。

タイプ: ブール値

必須: いいえ

yAxis

このメトリクスまたは式の y 軸を表示するグラフ上の場所。デフォルトは left です。

有効な値: left | right

タイプ: 文字列

必須: いいえ

例

次の例では、CloudWatch はカスタム apiLatency メトリクスを取得します。上部には、中央値を示す p50 統計が指定されています。次に、同じインスタンス上の同じメトリクス (ピリオドのみの 4 つのフィールドで指定) について、平均値がグラフ化されます。次に、2 つのメトリクスの中間値を示す数式を持つオプションオブジェクトを示します。最後に、別の式が変更率を示します。

グラフに 2 つの式の結果のみを表示し、raw メトリクスを非表示にするには、visible の最初の 2 つのインスタンスを false に変更します。


{
        "metrics": [
            [
                "MyNamespace", 
                "apiLatency", 
                "InstanceId", 
                "i-0987654321abcdef0", 
                {
                    "id": "m1",
                    "stat": "p50",
                    "label": "Median value",
                    "visible": true,
                    "color": "#dddddd",
                    "yAxis": "left",
                    "period": 300
                }
            ],
            [
                ".", 
                ".", 
                ".", 
                ".", 
                {
                    "id": "m2",
                    "stat": "Average",
                    "label": "Average value",
                    "visible": true,
                    "color": "#cccccc",
                    "yAxis": "left",
                    "period": 300
                }
            ],
            [
                {
                    "expression": "(m1+m2)/2",
                    "id": "e1",
                    "label": "Half way between average and median",
                    "visible": true,
                    "color": "#000000",
                    "yAxis": "left"
                }
            ],
            [
                {
                    "expression": "RATE(e1)",
                    "yAxis": "right",
                    "label": "rate of change of the half way point"
                }
            ]
        ]
    }

1 つのグラフに複数の水平注釈と垂直注釈を付けることができます。すべての水平注釈は 1 つの horizontal フィールドで指定され、すべての垂直注釈は 1 つの vertical フィールドで指定されます。

水平

水平注釈の配列。水平注釈には、注釈行の上のシェーディング、注釈行の下のシェーディング、1 つの注釈の一部として 2 つのリンクされた注釈行の間に表示される「バンド」シェーディングなど、フィルシェーディングのオプションがいくつかあります。バンドシェーディングを持たない配列内の各水平注釈は、次の形式になります。


{value, label, color, fill, yAxis, visible}

バンドシェーディングを持つ各水平注釈は、次の形式になります。


[{value, label, color, yAxis, visible}, {value, label}]

垂直

垂直注釈の配列。垂直注釈には、注釈行の前のシェーディング、注釈行の後のシェーディング、1 つのバンド注釈の一部として 2 つのリンクされた注釈行の間に表示される「バンド」シェーディングなど、フィルシェーディングのオプションがいくつかあります。バンドシェーディングを持たない配列内の各垂直注釈は、次の形式になります。


{value, label, color, fill, visible}

バンドシェーディングを持つ各垂直注釈は、次の形式になります。


[{value, label, color, visible}, {value, label}]

horizontal 配列には、次のフィールドが含まれます。

値

水平注釈行が表示されるグラフのメトリクス値。バンドシェーディング注釈では、Value の 2 つの値がバンドの上下のエッジを定義します。

水平注釈付きのグラフでは、表示されるすべての水平注釈がグラフに表示されるようにスケールされます。

タイプ: 浮動小数点

必須: はい。水平注釈が使用されている場合。

ラベル

注釈の横にあるグラフに表示される文字列。

タイプ: 文字列

必須: いいえ

color

注釈に使用する 6 桁の HTML 16 進数カラーコード。この色は、注釈行とフィルシェーディングの両方に使用されます。

タイプ: 文字列

必須: いいえ

fill

注釈でフィルシェーディングを使用する方法。有効な値は、注釈の上のシェーディングの場合は above、注釈の下のシェーディングの場合は below、シェーディングなしの場合は none です。fill を省略した場合、シェーディングはありません。

例外は、バンドシェーディングを使用した注釈です。これらの注釈は常に 2 つの値の間にシェーディングがあり、fill の任意の値は無視されます。

タイプ: 文字列

必須: いいえ

visible

これを true に設定すると注釈がグラフに表示され、false に設定するとグラフが非表示になります。デフォルトは true です。

タイプ: ブール値

必須: いいえ

yAxis

グラフに複数のメトリクスが含まれる場合、Value の数値が左の Y 軸または右の Y 軸のどちらに関連するメトリクスを指すかを指定します。有効な値は、right および left です。

タイプ: 文字列

必須: いいえ

vertical 配列には、次のフィールドが含まれます。

値

垂直注釈行が表示される場所のタイムスタンプ。これは、2018-08-28T15:25:26Z などの絶対タイムスタンプとして指定する必要があります。バンドシェーディング注釈では、Value の 2 つの値がバンドの開始エッジと終了エッジを定義します。

タイプ: 文字列

必須: はい。垂直注釈が使用されている場合。

ラベル

注釈の横にあるグラフに表示されるわかりやすい文字列。

タイプ: 文字列

必須: いいえ

color

注釈に使用する 6 桁の HTML 16 進数カラーコード。この色は、注釈行とフィルシェーディングの両方に使用されます。

タイプ: 文字列

必須: いいえ

fill

注釈でフィルシェーディングを使用する方法。有効な値は、注釈の前のシェーディングの場合は before、注釈の後のシェーディングの場合は after、シェーディングなしの場合は none です。fill を省略した場合、シェーディングはありません。

例外は、バンドシェーディングを使用した注釈です。これらの注釈は常に 2 つの値の間にシェーディングがあり、fill の任意の値は無視されます。

タイプ: 文字列

必須: いいえ

visible

これを true に設定すると注釈がグラフに表示され、false に設定するとグラフが非表示になります。デフォルトは true です。

タイプ: ブール値

必須: いいえ

例


// A single horizontal annotation with fill shading above the annotation line, based on the metric associated with the right Y-axis
                    
"annotations": {
     "horizontal": [
         {
              "visible":true,
              "color":"#9467bd",
              "label":"Critical range",
              "value":20,
              "fill":"above",
              "yAxis":"right"
         }
    ]
}

// A horizontal band annotation. Each value has a label, but other parameters for the band need to be specified only with the first number

"annotations": {
    "horizontal": [
        [
             {
                  "label":"Band top",
                  "value":200,
                  "color":"#9467bd",
                  "visible":true,
                  "yAxis":"right"
              },
              {
                  "value":95.5,
                  "label":"Band bottom"
              }
         ]
     ]
}

// A single vertical annotation with fill shading after the annotation line

"annotations": {
    "vertical": [
        {
            "visible": true,
            "color": "#9467bd",
            "label": "Bug fix deployed",
            "value": "2018-08-28T15:25:26Z",
            "fill": "after"
        }
    ]
}	


// A vertical band annotation. Each annotation line has a label, but other parameters for the band are specified only with the first value

"annotations": {
    "vertical": [
        [
            {
                "label": "Band start",
                "value": "2018-08-27T15:25:26Z",
                "color": "#9467bd",
                "visible": true
            },
            {
                "value": "2018-08-28T15:25:26Z",
                "label": "Band end"
            }
        ]
    ]
}

グラフの Y 軸の最小値と最大値を定義します。MetricWidget オブジェクト内でこれを設定すると、ウィジェット内のすべてのメトリクスに影響します。特定のメトリクスのウィジェット設定を上書きするには、metrics 配列内のそのメトリクスのオプションオブジェクトで設定します。

側の

左の Y 軸のオプションの min および max 設定。

タイプ: YAxis オブジェクト

必須: いいえ

右

右の Y 軸のオプションの min および max 設定。

タイプ: YAxis オブジェクト

必須: いいえ

left および right オブジェクトのそれぞれに次のパラメータを含めることができます。

min

この Y 軸の最小値。

タイプ: 浮動小数点

必須: いいえ

max

この Y 軸の最大値。

タイプ: 浮動小数点

必須: いいえ

例


{
  left: {
    min: 0,
    max: 100
  },
  right: {
    min: 0
  }
}

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

グラフのメトリクスからアラームを作成する

異常検出の使用