GetMetricWidgetImage: Struktur und Syntax des metrischen Widgets

Gesamtstruktur Format für jede Metrik in der Reihe von Metriken Format der Eigenschaften von Anmerkungen Format der Y-Achsen-Eigenschaften

MetricWidgetist ein Eingabeparameter für die https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricWidgetImage.html API. Es ist eine Zeichenfolge im JSON-Format.

Inhalt

Gesamtstruktur
Format für jede Metrik in der Reihe von Metriken
Format der Eigenschaften von Anmerkungen
Format der Y-Achsen-Eigenschaften

Die MetricWidget Zeichenfolge kann die folgenden Parameter enthalten:

Metriken

Die Metriken, die in das Diagramm aufgenommen werden sollen, als metrics Array. Dies kann sowohl rohe metrische als auch metrische mathematische Ausdrücke beinhalten. Ein metrics Array kann 1—100 Metriken und Ausdrücke enthalten. Weitere Informationen zum Format von finden Sie metrics unterFormat für jede Metrik in der Reihe von Metriken.

Typ: Array von Arrays

Erforderlich: ja.

Anmerkungen

Die horizontalen und vertikalen Anmerkungen, die dem Diagramm als Annotationsarrays hinzugefügt werden sollen. Weitere Informationen zum Format finden Sie unter. Format der Eigenschaften von Anmerkungen

Erforderlich: Nein

end

Das Datum und die Uhrzeit für das Ende der in der Grafik angezeigten Metriken. Dies kann entweder als absoluter Wert wie 25.04.2018 T12:00:00.000Z oder als relativer Wert wie -PID ausgedrückt werden.

Wenn Sie nichts angebenend, wird der Standardwert -PT0H (die aktuelle Uhrzeit) verwendet.

Typ: Zeichenfolge

Erforderlich: Nein

height

Die Höhe des Widgets in Pixeln. Der Standardwert ist 400.

Gültige Werte: 1—2000

Typ: Ganzzahl

Erforderlich: Nein, aber Sie sollten dies festlegen, wenn Sie auch einen Wert für width festlegen.

Legende

Gibt die Position und Sichtbarkeit der Diagrammlegende an. legendenthält ein Feld,position. Folgende Werte von position sind möglich: bottom, right oder hidden. Der Standardwert ist bottom.

Typ: Zeichenfolge

Erforderlich: Nein

Live-Daten

Geben Sie true an, ob Live-Daten im Widget angezeigt werden sollen. Live-Daten sind Daten, die innerhalb der letzten Minute veröffentlicht und noch nicht vollständig aggregiert wurden. Weitere Informationen finden Sie unter Live-Daten verwenden.

Typ: Boolesch

Erforderlich: Nein

Zeitraum

Der Standardzeitraum in Sekunden für alle Metriken in diesem Widget. Dieser Standard kann innerhalb jeder Metrikdefinition außer Kraft gesetzt werden. Der Standardwert ist 300.

Gültige Werte: 1, 5, 10, 30, 60 und jedes Vielfache von 60. 1, 5, 10 und 30 gelten nur für Metriken mit hoher Auflösung.

Typ: Ganzzahl

Erforderlich: Nein

Region

Dieser Parameter ist optional. Wenn Sie es angeben, muss es die lokale Region angeben.

Typ: Zeichenfolge

Erforderlich: Nein

gestapelt

Geben Sie true an, ob das Diagramm als gestapelte Linie oder als separate Linien angezeigt werden false soll. Der Standardwert lautet „false“.

Typ: Boolesch

Erforderlich: Nein

start

Das Datum und die Uhrzeit für den Start der im Diagramm angezeigten Metriken. Dies kann entweder als absoluter Wert wie 25.04.2018 T12:00:00.000Z oder als relativer Wert wie -PID ausgedrückt werden.

Wenn Sie nichts angebenstart, wird der Standardwert -PT3H (vor drei Stunden) verwendet.

Typ: Zeichenfolge

Erforderlich: Nein

Stat

Die Standardstatistik, die für jede Metrik im Array angezeigt werden soll. Dieser Standard kann innerhalb der Definition jeder einzelnen Metrik im Array außer Kraft gesetzt werden. metrics

Wenn Sie dies auslassen, wird der Standard Average verwendet.

Typ: Zeichenfolge, die eine gültige CloudWatch Statistik ist.

Erforderlich: Nein

Thema

Die Farbpalette, die zum Stylen des Diagramms verwendet wurde. Der Standardwert ist light.

Zulässige Werte: light | dark

Typ: Zeichenfolge

Erforderlich: Nein

timezone

Die Zeitzone, die für die Anzeige der Zeiten im Diagramm verwendet werden soll. Das Format ist + oder - gefolgt von vier Ziffern. Die ersten beiden Ziffern geben die Anzahl der Stunden vor oder nach UTC an, und die letzten beiden Ziffern geben die Anzahl der Minuten an. +0130Gibt beispielsweise eine Zeit an, die 1 Stunde und 30 Minuten vor UTC liegt. Der Standardwert ist +0000.

Typ: Zeichenfolge

Erforderlich: Nein

Titel

Der Titel, der für das Diagramm angezeigt werden soll.

Typ: Zeichenfolge

Erforderlich: Nein

Ansicht

Das Anzeigeformat. Geben Sie timeSeries an, dass diese Metrik als Liniendiagramm angezeigt werden soll. Geben Sie bar an, dass die Metrik als Balkendiagramm angezeigt werden soll. Geben Sie pie an, dass die Metrik als Kreisdiagramm angezeigt werden soll. Der Standardwert ist timeSeries.

Zulässige Werte: timeSeries | bar | pie

Typ: Zeichenfolge

Erforderlich: Nein

width

Die Breite des Widgets in Pixeln. Die Standardeinstellung ist 600.

Gültige Werte: 1—2000

Typ: Ganzzahl

Erforderlich: Nein, aber Sie sollten dies festlegen, wenn Sie auch einen Wert für width festlegen.

Y-Achse

Grenzwerte für die Minima und Maxima der Y-Achse. Dies gilt für jede grafisch dargestellte Metrik, sofern sie nicht von bestimmten Metriken überschrieben wird. Weitere Informationen zum Format finden Sie unterFormat der Y-Achsen-Eigenschaften.

Typ: YAxis-Objekt

Erforderlich: Nein

Jedes Element in der metrics Matrix ist eine CloudWatch Metrik, die im Diagramm angezeigt oder als Teil eines mathematischen Ausdrucks verwendet werden soll, der im Diagramm angezeigt wird. Weitere Informationen zu mathematischen Ausdrücken finden Sie unter Use Metric Math im CloudWatch Amazon-Benutzerhandbuch.

Jede Metrik im Array hat das folgende Format:


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

Namespace

Der AWS Namespace, der die Metrik enthält. Um denselben Namespace wie die vorherige Metrik im Array zu verwenden, können Sie "." für jeden Eintrag nach dem ersten angeben.

Typ: Zeichenfolge

Erforderlich: Ja

MetricName

Der Name der CloudWatch Metrik. Um denselben Namen wie die vorherige Metrik im Array zu verwenden, können Sie "." für jeden Eintrag nach dem ersten angeben.

Typ: Zeichenfolge

Erforderlich: Ja

DimensionName

Der Name einer Dimension, um weiter zu verfeinern, welche Daten angezeigt werden. Um denselben Dimensionsnamen wie die vorherige Metrik im Array zu verwenden, können Sie "." für jeden Eintrag nach dem ersten angeben. Sie können null Dimensionen für eine Metrik oder bis zu so viele Dimensionen angeben, wie die Metrik unterstützt.

Typ: Zeichenfolge

Erforderlich: Nein

DimensionValue

Der Wert, der für diese Dimension für die Metrik verwendet werden soll. Erforderlich, wenn es einen entsprechenden Dimensionsnamen gibt.

Typ: Zeichenfolge

Erforderlich: Nein, es sei denn, es gibt einen entsprechenden Dimensionsnamen.

Optionen-Objekt

Gibt entweder benutzerdefinierte Rendereigenschaften an, die für die angegebene CloudWatch Metrik verwendet werden sollen, oder einen mathematischen Ausdruck, der im Diagramm angezeigt werden soll. Weitere Informationen zum Format finden Sie unterOptionen-Objektformat.

Typ: Options-Objekt

Erforderlich: Nein

Beispiele


// 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" ]

Gibt entweder benutzerdefinierte Rendereigenschaften an, die für die angegebene CloudWatch Metrik verwendet werden sollen, oder einen mathematischen Ausdruck, der im Diagramm angezeigt werden soll.

Wenn dieses Objekt als Teil einer CloudWatch Metrik im metrics Array angegeben wird, legt es benutzerdefinierte Rendereigenschaften für diese Metrik fest und überschreibt die für das gesamte Diagramm verwendeten Standardeinstellungen.

Sie können dieses Objekt auch angeben, um dem Diagramm einen mathematischen Ausdruck hinzuzufügen. In diesem Fall geben die anderen Einstellungen in diesem Objekt die Anzeigeoptionen für das Ergebnis des mathematischen Ausdrucks an.

In diesem Abschnitt wird das Format dieser Optionsobjekte beschrieben.

color

Der sechsstellige HTML-Hex-Farbcode, der für diese Metrik oder diesen Ausdruck verwendet werden soll.

Typ: Zeichenfolge

Erforderlich: Nein

Ausdruck

Ein mathematischer Ausdruck, der angezeigt werden soll. Weitere Informationen zu unterstützten Funktionen und Formaten für mathematische Ausdrücke finden Sie unter Metric Math Syntax and Functions im CloudWatch Amazon-Benutzerhandbuch.

Typ: Zeichenfolge, die ein gültiger CloudWatch metrischer mathematischer Ausdruck ist.

Erforderlich: Ja, wenn es sich um einen Ausdruck handelt.

Bezeichnung

Die Bezeichnung, die für diese Metrik oder diesen Ausdruck in der Diagrammlegende angezeigt werden soll. Wenn dies nicht angegeben ist, erhält die Metrik ein automatisch generiertes Label, das sie von den anderen Metriken im Widget unterscheidet.

Typ: Zeichenfolge

Erforderlich: Nein

id

Ein Bezeichner für diese Metrik oder diesen Ausdruck, der innerhalb dieses Widgets eindeutig sein muss. Die ID kann als Variable verwendet werden, um diese Metrik oder diesen Ausdruck in mathematischen Ausdrücken darzustellen. Gültige Zeichen sind Buchstaben, Zahlen und Unterstriche. Das erste Zeichen muss ein Kleinbuchstabe sein.

Typ: Zeichenfolge

Erforderlich: Nein

Zeitraum

Der Zeitraum für diese Metrik in Sekunden. Falls angegeben, überschreibt dies den Standardzeitraum, der für andere Messwerte in diesem Diagramm verwendet wurde. Dieser Parameter gilt nicht für mathematische Ausdrücke.

Gültige Werte: 1, 5, 10, 30, 60 und jedes Vielfache von 60. 1, 5, 10 und 30 gelten nur für Metriken mit hoher Auflösung.

Typ: Ganzzahl

Erforderlich: Nein

Stat

Die Statistik, die für diese Metrik angezeigt werden soll, wenn sie sich von der Statistik unterscheiden soll, die für die anderen Metriken im Diagramm verwendet wurde. Dieser Parameter gilt nicht für mathematische Ausdrücke.

Typ: Zeichenfolge, die eine gültige CloudWatch Statistik ist.

Erforderlich: Nein

visible

Gibt an, ob diese Metrik oder dieser Ausdruck in der Grafik angezeigt wird. Der Standardwert ist true.

Die Einstellung visible auf false ist nützlich, wenn Sie die Rohmetriken, die in mathematischen Ausdrücken verwendet werden, ausblenden und nur die Ausdrucksergebnisse im Diagramm anzeigen möchten.

Typ: Boolesch

Erforderlich: Nein

Y-Achse

Wo im Diagramm soll die Y-Achse für diese Metrik oder diesen Ausdruck angezeigt werden? Der Standardwert ist left.

Zulässige Werte: left | right

Typ: Zeichenfolge

Erforderlich: Nein

Beispiel

CloudWatch Ruft im folgenden Beispiel eine benutzerdefinierte apiLatency Metrik ab. Oben ist die p50-Statistik angegeben, um den Medianwert anzuzeigen. Als Nächstes wird für dieselbe Metrik in derselben Instanz (dies wird durch die vier Felder angegeben, die nur Perioden sind) der Durchschnittswert grafisch dargestellt. Als Nächstes folgt ein Optionsobjekt mit einem mathematischen Ausdruck, der den halben Wert der beiden Metriken anzeigt. Schließlich zeigt ein weiterer Ausdruck die Änderungsrate.

Um nur die Ergebnisse der beiden Ausdrücke im Diagramm anzuzeigen und die Rohmetriken auszublenden, könnten Sie die ersten beiden Instanzen von visible zu ändernfalse.


{
        "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"
                }
            ]
        ]
    }

Ein einzelnes Diagramm kann mehrere horizontale und vertikale Anmerkungen enthalten. Alle horizontalen Anmerkungen sind in einem horizontal Feld angegeben, und alle vertikalen Anmerkungen sind in einem Feld angegeben. vertical

waagerecht

Eine Reihe von horizontalen Anmerkungen. Horizontale Anmerkungen bieten mehrere Optionen für die Füllschattierung, darunter Schattierung oberhalb der Beschriftungslinie, Schattierung unterhalb der Beschriftungslinie und „Band“ -Schattierung, die zwischen zwei verknüpften Beschriftungslinien als Teil einer einzigen Anmerkung erscheint. Jede horizontale Anmerkung in der Reihe, die keine Bandschattierung aufweist, hat das folgende Format:


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

Jede horizontale Anmerkung, die über eine Bandschattierung verfügt, hat das folgende Format:


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

Vertikale

Eine Reihe von vertikalen Anmerkungen. Vertikale Anmerkungen bieten mehrere Optionen für die Füllschattierung, darunter Schattierung vor der Beschriftungslinie, Schattierung nach der Beschriftungslinie und „Band“ -Schattierung, die zwischen zwei verknüpften Beschriftungslinien als Teil einer einzigen Bandanmerkung erscheint. Jede vertikale Anmerkung in der Anordnung, die keine Bandschattierung aufweist, hat das folgende Format:


{value, label, color, fill, visible}

Jede vertikale Anmerkung, die über eine Bandschattierung verfügt, hat das folgende Format:


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

Das horizontal Array kann die folgenden Felder enthalten.

value

Der metrische Wert im Diagramm, in dem die horizontale Beschriftungslinie erscheinen soll. Bei einer Anmerkung zur Bandschattierung Value definieren die beiden Werte für den oberen und den unteren Rand des Bandes.

In einer Grafik mit horizontalen Anmerkungen wird die Grafik so skaliert, dass alle sichtbaren horizontalen Anmerkungen in der Grafik erscheinen.

Typ: Float

Erforderlich: Ja, wenn horizontale Anmerkungen verwendet werden.

Bezeichnung

Eine Zeichenfolge, die in der Grafik neben der Anmerkung erscheint.

Typ: Zeichenfolge

Erforderlich: Nein

color

Der sechsstellige HTML-Hex-Farbcode, der für die Anmerkung verwendet werden soll. Diese Farbe wird sowohl für die Annotationslinie als auch für die Füllschattierung verwendet.

Typ: Zeichenfolge

Erforderlich: Nein

füllen

So verwenden Sie die Füllschattierung mit der Anmerkung. Gültige Werte gelten above für die Schattierung über der Anmerkung, below für die Schattierung unter der Anmerkung und none für keine Schattierung. Wenn es weggelassen fill wird, gibt es keine Schattierung.

Die Ausnahme ist eine Anmerkung mit Bandschattierung. Diese Anmerkungen weisen immer eine Schattierung zwischen den beiden Werten auf, und jeder Wert für fill wird ignoriert.

Typ: Zeichenfolge

Erforderlich: Nein

visible

Stellen Sie true dies so ein, dass die Anmerkung im Diagramm angezeigt oder false ausgeblendet wird. Der Standardwert ist true.

Typ: Boolesch

Erforderlich: Nein

Y-Achse

Wenn das Diagramm mehrere Metriken enthält, gibt dies an, ob sich die Zahlen auf die Metrik Value beziehen, die der linken Y-axis oder der rechten Y-axis Metrik zugeordnet ist. Gültige Werte sind right und left.

Typ: Zeichenfolge

Erforderlich: Nein

Das vertical Array kann die folgenden Felder enthalten.

value

Der Zeitstempel, an dem die vertikale Beschriftungslinie erscheinen soll. Dieser muss als absoluter Zeitstempel angegeben werden, z. 2018-08-28T15:25:26Z B. Bei einer Anmerkung zur Bandschattierung Value definieren die beiden Werte für die Anfangs- und Endkanten des Bandes.

Typ: Zeichenfolge

Erforderlich: Ja, wenn vertikale Anmerkungen verwendet werden.

Bezeichnung

Eine beschreibende Zeichenfolge, die in der Grafik neben der Anmerkung erscheint.

Typ: Zeichenfolge

Erforderlich: Nein

color

Der sechsstellige HTML-Hex-Farbcode, der für die Anmerkung verwendet werden soll. Diese Farbe wird sowohl für die Annotationslinie als auch für die Füllschattierung verwendet.

Typ: Zeichenfolge

Erforderlich: Nein

füllen

So verwenden Sie die Füllschattierung mit der Anmerkung. Gültige Werte gelten before für die Schattierung vor der Anmerkung, after für die Schattierung nach der Anmerkung und none für keine Schattierung. Wenn es weggelassen fill wird, gibt es keine Schattierung.

Die Ausnahme ist eine Anmerkung mit Bandschattierung. Diese Anmerkungen weisen immer eine Schattierung zwischen den beiden Werten auf, und jeder Wert für fill wird ignoriert.

Typ: Zeichenfolge

Erforderlich: Nein

visible

Stellen Sie true dies so ein, dass die Anmerkung im Diagramm angezeigt oder false ausgeblendet wird. Der Standardwert ist true.

Typ: Boolesch

Erforderlich: Nein

Beispiele


// 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"
            }
        ]
    ]
}

Definiert die Minimal- und Maximalwerte für das Y-axis Diagramm. Stellen Sie dies innerhalb des MetricWidget Objekts so ein, dass es sich auf alle Metriken im Widget auswirkt. Um die Widget-Einstellungen für eine bestimmte Metrik zu überschreiben, legen Sie sie im Optionsobjekt für diese Metrik im metrics Array fest.

links

Optional min und max Einstellungen für die linke Seite Y-axis.

Typ: YAxis-Objekt

Erforderlich: Nein

rechts

Optional min und max Einstellungen für die rechte Seite Y-axis.

Typ: YAxis-Objekt

Erforderlich: Nein

Jedes der right Objekte left und kann die folgenden Parameter enthalten:

min

Der Mindestwert dafür Y-axis.

Typ: Float

Erforderlich: Nein

max

Der Maximalwert dafür Y-axis.

Typ: Float

Erforderlich: Nein

Beispiel


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

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

Einen Alarm aus einer Metrik in einem Diagramm erstellen

Verwenden der Anomalieerkennung