Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
# Grundstruktur und Syntax des Dashboards
**Topics**
+ [Gesamtstruktur](#Dashboard-Body-Overall-Structure)
+ [Array-Struktur der Widgets](#CloudWatch-Dashboard-Properties-Widgets-Structure)
+ [Variablen, Array-Struktur](#CloudWatch-Dashboard-Properties-Variables-Structure)
+ [Eigenschaften eines Log-Widget-Objekts](#CloudWatch-Dashboard-Properties-Log-Widget-Object)
+ [Eigenschaften eines Metrik-Widget-Objekts](#CloudWatch-Dashboard-Properties-Metric-Widget-Object)
+ [Metrik-Widget: Format für jede Metrik im Array](#CloudWatch-Dashboard-Properties-Metrics-Array-Format)
+ [Eigenschaften eines Metrics Explorer-Widget-Objekts](#CloudWatch-Dashboard-Properties-Metric-Explorer-Object)
+ [Eigenschaften eines Alarm-Status-Widget-Objekts](#CloudWatch-Dashboard-Properties-Alarm-Widget-Object)
## Gesamtstruktur
A `DashboardBody` ist eine Zeichenfolge im JSON-Format. Es kann ein Array von 0 bis 500 Widget-Objekten sowie einige andere Parameter enthalten. Das Dashboard muss ein `widgets` Array enthalten, aber dieses Array kann leer sein.
Im Folgenden finden Sie ein Beispiel für diese Struktur mit einem Metrik-Widget und einem Text-Widget, einem Zeitraum, der sechs Stunden vor der aktuellen Uhrzeit beginnt und die Periodeneinstellung jedes Diagramms stets eingehalten wird.
```
{
"start": "-PT6H",
"periodOverride": "inherit",
"widgets": [
{
"type":"metric",
"x":0,
"y":0,
"width":12,
"height":6,
"properties":{
"metrics":[
[
"AWS/EC2",
"CPUUtilization",
"InstanceId",
"i-012345"
]
],
"period":300,
"stat":"Average",
"region":"us-east-1",
"title":"EC2 Instance CPU",
"liveData": false,
"legend": {
"position": "right"
}
}
},
{
"type":"text",
"x":0,
"y":7,
"width":3,
"height":3,
"properties":{
"markdown":"Hello world"
}
}
]
}
```
Im nächsten Beispiel werden drei Lambda-Metriken pro Funktion angezeigt und eine Dashboard-Variable verwendet, sodass Dashboard-Benutzer zwischen verschiedenen Lambda-Funktionsnamen wechseln und alle drei Metriken für jede Funktion sehen können. Auf diese Weise können Sie ein einziges flexibles Dashboard erstellen, das wichtige Kennzahlen für verschiedene Ressourcen anzeigen kann. In diesem Beispiel werden die Funktionen durch eine Metrik-Suchabfrage erkannt, sodass das Dashboard automatisch neue Lambda-Funktionen erkennt, wenn sie erstellt werden.
```
{
"widgets": [{
"height": 6,
"width": 6,
"y": 0,
"x": 0,
"type": "metric",
"properties": {
"view": "timeSeries",
"stacked": false,
"metrics": ["AWS/Lambda", "Invocations", "FunctionName", "my-function-name"],
"region": "us-east-1",
"liveData": true
}
},
{
"height": 12,
"width": 12,
"y": 0,
"x": 6,
"type": "metric",
"properties": {
"view": "timeSeries",
"stacked": false,
"metrics": ["AWS/Lambda", "Errors", "FunctionName", "my-function-name"],
"region": "us-east-1",
"liveData": true
}
},
{
"height": 3,
"width": 6,
"y": 0,
"x": 18,
"type": "metric",
"properties": {
"view": "timeSeries",
"stacked": false,
"metrics": ["AWS/Lambda", "Duration", "FunctionName", "my-function-name"],
"region": "us-east-1",
"liveData": true
}
}
],
"variables": [{
"type": "property",
"property": "FunctionName",
"inputType": "select",
"id": "LambdaFunction_Variable",
"label": "Function",
"visible": true,
"search": "{AWS/Lambda,FunctionName} MetricName=\"Duration\"",
"populateFrom": "FunctionName"
}]
}
```
Das nächste Beispiel hat zwei Widgets. Das erste enthält zwei Metriken und einen mathematischen Ausdruck, der ihre Summe summiert. Das zweite Widget ist ein Suchausdruck, der den `CPUUtilization` für alle EC2-Instances in der Region anzeigt.
```
{
"start": "-PT9H",
"periodOverride": "inherit",
"widgets": [
{
"type":"metric",
"x":0,
"y":0,
"width":12,
"height":6,
"properties":{
"metrics":[
[ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-123",{ "id": "m1" } ],
[ ".", ".", ".", "i-abc", { "id": "m2" } ],
[ { "expression": "SUM(METRICS())", "label": "Sum of DiskReadbytes", "id": "e3" } ]
],
"view": "timeSeries",
"stacked": false,
"period":300,
"stat":"Average",
"region":"us-east-1",
"title":"EC2 Instance CPU"
}
},
{
"type":"metric",
"x":0,
"y":0,
"width":18,
"height":9,
"properties":{
"metrics":[
[ { "expression": "SEARCH('{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\"', 'Average', 300)", "id": "e1" } ]
],
"view": "timeSeries",
"stacked": false,
"region":"us-east-1",
"title":"EC2 Instance CPU"
}
}
]
}
```
Der Rest dieses Abschnitts enthält Beispiele, die jeden Teil der Syntax veranschaulichen. `DashboardBody` Weitere Beispiele, die die gesamte Befehlssyntax zeigen, finden Sie [PutDashboard](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutDashboard.html)in der Amazon CloudWatch API-Referenz.
Die oberste Ebene des JSON-Objekts kann die folgenden Eigenschaften enthalten.
**Widgets**
Die Liste der Widgets im Dashboard. Weitere Informationen finden Sie unter [Array-Struktur der Widgets](#CloudWatch-Dashboard-Properties-Widgets-Structure).
Erforderlich: Ja
**variables**
Das Array der im Dashboard verwendeten Variablenobjekte des Dashboards. Weitere Informationen zu den Feldern, die Sie in den einzelnen Dashboard-Variablenobjekten verwenden können, finden Sie unter[Variablen, Array-Struktur](#CloudWatch-Dashboard-Properties-Variables-Structure).
Weitere Informationen zu Dashboard-Variablen finden Sie unter [Erstellen flexibler Dashboards mit Dashboard-Variablen](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_dashboard_variables.html).
Wenn Sie ein `variables` Array einbeziehen, kann es zwischen 0 und 25 variable Objekte enthalten.
Erforderlich: Nein
**end**
Das Ende des Zeitbereichs, der für jedes Widget auf dem Dashboard verwendet werden soll, wenn das Dashboard geladen wird. Wenn Sie für `end` einen Wert angeben, müssen Sie einen Wert für `start` angeben. Geben Sie für jeden dieser Werte eine absolute Zeit im Format ISO 8601 an. Beispiel, `2018-12-17T06:00:00.000Z`.
Typ: Zeichenfolge
Erforderlich: Nein
**start**
Der Beginn des Zeitbereichs, der für jedes Widget auf dem Dashboard verwendet werden soll.
Sie können `start` ohne Angabe `end` einen relativen Zeitraum angeben, der mit der aktuellen Uhrzeit endet. In diesem Fall `start` muss der Wert von mit beginnen, `-PT` wenn Sie einen Zeitraum in Minuten oder Stunden angeben, und muss mit beginnen, `-P` wenn Sie einen Zeitraum in Tagen, Wochen oder Monaten angeben. Sie können dann M, H, D, W und M als Abkürzungen für Minuten, Stunden, Tage, Wochen und Monate verwenden. `-PT5M`Zeigt beispielsweise die letzten 5 Minuten, `-PT8H` die letzten 8 Stunden und `-P3M` die letzten drei Monate an.
Sie können es auch `start` zusammen mit einem `end` Feld verwenden, um einen absoluten Zeitraum anzugeben. Verwenden Sie bei der Angabe eines absoluten Zeitbereichs das ISO 8601-Format. Beispiel, `2018-12-17T06:00:00.000Z`.
Wenn Sie diesen Wert weglassen`start`, zeigt das Dashboard beim Laden den Standardzeitbereich an.
Typ: Zeichenfolge
Erforderlich: Nein
**PeriodOverride**
Verwenden Sie dieses Feld, um den Zeitraum anzugeben, in dem die Grafiken geladen werden sollen, wenn das Dashboard geladen wird. Durch `auto` die Angabe wird der Zeitraum aller Grafiken im Dashboard automatisch an den Zeitraum des Dashboards angepasst. Durch die Angabe `inherit` wird sichergestellt, dass der für jedes Diagramm festgelegte Zeitraum immer eingehalten wird.
Gültige Werte: auto \| inherit
Typ: Zeichenfolge
Erforderlich: Nein
## Array-Struktur der Widgets
Jedes Widget eines beliebigen Typs kann die folgenden Eigenschaften haben.
**type**
Der Typ des Widgets.
Zulässige Werte: `metric` \| `text` \| `log` \| `alarm` \| `explorer`
Typ: Zeichenfolge
Erforderlich: Ja
**x**
Die horizontale Position des Widgets im 24-spaltigen Dashboard-Raster. Die Standardeinstellung ist die nächste verfügbare Position.
Gültige Werte: 0—23
Typ: Ganzzahl
Erforderlich: Ja, falls `y` angegeben. Andernfalls nicht erforderlich.
**y**
Die vertikale Position des Widgets im 24-spaltigen Dashboard-Raster. Die Standardeinstellung ist die nächste verfügbare Position.
Gültige Werte: Jede Ganzzahl, 0 oder höher.
Typ: Ganzzahl
Erforderlich: Ja, `x` wenn angegeben. Andernfalls nicht erforderlich.
**width**
Die Breite des Widgets in Rastereinheiten (in einem 24-spaltigen Raster). Die Standardeinstellung ist 6.
Gültige Werte: 1—24
Typ: Ganzzahl
Erforderlich: Nein
**height**
Die Höhe des Widgets in Rastereinheiten. Die Standardeinstellung ist 6.
Gültige Werte: 1—1000
Typ: Ganzzahl
Erforderlich: Nein
**Eigenschaften**
Die detaillierten Eigenschaften des Widgets, die sich je nach Widget-Typ unterscheiden. Weitere Informationen zum Format von finden Sie `properties` unter [Eigenschaften eines Metrik-Widget-Objekts](#CloudWatch-Dashboard-Properties-Metric-Widget-Object) oder[Eigenschaften eines Text-Widget-Objekts](#CloudWatch-Dashboard-Properties-Text-Widget-Object).
Typ: Objekt
Erforderlich: Ja
## Variablen, Array-Struktur
Jede Dashboard-Variable im Array kann die folgenden Eigenschaften haben.
**type**
Der Typ der Dashboard-Variablen. CloudWatch unterstützt zwei Typen: *Eigenschaftsvariablen* und *Mustervariablen*.
Eigenschaftsvariablen ändern die Werte aller Instanzen einer Eigenschaft in allen Widgets im Dashboard. Eine Eigenschaft kann eine der folgenden sein:
+ Jede JSON-Eigenschaft in den Widget-Definitionen, wie `region` z.
+ Beliebiger Dimensionsname für eine Metrik, z. B. `InstanceId` oder`FunctionName`.
Eine Mustervariable ändert ein reguläres Ausdrucksmuster im gesamten JSON-Dashboard. Verwenden Sie sie, wenn Sie nur einen Teil eines JSON-Eigenschaftswerts oder sogar eine JSON-Eigenschaft ändern müssen.
Eigenschaftsvariablen eignen sich für die meisten Anwendungsfälle und sind weniger komplex in der Einrichtung.
Zulässige Werte: `property` \| `pattern`
Typ: Zeichenfolge
Erforderlich: Ja
**inputType**
Legt fest, wie der Dashboard-Benutzer den Wert für die Variable eingibt.
+ Geben Sie `input` an, dass ein Textfeld verwendet werden soll, in das der Benutzer Werte eingeben kann.
+ Geben Sie `select` an, ob Sie eine Dropdowngruppe von Werten verwenden möchten, die Sie definieren, oder eine Dropdownliste mit Werten, die bei einer Metrik-Suchabfrage gefunden wurden.
+ Geben Sie `radio` an, dass Sie eine Reihe von Optionsfeldern mit Werten verwenden möchten, die Sie definieren oder die Sie mit einer Metrik-Suchabfrage finden.
Zulässige Werte: `input` \| `select` \| `radio`
Typ: Zeichenfolge
Erforderlich: Ja
**values**
Wenn Ihr Wert `select` oder `inputType` ist `radio` und Sie die möglichen Variablenwerte definieren möchten, anstatt eine Metrikabfragesuche zu verwenden, geben Sie diese Werte hier an.
`values`ist ein Array, bei dem jedes Objekt im Array einen erforderlichen *Wert* und eine optionale *Bezeichnung* enthält. Jeder *Wert* kann eine Zeichenfolge, eine Zahl oder ein boolescher Wert sein, und jede Bezeichnung muss eine Zeichenfolge sein. Jeder dieser Werte und Bezeichnungen kann bis zu 255 Zeichen lang sein.
Wenn Sie ein `values` Array angeben, muss es mindestens ein Element enthalten und kann bis zu 500 enthalten.
Im Folgenden wird beispielsweise eine Liste mit drei möglichen Regionen erstellt, die als Werte für eine Variable verwendet werden können.
```
"values": [
{ "label": "US East (IAD)", "value": "us-east-1" },
{ "label": "US West (SFO)", "value": "us-west-1" },
{ "label": "EU (DUB)", "value": "eu-west-1" }
]
```
Typ: Array
Erforderlich: Ja, wenn dies `select` oder `inputType` ist `radio` und Sie keine Metrik-Suchabfrage verwenden, um die Werte aufzufüllen.
**id**
Eine ID für diese Variable. Sie kann bis zu 32 Zeichen lang sein. Gültige Zeichen sind `0-9A-Za-z-_`
Typ: Zeichenfolge
Erforderlich: Ja
**Bezeichnung**
Eine Bezeichnung, die für das Eingabefeld angezeigt werden soll. Es kann bis zu 30 Zeichen lang sein.
Wenn Sie dieses Feld für eine Eigenschaftsvariable weglassen, wird der Eigenschaftsname als Bezeichnung angezeigt. Wenn Sie es für eine Mustervariable weglassen, `{{pattern_1}}, {{pattern_2}}, ...` wird es für die Bezeichnung verwendet.
Typ: Zeichenfolge
Erforderlich: Nein
**defaultValue**
Der Standardwert für die Variable, wenn das Dashboard zum ersten Mal geöffnet wird.
+ Wenn `inputType` ja`input`, geben Sie den `defaultValue` hier manuell an und verwenden bis zu 255 Zeichen
+ Falls `inputType` ja `select` oder`radio`, müssen Sie einen gültigen möglichen Wert angeben, den Sie im `values` Array angegeben haben oder der bei der Metrikabfragesuche abgerufen wurde.
Gültige Werte: Jeder gültige Wert für diese Variable
Typ: Zeichenfolge, Zahl oder Boolean, abhängig vom Typwert für diese Variable
Erforderlich: Nein
**search**
Geben Sie dieses Feld an, um Ihr Eingabefeld `select` oder Ihr `radio` Eingabefeld mit einem metrischen Suchausdruck auszufüllen. Geben Sie für den Wert für dieses Feld einen Namespace, einen Dimensionsnamen und einen Metriknamen an. Die Dimension, die Sie angeben, muss für diese Metrik gültig sein. CloudWatch findet alle Ressourcen, die diese Metrik und Dimension veröffentlichen, und füllt die Liste mit ihnen.
Geben Sie beispielsweise an, dass im Konto `"search": "{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\""` nach Amazon EC2 EC2-Instances gesucht werden soll, oder geben Sie `"search": "{AWS/Lambda,FunctionName} MetricName=\"Duration\"",` an, dass die Lambda-Funktionen im Konto zurückgegeben werden sollen
Die von Ihnen angegebene `search` Zeichenfolge kann bis zu 2048 Zeichen lang sein.
Wenn Sie einen Suchausdruck verwenden und auch einen Standardwert angeben möchten, wird der Standardwert verwendet, den Sie angeben, sofern `defaultValue` es sich bei diesem Standard um eine oder die Ressource handelt, die bei der Suche abgerufen wurde. Wenn Sie einen Suchausdruck verwenden, um Ihr Eingabefeld auszufüllen, können Sie auch den speziellen Wert `__FIRST` für angeben`defaultValue`, sodass der Standardwert der erste Wert ist, der von der Suche zurückgegeben wird. (Der Sonderwert enthält zwei Unterstriche und dann FIRST) Die von der Suche zurückgegebenen Werte sind immer alphabetisch sortiert.
Typ: Zeichenfolge
Erforderlich: Ja, wenn `select` oder `inputType` ist `radio` und Sie nichts angeben. `values`
**Auffüllen von**
Wenn Sie das `search` Feld verwenden, um Ihr Eingabefeld mithilfe eines Suchausdrucks aufzufüllen, geben Sie für dieses Feld den Namen einer Dimension an, die bei der Suche abgerufen wird.
Wenn Ihr `search` Wert beispielsweise lautet`"search": "{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\""`, können Sie `InstanceId` für `populateFrom` angeben.
Typ: Zeichenfolge
Erforderlich: Ja, wenn `select` oder `inputType` ist `radio` und Sie keine Angabe machen`values`.
**visible**
Gibt an, ob die Eingabebezeichnung und das Eingabefeld auf dem Dashboard sichtbar sind. Wenn Sie dies auslassen, wird der Standard `true` verwendet.
Die Verwendung `false` spart Platz auf dem Dashboard, erfordert jedoch, dass der Benutzer die Dashboard-URL ändert, um die Variablenwerte zu ändern.
Typ: Boolesch
Erforderlich: Nein
### Beispiele für Variablen
Im folgenden Beispiel wird eine Eigenschaftsvariable verwendet, um die Region aller Widgets mithilfe eines Texteingabefeldes zu ändern. Wenn das Dashboard zum ersten Mal geöffnet wird, `us-east-1` wird der Standardwert von für die Variable verwendet.
```
"variables": [
{
"type": "property",
"property": "region",
"inputType": "input",
"id": "region",
"label": "Region",
"defaultValue": "us-east-1",
"visible": true
}
],
```
Im folgenden Beispiel wird eine Mustervariable verwendet, um die Region aller Widgets zu ändern, falls die Region manchmal in der Mitte einer Zeichenfolge wie einem ARN festgelegt wird.
```
"variables": [
{
"type": "pattern",
"pattern": "us-east-1",
"inputType": "input",
"id": "region",
"label": "Region",
"defaultValue": "us-east-1",
"visible": true
}
],
```
Das folgende Beispiel generiert eine Lambda-Funktionsvariable mit einem Optionsfeld für jede Funktion. Funktionen werden durch eine metrische Abfragesuche erkannt.
```
"variables": [
{
"type": "pattern",
"pattern": "originalFuncNameInDashboard",
"inputType": "radio",
"id": "functionName",
"label": "Function",
"visible": true,
"search": "{AWS/Lambda,FunctionName} MetricName=\"Duration\"",
"populateFrom": "FunctionName",
"defaultValue": "__FIRST"
}
],
```
Das folgende Beispiel zeigt, wie mehrere Variablen in einem Dashboard angegeben werden, und es werden verschiedene Variablentypen veranschaulicht.
```
"variables": [{
"type": "property",
"property": "region",
"inputType": "select",
"id": "unique_id_1",
"label": "Region",
"defaultValue": "us-east-1",
"visible": true,
"values": [{
"label": "IAD",
"value": "us-east-1"
},
{
"label": "CMH",
"value": "us-east-2"
},
{
"label": "NRT",
"value": "ap-northeast-1"
}
]
},
{
"type": "property",
"property": "FunctionName",
"inputType": "select",
"id": "unique_id_2",
"label": "Function",
"visible": true,
"values": [{
"value": "my-FunctionName-1"
},
{
"value": "my-FunctionName-2"
},
{
"value": "my-FunctionName-3"
}
]
},
{
"type": "property",
"property": "accountId",
"inputType": "radio",
"id": "unique_id_3",
"defaultValue": "111122223333",
"visible": true,
"values": [{
"label": "IAD Account",
"value": "111122223333"
},
{
"label": "CMH Account",
"value": "123456789012"
},
{
"label": "NRT Account",
"value": "000000000000"
}
]
}
]
```
### Eigenschaften eines Text-Widget-Objekts
Ein Widget des Typs `text` kann einen oder zwei Parameter im `properties` Abschnitt haben. Das `markdown` Feld ist erforderlich und das `transparent` Feld ist optional.
Weitere Informationen zum Markdown-Stil, der in CloudWatch Text-Widgets unterstützt wird, finden Sie unter [Markdown in der Konsole verwenden](https://docs.aws.amazon.com/general/latest/gr/aws-markdown.html).
**Markdown**
Der Text, der vom Widget angezeigt werden soll. Verwenden Sie diesen Parameter nur für Text-Widgets.
Typ: Zeichenfolge
Erforderlich: Ja (wenn das Widget aktiviert `type` ist`text`).
**Hintergrund**
Gibt an, ob das Text-Widget einen durchgehenden oder transparenten Hintergrund hat. Der Wert `transparent` macht das Widget transparent. Der Wert `solid` ist die Standardeinstellung.
Typ: Zeichenfolge
Erforderlich: Nein
```
{
"widgets":[
{
"type":"text",
"x":0,
"y":7,
"width":3,
"height":3,
"properties":{
"markdown":"Hello world",
"background": "transparent"
}
}
]
}
```
## Eigenschaften eines Log-Widget-Objekts
Ein Widget des Typs `log` stellt die Ergebnisse einer CloudWatch Logs Insights-Abfrage dar. Weitere Informationen finden Sie unter [Analysieren von Protokolldaten mit CloudWatch Logs Insights](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html).
Ein `log` Widget kann die folgenden Felder in seinem `properties` Feld enthalten.
**accountId**
Die Konto-ID des AWS Kontos, das die Protokolle enthält, falls es sich um eine kontoübergreifende Abfrage handelt.
Typ: Zeichenfolge
Erforderlich: Nein
**Region**
Die Region der Protokollabfrage.
Typ: Zeichenfolge
Erforderlich: Ja
**Titel**
Der Titeltext, der vom Widget angezeigt werden soll.
Typ: Zeichenfolge
Erforderlich: Nein
**query**
Enthält die CloudWatch Logs Insights-Abfragefunktion.
Typ: Zeichenfolge
Erforderlich: Ja (wenn das Widget aktiviert `type` ist`log`).
Die `query` Zeichenfolge beginnt mit den Namen der Protokollgruppen, die abgefragt werden sollen. Sie müssen jedem Protokollgruppennamen ein Zeichen voranstellen. `SOURCE` Trennen Sie mehrere Protokollgruppen durch einen senkrechten Strich (\|).
Fügen Sie nach der Liste der Protokollgruppen ein weiteres Pipezeichen hinzu, und geben Sie dann die Abfragesyntax an. Trennen Sie jede Zeile in der Abfragesyntax mit `\n|`
Die folgende Zeile steht beispielsweise für eine Abfrage von zwei Protokollgruppen, `service_log1` und`service_log2`. In der Abfrage werden Kanarienvögel angezeigt, bei denen Fehler aufgetreten sind.
```
"query": "SOURCE 'service_log1' | SOURCE 'service_log2' |filter Fault > 0\n| fields Fault.Message\n| stats count(*) by Canary.Name, Fault.Message"
```
**Ansicht**
Gibt an, wie die Abfrageergebnisse angezeigt werden. Geben Sie `table` an, dass die Ergebnisse als Tabelle angezeigt werden sollen. Geben Sie `timeSeries` an, dass diese Metrik als Liniendiagramm angezeigt werden soll. Geben Sie `bar` an, ob sie als Balkendiagramm angezeigt werden soll. Geben Sie `pie` an, ob es als Kreisdiagramm angezeigt werden soll.
Wenn Sie diesen Parameter weglassen, werden die Ergebnisse als Tabelle angezeigt.
Typ: Zeichenfolge
Erforderlich: Nein (wenn das Widget aktiviert `type` ist`log`).
```
{
"widgets": [
{
"type": "log",
"x": 12,
"y": 24,
"width": 12,
"height": 6,
"properties": {
"region": "us-east-1",
"title": "Errors (Application Log)",
"query": "SOURCE 'application1.log' | SOURCE 'application2.log' | filter @message like \"[ERROR]\"\n| parse \"Error for [*] [*] due to: *\" canaryName1, canaryId1, cause1\n| parse \"Executor canary [*] *\" canaryName2, cause2\n| fields coalesce(cause1, cause2) as cause\n| fields coalesce(canaryName1, canaryName2) as canaryName\n| fields ispresent(cause) as isP\n| filter isP\n| stats count() as errCount by canaryName, substr(cause, 0, 130)\n| sort errCount DESC",
"view": "table"
}
}
]
}
```
## Eigenschaften eines Metrik-Widget-Objekts
Ein Widget des Typs `metric` kann die folgenden Felder enthalten`properties`:
**accountId**
Gibt die AWS Konto-ID an, aus der alle Metriken in diesem Widget stammen. Dies ist nützlich für kontoübergreifende Dashboards, die Widgets aus mehreren Konten enthalten. Weitere Informationen finden Sie unter [Cross-Account Cross-Region CloudWatch -Konsole](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html).
Wenn Sie dies weglassen, wird das Girokonto als Standard verwendet. Verwenden Sie diesen Parameter nur für metrische Widgets.
Sie können auch ein `accountId` Feld innerhalb jeder Metrik im Array von verwenden, `metrics` um ein einzelnes Widget zu erstellen, das Metriken von mehreren Konten enthält.
Typ: Zeichenfolge
Erforderlich: Nein
**Anmerkungen**
Um einen Alarm oder eine Anmerkung in das Widget aufzunehmen, geben Sie ein `annotations` Array an. Weitere Informationen zum Format finden Sie unter[Dashboard-Widget-Objekt: Eigenschaften von Anmerkungen](#CloudWatch-Dashboard-Properties-Annotation-Format). Verwenden Sie diesen Parameter nur für metrische Widgets.
Typ: Objekt
Erforderlich: Eine Alarmanmerkung ist nur erforderlich, wenn das Widget angegeben `type` `metrics` ist `metric` und nicht. Eine horizontale oder vertikale Anmerkung ist nicht erforderlich.
**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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-live-data.html).
Typ: Boolesch
Erforderlich: Nein
**Legende**
Geben Sie `legend` an, wo die Legende für die Linien im Diagramm angezeigt werden soll. Das `legend` Feld enthält ein anderes Feld namens`position`. Mögliche Werte für `position` sind `right``bottom`, und`hidden`.
Im Folgenden wird die Legende beispielsweise auf der rechten Seite des Diagramms angezeigt.
```
"legend": {
"position": "right"
}
```
Typ: Objekt
Erforderlich: Nein
**Metriken**
Geben Sie ein `metrics` Array an, das eine oder mehrere Metriken (ohne Alarme), eine Metrics Insights-Abfrage, mathematische Ausdrücke oder Suchausdrücke enthalten soll. Ein `metrics` Array kann 0—500 Metriken und Ausdrücke enthalten. Verwenden Sie diesen Parameter nur für Metrik-Widgets. Weitere Hinweise zum Format von `metrics` finden Sie unter[Metrik-Widget: Format für jede Metrik im Array](#CloudWatch-Dashboard-Properties-Metrics-Array-Format).
Ein Metrik-Array kann nicht mehr als eine Metrics Insights-Abfrage enthalten.
Ein einzelnes `expression` Feld kann nicht sowohl eine Metrics Insights-Abfrage als auch einen mathematischen Ausdruck enthalten, aber Sie können die zurückgegebenen Ergebnisse einer Metrics Insights-Abfrage aus einem Ausdruck als Eingabe in einem mathematischen Ausdruck in einem anderen Ausdruck im Array verwenden.
Typ: Array von Arrays
Erforderlich: Ja, wenn das Widget angegeben `type` `annotations` ist `metric` und nicht.
**Zeitraum**
Der Standardzeitraum in Sekunden für alle Metriken in diesem Widget. Der Zeitraum ist die Zeitdauer, die durch einen Datenpunkt in der Grafik dargestellt wird. Dieser Standard kann innerhalb jeder Metrikdefinition außer Kraft gesetzt werden. Verwenden Sie diesen Parameter nur für metrische Widgets. Der Standardwert ist 300.
Gültige Werte: Ein beliebiges Vielfaches von 60, wobei 60 das Minimum ist.
Typ: Ganzzahl
Erforderlich: Nein
**Region**
Der Bereich der Metrik.
Typ: Zeichenfolge
Erforderlich: Ja
**Sparkline**
Geben Sie `true` an, ob das Sparkline-Feature unter dem Zahlen-Widget angezeigt werden soll. Geben Sie `false` an, dass das Zahlen-Widget eigenständig angezeigt werden soll. Dieser Parameter wird ignoriert, wenn die Ansicht nicht angezeigt wird`singleValue`. Verwenden Sie diesen Parameter nur für metrische Widgets.
Typ: Boolesch
Erforderlich: Nein
**gestapelt**
Geben Sie `true` an, ob das Diagramm als gestapelte Linie oder als separate Linien angezeigt werden `false` soll. Falls `view` ja, wird dieser Parameter ignoriert. `singleValue` Verwenden Sie diesen Parameter nur für metrische Widgets.
Typ: Boolesch
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` Verwenden Sie diesen Parameter nur für metrische Widgets.
Zulässige Werte: `SampleCount` \| `Average` \| `Sum` \| `Minimum` \| `Maximum` \| `p{{??}}`
Typ: Zeichenfolge, die eine gültige CloudWatch Statistik ist.
Erforderlich: Nein
**Tabelle**
Fügen Sie einen `table` Abschnitt hinzu, um Änderungen im Zusammenhang mit Datentabellen in das Widget aufzunehmen. Weitere Informationen zum Format finden Sie unter. [Dashboard-Widget-Objekt: Tabelleneigenschaften](#CloudWatch-Dashboard-Properties-Table)
Typ: Objekt
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. `+0130`Gibt 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 oder die Zahl angezeigt werden soll. Verwenden Sie diesen Parameter nur für metrische Widgets.
Typ: Zeichenfolge
Erforderlich: Nein
**Ansicht**
Geben Sie `timeSeries` an, ob diese Metrik als Linien- oder gestapeltes Flächendiagramm angezeigt werden soll. Geben Sie `singleValue` an, ob diese Metrik als Zahlendiagramm angezeigt werden soll. Geben Sie `gauge` an, dass diese Metrik als Messdiagramm angezeigt werden soll. Geben Sie `bar` an, dass diese Metrik als Balkendiagramm angezeigt werden soll. Geben Sie `pie` an, dass diese Metrik als Kreisdiagramm angezeigt werden soll.
Wenn Sie angeben`gauge`, müssen Sie einen Wert für `min` und `max` auf der linken Seite von angeben`yAxis`.
Zulässige Werte: `timeSeries` \| `singleValue` \| `gauge` \| `bar` \| `pie` \| `table`
Typ: Zeichenfolge
Erforderlich: Nein
**Y-Achse**
Die Minimal- und Maximalwerte für die linke und rechte Seite eines Diagramms Y-axis. Diese Eigenschaft gilt für alle grafisch dargestellten Metriken, mit Ausnahme bestimmter Metriken, die diese Einstellung außer Kraft setzen. Weitere Informationen finden Sie unter [Dashboard-Widget-Objekt: YAchsen-Eigenschaftenformat](#CloudWatch-Dashboard-Properties-YAxis-Properties-Format).
Typ: YAxis-Objekt
Erforderlich: Nein
**Beispiel: Gestapelte Flächen- und Mess-Widgets**
```
{
"widgets": [
{
"type":"metric",
"x":0,
"y":0,
"width":12,
"height":6,
"properties":{
"metrics":[
[
"AWS/EC2",
"CPUUtilization",
"InstanceId",
"i-012345"
],
[
"AWS/EC2",
"NetworkIn",
"InstanceId",
"i-012345",
{
"yAxis":"right",
"label":"NetworkIn",
"period":3600,
"stat":"Maximum"
}
]
],
"period":300,
"stat":"Average",
"region":"us-east-1",
"timezone":"+0300",
"title":"EC2 Instance CPU",
"stacked":true,
"view":"timeSeries",
"liveData":false,
"yAxis":{
"left":{
"min":0,
"max":100
},
"right":{
"min":50
}
},
"annotations":{
"horizontal":[
{
"visible":true,
"color":"#9467bd",
"label":"Critical range",
"value":20,
"fill":"above",
"yAxis":"right"
}
]
}
},
{
"type": metric,
"x": 18,
"y"; 60,
"width": 6,
"height": 6,
"properties": {
"metrics": [
[
"AWSLogsShrinkRay",
"disk_inodes_used",
"path",
"/dev/shm",
"InstanceId",
"i-012345",
"AutoScalingGroupName",
"ShrinkRayExecutorResourceStack-Gamma-us-east-1-ASGuseast1ac48xlargeASGB9B53974-VTYXJUZGUAHV",
"InstanceType",
"c4.8xlarge",
"device",
"tmpfs",
"fstype",
"tmpfs"
]
],
"view": "gauge",
"title": "Disk Inodes Used"
"region": "us-east-1",
"yAxis": {
"left": {
"min": 0,
"max": 100,
}
}
}
}
```
## Metrik-Widget: Format für jede Metrik im Array
Jedes Element im `metrics` Array ist entweder eine einzelne Metrik oder ein mathematischer Ausdruck oder Suchausdruck. Jede einzelne Metrik im `metrics` Array hat das folgende Format:
```
[ {{Namespace}}, {{MetricName}}, [{{{DimensionName}},{{DimensionValue}}}...] {{{Rendering Properties Object}}} ]
```
Jeder Ausdruck im `metrics` Array hat das folgende Format:
```
[ {"expression" : "{{expression}}", ["label" : "{{label}}"] , ["id" : "{{id}}"] } ]
```
**accountId**
Gibt die AWS Konto-ID an, aus der diese Metrik stammt. Auf diese Weise können Sie ein Widget erstellen, das Kennzahlen von mehreren Konten in einem kontoübergreifenden Dashboard enthält. Weitere Informationen finden Sie unter [Cross-Account Cross-Region CloudWatch -Konsole](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html).
Wenn Sie dies weglassen, wird das Girokonto als Standard verwendet. Verwenden Sie diesen Parameter nur für metrische Widgets.
Typ: Zeichenfolge
Erforderlich: Nein
**Namespace**
Der AWS Namespace, der die Metrik enthält. Wenn das `metrics` Array mehrere Einträge enthält, können Sie für jeden Eintrag nach dem ersten angeben, dass nur `"."` derselbe Namespace wie die vorherige Metrik im Array verwendet werden soll.
Typ: Zeichenfolge
Erforderlich: Ja
**MetricName**
Der Name der CloudWatch Metrik. Wenn das `metrics` Array mehrere Einträge enthält, können Sie für jeden Eintrag nach dem ersten angeben, dass nur `"."` derselbe Metrikname wie die vorherige Metrik im Array verwendet werden soll.
Typ: Zeichenfolge
Erforderlich: Ja, für eine einzelne Metrik
**Ausdruck**
Die Metrics Insights-Abfrage, der mathematische Ausdruck oder der Suchausdruck, wenn es sich um einen Ausdruck und nicht um eine einzelne Metrik handelt.
In einem Suchausdruck, der doppelte Anführungszeichen für eine exakte Übereinstimmung verwendet, muss jedes doppelte Anführungszeichen mit einem umgekehrten Schrägstrich maskiert werden.
Weitere Informationen zur Metrics Insights-Abfragesyntax finden Sie unter [Metrics Insights-Abfragekomponenten](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage.html) und Syntax.
Weitere Informationen zu mathematischen Ausdrücken oder Suchausdrücken finden Sie unter [Verwenden von metrischer Mathematik](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html) oder [Verwenden von Suchausdrücken in Diagrammen](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-search-expressions.html) im CloudWatch Amazon-Benutzerhandbuch.
Typ: Zeichenfolge
Erforderlich: Ja, für einen Ausdruck
Beispiel für einen Ausdruck für eine Metrics Insights-Abfrage:
```
[ { "expression": "SELECT MAX(CPUUtilization) FROM SCHEMA(\"AWS/EC2\", InstanceId) GROUP BY InstanceId LIMIT 10", "label": "View the 10 max CPU Utilization", "id": "q1" } ]
```
**DimensionName**
Der Name einer Dimension, um weiter zu verfeinern, welche Daten angezeigt werden. Wenn das `metrics` Array mehrere Einträge enthält, können Sie für jeden Eintrag nach dem ersten angeben, dass nur derselbe Dimensionsname verwendet werden `"."` soll wie in der entsprechenden Dimension, die in der vorherigen Metrik im Array angegeben wurde. Sie können 0 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
**id**
Die ID dieser Zeitreihe. Diese ID kann als Teil eines mathematischen Ausdrucks verwendet werden. Die ID muss mit einem Kleinbuchstaben beginnen.
Typ: Zeichenfolge
Erforderlich: Nein
**Bezeichnung**
Die Bezeichnung, die im Diagramm angezeigt werden soll, um diese Zeitreihe darzustellen.
Typ: Zeichenfolge
Erforderlich: Nein
**Region**
Die Region der Metrik. Verwenden Sie diesen Parameter nur für metrische Widgets. Wenn Sie dies weglassen, wird die aktuelle Region als Standard verwendet.
Typ: Zeichenfolge
Erforderlich: Nein
**Objekt mit Rendereigenschaften**
Gibt die Rendereigenschaften an, die für diese bestimmte Metrik verwendet werden sollen, und überschreibt dabei die für das gesamte Widget angegebenen Werte. Weitere Informationen zum Format finden Sie unter[Dashboard-Widget-Objekt: Objektformat für Rendereigenschaften](#CloudWatch-Dashboard-Properties-Rendering-Object-Format).
Typ: Objekt mit metrischen Rendereigenschaften
Erforderlich: Nein
```
// The simplest example, a metric with no dimensions
[ "AWS/EC2", "CPUUtilization" ]
// A metric with a single dimension
[ "AWS/EC2", "CPUUtilization", "InstanceId", "i-012345" ]
// A metric with a single dimension and rendering properties
[ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-xyz", { "yAxis": "right"} ]
// The following example graphs the DiskReadBytes metric for three instances.
[ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-xyz" ],
[ ".", ".", ".", "i-abc" ],
[ ".", ".", ".", "i-123" ]
// The following example includes two metrics and a math expression to sum them.
[ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-123",{ "id": "m1" } ],
[ ".", ".", ".", "i-abc", { "id": "m2" } ],
[ { "expression": "SUM(METRICS())", "label": "Sum of DiskReadbytes", "id": "e3" } ]
// The following example is a search expression showing the EC2 CPUUtilization for each instance in the Region.
[ { "expression": "SEARCH('{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\"', 'Average', 300)", "id": "e1" } ],
```
**Topics**
+ [Dashboard-Widget-Objekt: Objektformat für Rendereigenschaften](#CloudWatch-Dashboard-Properties-Rendering-Object-Format)
+ [Dashboard-Widget-Objekt: Eigenschaften von Anmerkungen](#CloudWatch-Dashboard-Properties-Annotation-Format)
+ [Dashboard-Widget-Objekt: YAchsen-Eigenschaftenformat](#CloudWatch-Dashboard-Properties-YAxis-Properties-Format)
+ [Dashboard-Widget-Objekt: Tabelleneigenschaften](#CloudWatch-Dashboard-Properties-Table)
### Dashboard-Widget-Objekt: Objektformat für Rendereigenschaften
Jede Metrik im `metrics` Array kann optional über benutzerdefinierte Rendereigenschaften verfügen, die die im `yAxis` Parameter des `widget` Objekts angegebenen Standard-Rendering-Eigenschaften überschreiben. In diesem Abschnitt wird das Format für diese benutzerdefinierten Rendereigenschaften pro Metrik beschrieben.
**color**
Der sechsstellige HTML-Hex-Farbcode, der für diese Metrik verwendet werden soll.
Typ: Zeichenfolge
Erforderlich: Nein
**Bezeichnung**
Die Bezeichnung, die für diese Metrik in der Diagrammlegende angezeigt werden soll. Wenn dies nicht angegeben ist, erhält die Metrik eine automatisch generierte Bezeichnung, die sie von den anderen Metriken im Widget unterscheidet.
Typ: Zeichenfolge
Erforderlich: Nein
**Zeitraum**
Der Zeitraum für diese Metrik in Sekunden. Der Zeitraum ist die Zeitdauer, die durch einen Datenpunkt in der Grafik dargestellt wird.
Gültige Werte: Ein Vielfaches von 60, mit einem Minimum von 60.
Typ: Ganzzahl
Erforderlich: Nein
**Stat**
Die Statistik für diese Metrik, wenn sie sich von der Statistik unterscheiden soll, die für die anderen Metriken im Array verwendet wird. Standardmäßig CloudWatch verwendet *Average*, wenn Sie keine Statistik auf Array- oder Metrik-Ebene angeben.
Zulässige Werte: `SampleCount` \| `Average` \| `Sum` \| `Minimum` \| `Maximum` \| `p{{??}}`
Typ: Zeichenfolge, die eine gültige CloudWatch Statistik ist.
Erforderlich: Nein
**visible**
Stellen Sie `true` dies so ein, dass die Metrik im Diagramm angezeigt oder `false` ausgeblendet wird. Der Standardwert ist `true`.
Typ: Boolesch
Erforderlich: Nein
**Y-Achse**
Wo in der Grafik soll die Y-Achse für diese Metrik angezeigt werden? Der Standardwert ist `left`.
Zulässige Werte: `left` \| `right`
Typ: Zeichenfolge
Erforderlich: Nein
```
// The third metric has its own rendering properties, overriding those of the rest of the widget.
[ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-xyz" ],
[ ".", ".", ".", "i-abc" ],
[ ".", ".", ".", "i-123", { "label":"Instance i-123", "yAxis": "right"} ]
```
### Dashboard-Widget-Objekt: Eigenschaften von Anmerkungen
Zu den Anmerkungen gehören Alarme, horizontale Anmerkungen und vertikale Anmerkungen. Ein einzelnes Metrik-Widget kann bis zu einem Alarm oder eine oder mehrere horizontale oder vertikale Anmerkungen enthalten. Ein einzelnes Widget kann nicht sowohl einen Alarm als auch horizontale oder vertikale Anmerkungen enthalten.
#### Alarmanmerkungen
Wenn Sie eine Alarmanmerkung angeben, können Sie nicht auch ein `metrics` Array im selben Widget angeben.
**Alarme**
Der Amazon-Ressourcenname (ARN) des Alarms.
Typ: Zeichenfolge-Array. Das Array kann 0—1 Zeichenketten enthalten.
Erforderlich: Nur wenn keine Metriken aufgeführt sind.
```
"annotations": {
"alarms": [ "{{arn1}}" ]
}
```
#### Horizontale Anmerkungen
**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 Bandanmerkung erscheint. Jede horizontale Anmerkung in der Anordnung, bei der es sich nicht um eine Bandanmerkung, sondern um eine einzelne Anmerkung handelt, hat das folgende Format:
```
{{{value}}, {{label}}, {{color}}, {{fill}}, {{yAxis}}, {{visible}}}
```
Jede horizontale Anmerkung, bei der es sich um eine Bandanmerkung handelt, hat das folgende Format:
```
[ {{{value}}, {{label}}, {{color}}, {{yAxis}}, {{visible}}}, {{{value}}, {{label}}} ]
```
**value**
Der metrische Wert im Diagramm, in dem die horizontale Beschriftungslinie erscheinen soll. Bei einer Anmerkung zur Bandschattierung definieren die beiden Werte für Value den oberen und 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
**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 Y-axis, die der linken Y-axis oder der rechten Metrik zugeordnet ist. Gültige Werte sind `right` und `left`.
Typ: Zeichenfolge
Erforderlich: Nein
```
// 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 band annotation. Each value has a label, but other parameters for the band are 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"
}
]
]
}
// Three annotations on a graph. The first one is a band annotation. The final one is hidden.
"annotations": {
"horizontal": [
[
{
"label": "Band top",
"value": 200,
"color": "#9467bd",
"visible": true,
"yAxis": "right"
},
{
"value": 95.5,
"label": "Band bottom"
}
],
{
"visible": true,
"color": "#9467bd",
"label": "Label for this annotation",
"value": 20,
"fill": "below",
"yAxis": "right"
},
{
"visible": false,
"color": "#aaa",
"label": "Hidden annotation",
"value": 150
}
]
}
```
#### Vertikale Anmerkungen
**Vertikale**
Eine Reihe von vertikalen Anmerkungen. Für jede vertikale Anmerkung können Sie wählen, ob vor der Anmerkung, nach ihr oder zwischen zwei vertikalen Linien, die als einzelne Bandanmerkung miteinander verknüpft sind, eine Füllschattierung angezeigt wird. Jede vertikale Anmerkung in der Reihe, bei der es sich nicht um eine Bandanmerkung, sondern um eine einzelne Anmerkung handelt, hat das folgende Format:
```
{{{value}}, {{label}}, {{color}}, {{fill}}, {{visible}}}
```
Jede vertikale Anmerkung, bei der es sich um eine Bandanmerkung handelt, hat das folgende Format:
```
[ {{{value}}, {{label}}, {{color}}, {{visible}}}, {{{value}}, {{label}}} ]
```
**value**
Datum und Uhrzeit im Diagramm, an dem die vertikale Beschriftungslinie erscheinen soll. Bei einer Anmerkung zur Bandschattierung definieren die beiden Werte für Wert die Anfangs- und Endkanten des Bandes.
In einer Grafik mit vertikalen Anmerkungen wird die Grafik so skaliert, dass alle sichtbaren vertikalen Anmerkungen in der Grafik erscheinen.
Dies ist als Zeichenfolge im ISO 8601-Format definiert. Weitere Informationen finden Sie unter [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).
Typ: Zeichenfolge
Erforderlich: Ja
**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 `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
```
// 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 band vertical 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"
}
]
]
}
```
### Dashboard-Widget-Objekt: YAchsen-Eigenschaftenformat
Definiert die Einstellungen für Y-axis das Diagramm. Zu den Einstellungen gehören das Maximum und das Minimum, eine Bezeichnung für die Achse und ob auf der Achse die Einheiten angezeigt werden. Stellen Sie dies innerhalb des `widget` 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 für die Metrik im `metrics` Array fest.
```
{
left: {
min: 0,
max: 100
},
right: {
min: 0
}
}
```
**links**
Optionale Einstellungen für die linke Seite Y-axis.
Typ: YAxis-Objekt
Erforderlich: Nein
**rechts**
Optionale Einstellungen für die rechte Seite. Y-axis
Typ: YAxis-Objekt
Erforderlich: Nein
Jedes der `right` Objekte `left` und kann die folgenden Parameter enthalten:
**Bezeichnung**
Ein Etikett dafür Y-axis
Typ: Zeichenfolge
Erforderlich: Nein
**min**
Der Mindestwert dafür Y-axis
Typ: Float
Erforderlich: Nein
**max**
Der Maximalwert dafür Y-axis
Typ: Float
Erforderlich: Nein
**Einheiten anzeigen**
Legt fest, ob die Einheiten für die mit dieser Achse verknüpfte Metrik angezeigt werden. Der Standardwert ist true.
Typ: Boolesch
Erforderlich: Nein
### Dashboard-Widget-Objekt: Tabelleneigenschaften
Wenn Sie dies `table` für ein Metrik-Widget angeben, können Sie Visualisierungen einbeziehen, die sich auf die Sichtbarkeit von Übersichtsspalten, Datenpunktspalten und das Tabellenlayout beziehen. Diese Eigenschaften werden nur wirksam, wenn der Widget-Ansichtstyp ist, `table` und ändern andere Ansichtstypen nicht, sofern sie enthalten sind. Die `table` Eigenschaft ist nicht erforderlich, um ein Tabellen-Widget zu verwenden.
**layout**
Verwenden Sie dieses Feld, um die Tabelle so zu transformieren, dass sich die Datenpunkte vertikal oder horizontal erstrecken. Der Standardwert ist `horizontal`.
Zulässige Werte: `vertical` \| `horizontal`
Typ: Zeichenfolge
Erforderlich: Nein
**Klebrige Zusammenfassung**
Stellen Sie diesen Wert `true` auf ein, damit die Übersichtsspalten, die Sie in die Tabelle aufnehmen, einbinden, sodass Sie die Datenspalten untersuchen können, während Sie die Übersichtsspalten immer in Ihrem Darstellungsfenster haben. Der Standardwert ist `false`.
Das Widget-Label ist immer einklebrig, unabhängig von Ihrer Wahl in diesem Feld.
Zulässige Werte: `true` \| `false`
Typ: Boolesch
Erforderlich: Nein
**zeigen TimeSeriesData**
Stellen Sie diese Option ein, `false` wenn nur die Bezeichnungs- und Übersichtsspalten angezeigt werden sollen und die anderen Datenspalten ausgeblendet werden sollen.
Der Standardwert ist `true`.
Zulässige Werte: `true` \| `false`
Typ: Boolesch
Erforderlich: Nein
**Übersichtsspalten**
Übersichtsspalten sind eine neue Eigenschaft, die mit dem Tabellen-Widget eingeführt wurde. Bei diesen Spalten handelt es sich um eine bestimmte Teilmenge von Zusammenfassungen Ihrer aktuellen Tabelle. Die `Sum` Zusammenfassung ist beispielsweise eine Summe aller gerenderten Datenpunkte in der jeweiligen Zeile. Bei Übersichtsspalten handelt es sich nicht um dasselbe Konzept wie bei anderen CloudWatch metrischen Statistiken.
Der Standardwert ist `[“MIN“, "MAX","SUM", "AVG"]`
Zulässige Werte: `"MIN"` \| `"MAX"` \| `"SUM"` \| `"AVG"`
Typ: Array
Erforderlich: Nein
Mit dem folgenden JSON-Code wird beispielsweise eine Tabelle erstellt, in der das Minimum und das Maximum jeder Metrik in der Tabelle angezeigt werden.
```
"table": {
"summaryColumns": ["MIN", "MAX"],
"layout": "vertical",
"stickySummary": true,
"showTimeSeriesData": false,
},
```
## Eigenschaften eines Metrics Explorer-Widget-Objekts
Ein Widget des Typs `explorer` steht für ein Metrik-Explorer-Widget. Weitere Informationen finden Sie unter [Verwenden des Metrics Explorers zur Überwachung von Ressourcen anhand ihrer Tags und Eigenschaften](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metrics-Explorer.html)
Sie können einem Dashboard auch Metrik-Explorer-Widgets hinzufügen, indem Sie CloudFormation. Weitere Informationen finden Sie unter [ AWS::CloudWatch: :Dashboard](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html).
Dieser Widget-Typ kann die folgenden Felder innerhalb des Widgets `properties` haben:
**Aggregieren von**
Ein Objekt, das angibt, wie Metriken aus mehreren Ressourcen aggregiert werden. Die gültigen Werte für das `key` Feld in diesem Objekt sind die Schlüssel von Tags und Ressourceneigenschaften. Dieses Objekt enthält die folgenden Felder.
+ **key** — Der Tag- oder Ressourceneigenschaftsschlüssel, der für die Aggregation der Metriken verwendet werden soll.
+ **func** — Die zu verwendende Aggregationsfunktion. Gültige Werte sind `AVG` \| \| `MIN` \| `MAX` `STDDEV` `SUM`
Typ: Objekt
Erforderlich: Nein
**labels**
Ein Array der Tags oder Ressourceneigenschaften, anhand derer bestimmt wird, welche Metriken im Widget angezeigt werden.
Wenn Sie unterschiedliche Schlüssel angeben, werden nur die Ressourcen angezeigt, die allen key/value Paaren entsprechen. Wenn Sie mehrere Werte für einen einzelnen Schlüssel angeben, werden Ressourcen angezeigt, die einem der Werte für diesen Schlüssel entsprechen.
+ **key** — Das Tag oder die Ressourceneigenschaft, nach der gefiltert werden soll.
Für`key`, es ist zulässig, dass alle Tag-Schlüssel angegeben werden. Die folgenden EC2- und Lambda-Ressourceneigenschaften gelten auch für: `key`
+ EC2:
`Architecture`, `Hypervisor`, `CoreCount`, `ImageId`, `InstanceId`, `InstanceLifecycle`, `InstanceType`, `InstanceFamily`, `InstanceSize`, `Affinity`, `AvailabilityZone`, `Tenancy`, `Platform`, `RootDeviceType SecurityGroups, State, SubnetId, VirtualizationType, and VpcId `
+ Lambda:
`FunctionName`, `Runtime`, `Language`, `MemorySize`, `Version`, `SecurityGroupIds`, `SubnetIds`, `SubnetIdCount`, `VpcId` und `Timeout`
+ **value** — (Optional) Der Wert des Tags oder der Ressourceneigenschaft, nach der gefiltert werden soll. Wenn dieser Wert weggelassen wird, werden Metriken angezeigt, die allen Werten dieses Tags oder dieser Ressourceneigenschaft entsprechen.
Typ: Objekt
Erforderlich: Ja
**Metriken**
Geben Sie ein `metrics` Array an, das eine oder mehrere Metriken enthalten soll. Ein `metrics` Array kann 1—100 Metriken enthalten. Jedes Objekt im Array muss die folgenden Felder enthalten.
+ **metricName** — Der Name der Metrik.
+ **resourceType** — Der Ressourcentyp, der die Metrik veröffentlicht, beschrieben in dem von verwendeten Format. AWS CloudFormation Zum Beispiel `AWS::EC2::Instance` oder `AWS::Lambda::Function`.
Sie müssen denselben Wert `resourceType` für alle Metriken im Widget verwenden.
Eine vollständige Liste der gültigen Werte finden Sie unter[Gültige ResourceType-Werte für ein Metric Explorer-Widget-Objekt](#CloudWatch-Dashboard-Properties-Metric-Explorer-resourceType).
+ **stat** — Die Statistik für diese Metrik, falls sie sich von der Statistik unterscheiden soll, die für die anderen Metriken im Array verwendet wird. Standardmäßig CloudWatch verwendet *Average*, wenn Sie keine Statistik auf Array- oder Metrik-Ebene angeben.
Zulässige Werte: `SampleCount` \| `Average` \| `Sum` \| `Minimum` \| `Maximum` \| `p{{??}}`
Typ: Array von -Objekten
Erforderlich: Ja
**Zeitraum**
Der Standardzeitraum in Sekunden für alle Metriken in diesem Widget. Der Zeitraum ist die Zeitdauer, die durch einen Datenpunkt in der Grafik dargestellt wird. Der Standardwert ist 300.
Gültige Werte: Ein beliebiges Vielfaches von 60, wobei 60 das Minimum ist.
Typ: Ganzzahl
Erforderlich: Nein
**Aufteilen nach**
Gibt an, wie die Metriken aus mehreren Ressourcen in verschiedene Linien in einem Diagramm oder in verschiedene Grafiken aufgeteilt werden. Die gültigen Werte sind die Schlüssel von Tags und die Schlüssel der Ressourceneigenschaften.
Typ: Zeichenfolge
Erforderlich: Nein
**Titel**
Der Titel, der für das Widget angezeigt werden soll. Der Standardwert ist `Explorer`.
Typ: Zeichenfolge
Erforderlich: Nein
**Widget-Optionen**
Ein Objekt, das angibt, wie das Widget auf dem Dashboard angezeigt wird. Es kann die folgenden Felder enthalten.
+ **Legende** —
Legt fest, wo die Legende für jedes Diagramm angezeigt wird. Das `legend` Feld enthält ein anderes Feld namens`position`. Mögliche Werte für `position` sind `right``bottom`, und`hidden`.
Im Folgenden wird die Legende beispielsweise auf der rechten Seite des Diagramms angezeigt.
```
"legend": {
"position": "right"
}
```
+ **Zeilen PerPage** —
Gibt an, wie viele Zeilen mit Diagrammen pro Seite im Widget angezeigt werden.
+ **gestapelt** —
Geben Sie `true` an, ob das Diagramm als gestapeltes Flächendiagramm oder als separate `false` Linien angezeigt werden soll.
+ **anzeigen** —
Gibt an, wie jedes Diagramm angezeigt wird. Geben Sie `timeSeries` an, dass diese Metrik als Liniendiagramm angezeigt werden soll. Geben Sie `bar` an, ob sie als Balkendiagramm angezeigt werden soll. Geben Sie `pie` an, ob es als Kreisdiagramm angezeigt werden soll. Der Standardwert ist `timeSeries`.
+ **Widgets PerRow** —
Gibt an, wie viele Grafiken in jeder Zeile des Metrik-Explorer-Widgets angezeigt werden.
Typ: Objekt
Erforderlich: Nein
**Beispiel**
Im folgenden Beispiel werden drei Metriken für jede der laufenden EC2-Instances des Kontos angezeigt, wobei die Diagramme im Widget nach Verfügbarkeitszonen aufgeteilt sind. In jedem Diagramm sind die Metriken nach Instance-Typ aggregiert.
```
{
"widgets": [
{
"type": "explorer",
"width": 24,
"height": 15,
"x": 0,
"y": 0,
"properties": {
"metrics": [
{
"metricName": "CPUUtilization",
"resourceType": "AWS::EC2::Instance",
"stat": "Average"
},
{
"metricName": "NetworkIn",
"resourceType": "AWS::EC2::Instance",
"stat": "Average"
},
{
"metricName": "NetworkOut",
"resourceType": "AWS::EC2::Instance",
"stat": "Average"
}
],
"aggregateBy": {
"key": "InstanceType",
"func": "MAX"
},
"labels": [
{
"key": "State",
"value": "running"
}
],
"widgetOptions": {
"legend": {
"position": "bottom"
},
"view": "timeSeries",
"rowsPerPage": 8,
"widgetsPerRow": 2
},
"period": 300,
"splitBy": "AvailabilityZone",
"title": "Running EC2 Instances by AZ"
}
}
]
}
```
### Gültige ResourceType-Werte für ein Metric Explorer-Widget-Objekt
Die gültigen Werte für das `resourceType` Feld im `metrics` Abschnitt eines Metrik-Explorer-Widgets lauten wie folgt:
+ `AWS::AmazonMQ::Broker`
+ `AWS::ApiGateway::RestApi`
+ `AWS::AppStream::Fleet`
+ `AWS::AppSync::GraphQLApi`
+ `AWS::CloudFront::Distribution`
+ `AWS::CodeBuild::Project`
+ `AWS::Datasync::Agent`
+ `AWS::Datasync::Task`
+ `AWS::DMS::ReplicationInstance`
+ `AWS::DynamoDB::Table`
+ `AWS::EC2::CapacityReservation`
+ `AWS::EC2::Instance`
+ `AWS::EC2::NatGateway`
+ `AWS::EC2::TransitGateway`
+ `AWS::EC2::Volume`
+ `AWS::EC2::VPNConnection`
+ `AWS::ECS::Cluster`
+ `AWS::EFS::FileSystem`
+ `AWS::ElastiCache::CacheCluster`
+ `AWS::ElastiCache::ReplicationGroup`
+ `AWS::ElasticBeanstalk::Environment`
+ `AWS::ElasticLoadBalancing::LoadBalancer`
+ `AWS::ElasticLoadBalancingV2::LoadBalancer/ApplicationELB`
+ `AWS::ElasticLoadBalancingV2::LoadBalancer/GatewayELB`
+ `AWS::ElasticLoadBalancingV2::LoadBalancer/NetworkELB`
+ `AWS::ElasticLoadBalancingV2::TargetGroup`
+ `AWS::EMR::Cluster`
+ `AWS::Events::Rule`
+ `AWS::FSx::FileSystem`
+ `AWS::GameLift::Fleet`
+ `AWS::GlobalAccelerator::Accelerator`
+ `AWS::IoT::TopicRule`
+ `AWS::IoT1Click::Device`
+ `AWS::IoTAnalytics::Channel`
+ `AWS::IoTAnalytics::Dataset`
+ `AWS::IoTAnalytics::Datastore`
+ `AWS::IoTAnalytics::Pipeline`
+ `AWS::Kafka::Cluster`
+ `AWS::Kinesis::Stream`
+ `AWS::KinesisAnalytics::Application`
+ `AWS::KinesisFirehose::DeliveryStream`
+ `AWS::KinesisVideo::Stream`
+ `AWS::KMS::Key`
+ `AWS::Lambda::Function`
+ `AWS::Logs::LogGroup`
+ `AWS::MediaPackage::Channel`
+ `AWS::MediaStore::Container`
+ `AWS::OpsWorks::Instance`
+ `AWS::OpsWorks::Layer`
+ `AWS::OpsWorks::Stack`
+ `AWS::QLDB::Ledger`
+ `AWS::RDS::DBInstance`
+ `AWS::Redshift::Cluster`
+ `AWS::RoboMaker::SimulationJob`
+ `AWS::Route53::HealthCheck`
+ `AWS::Route53Resolver::ResolverEndpoint`
+ `AWS::S3::Bucket`
+ `AWS::SageMaker::Endpoint`
+ `AWS::ServiceCatalog::CloudFormationProduct`
+ `AWS::SES::ConfigurationSet`
+ `AWS::SNS::Topic`
+ `AWS::SQS::Queue`
+ `AWS::StepFunctions::Activity`
+ `AWS::StepFunctions::StateMachine`
+ `AWS::StorageGateway::Gateway`
+ `AWS::Synthetics::Canary`
+ `AWS::Transfer::Server`
+ `AWS::WorkMail::Organization`
+ `AWS::WorkSpaces::Workspace`
## Eigenschaften eines Alarm-Status-Widget-Objekts
Ein Widget des Typs `alarm` kann die folgenden Felder enthalten`properties`.
**Alarme**
Eine Reihe von Alarm-ARNs, die in das Widget aufgenommen werden sollen. Das Array kann 1—100 ARNs haben.
Typ: Zeichenfolgen-Array
Erforderlich: Ja (wenn das Widget aktiviert `type` ist`alarm`).
**Sortieren nach**
Gibt an, wie die Alarme im Widget sortiert werden sollen.
Wählen Sie`default`, ob sie in alphabetischer Reihenfolge nach dem Alarmnamen sortiert werden sollen.
Wählen Sie`stateUpdatedTimestamp`, ob sie zuerst nach dem Alarmstatus sortiert werden sollen, wobei Alarme im ALARM-Status zuerst, die Alarme INSUFFICIENT\_DATA als nächstes und die Alarme OK zuletzt angezeigt werden. Innerhalb jeder Gruppe werden die Alarme danach sortiert, wann sie zuletzt ihren Status geändert haben, wobei neuere Statusänderungen zuerst aufgeführt werden.
`timestamp`Sortieren Sie sie unabhängig vom aktuellen Alarmstatus nach dem Zeitpunkt, zu dem sich der Status der Alarme zuletzt geändert hat. Der Alarm, dessen Status zuletzt geändert wurde, wird zuerst aufgeführt.
Wenn Sie dieses Feld weglassen, werden die Alarme in alphabetischer Reihenfolge sortiert.
Typ: Zeichenfolge
Gültige Werte: Standard \| Status \| Zeitstempel UpdatedTimestamp
Erforderlich: Nein
**Status**
Verwenden Sie dieses Feld, um die Liste der im Widget angezeigten Alarme auf die Alarme zu filtern, die sich derzeit in den angegebenen Status befinden. Sie können im Wert für dieses Feld einen oder mehrere Alarmstatus angeben. Die Alarmstatus, die Sie angeben können`ALARM`, sind`INSUFFICIENT_DATA`, und`OK`.
Wenn Sie dieses Feld weglassen oder ein leeres Array angeben, `alarms` werden alle in angegebenen Alarme angezeigt.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
**Titel**
Der Titeltext, der vom Widget angezeigt werden soll.
Typ: Zeichenfolge
Erforderlich: Nein
Das folgende Beispiel ist ein Alarmstatus-Widget, das vier namentlich angegebene Alarme anzeigt, unabhängig von ihrem aktuellen Status:
```
{
"type": "alarm",
"x": 0,
"y": 0,
"width": 12,
"height": 6,
"properties": {
"alarms": [
"arn:aws:cloudwatch:us-east-1:012345678901:alarm:EC2FrontendCPU",
"arn:aws:cloudwatch:us-east-1:012345678901:alarm:EC2BackendCPU",
"arn:aws:cloudwatch:eu-west-1:987654321098:alarm:EC2FrontendCPU",
"arn:aws:cloudwatch:eu-west-1:987654321098:alarm:EC2BackendCPU"
],
"sortBy": "stateUpdatedTimestamp",
"title": "All EC2 CPU alarms"
}
}
```
Das folgende Beispiel-Widget spezifiziert dieselben vier Alarme, aber das Widget zeigt nur die Alarme an, die sich derzeit im Status ALARM oder INSUFFICIENT\_DATA befinden:
```
{
"type": "alarm",
"x": 0,
"y": 0,
"width": 12,
"height": 6,
"properties": {
"alarms": [
"arn:aws:cloudwatch:us-east-1:012345678901:alarm:EC2FrontendCPU",
"arn:aws:cloudwatch:us-east-1:012345678901:alarm:EC2BackendCPU",
"arn:aws:cloudwatch:eu-west-1:987654321098:alarm:EC2FrontendCPU",
"arn:aws:cloudwatch:eu-west-1:987654321098:alarm:EC2BackendCPU"
],
"sortBy": "stateUpdatedTimestamp",
"states": [
"ALARM",
"INSUFFICIENT_DATA"
],
"title": "EC2 alarms that are not currently OK"
}
}
```