Widget-Referenz

Über diese Seite

Diese Seite dient zum Nachschlagen: wie jede Art von CloudWatch-Widget in jeder Größe dargestellt wird und welche Teile des Dashboard-JSON CloudPeek genau nutzt. Vorlagen und KI-Widgets sind im selben JSON geschrieben, daher gilt das auch für sie. Wie du Widgets erstellst, steht unter Widget erstellen.

Das Erstellen von Widgets hat jetzt eine eigene Seite: Widget erstellen.

Vorlagen haben jetzt eine eigene Seite: Vorlagen.

KI-Widgets haben jetzt eine eigene Seite: KI-Widgets.

Der Tab „Widgets“ ist jetzt Teil von Home-Bildschirm und Sperrbildschirm.

Aktualisierung und Aktualität sind jetzt Teil von So funktioniert CloudPeek.

Widget-Typen

Jede Ansicht eines CloudWatch-Metrik-Widgets sowie Text- und Alarmstatus-Widgets werden zu nativen Widgets auf iPhone, iPad und Android, gezeichnet in den Farben deines Dashboards, mit seinen Schwellenwerten und Achsengrenzen.

Wenn eine Liste nicht passt

• Balken: Wenn es sinnvoll ist, die übrigen Balken zu addieren (Währungsbeträge oder Anzahlen und Summen derselben Metrik), wird der letzte Balken zu einem grauen Balken Sonstige mit ihrer Summe. Andernfalls siehst du „+N weitere“. Angezeigt werden die Balken, die am weitesten von null entfernt sind, oder die niedrigsten, wenn die Schwellenwerte des Widgets auf Unter stehen (siehe Warn- und Alarmschwellen).
• Gesamtwerte: Ein Balken- oder Kreis-Widget zeigt Gesamt, wenn das Dashboard einen Gesamtwert hat, z. B. die kontoweite Zeile EstimatedCharges oder einen Ausdruck SUM(METRICS()). Diese Zeile wird nicht als eigener Balken gezeichnet. Ein Währungs-Widget mit mehreren Balken bildet die Summe selbst.
• Kreis: Jedes Segment wird gezeichnet; die Legende listet so viele auf, wie passen, dann „+N weitere“. Ist der Gesamtwert größer als die Summe der Segmente, wird die Differenz zu einem grauen Segment Sonstige.
• Legenden von Linien- und gestapelten Flächendiagrammen listen auf mittleren Widgets bis zu vier Datenreihen auf (bei größerer Schrift weniger) und auf großen vier, jede mit ihrem neuesten Wert, dann „+N weitere“. Kleine Widgets haben keine Legende.
• Tabellen und Alarmlisten zeigen so viele Zeilen, wie passen, dann „+N weitere“. Eine Tabelle mit einer Zeile pro Zeitraum zeigt die neuesten, dann „+N frühere“.

Größen

Jedes Widget gibt es in jeder Größe. CloudPeek zeigt dir jedes vor dem Hinzufügen in einer Vorschau. Unter Android wählst du die Größe eines Startbildschirm-Widgets, indem du es skalierst, und es zeigt das Layout für den verfügbaren Platz: klein ab 110 × 110 dp, mittel ab 250 × 110 dp und groß ab 250 × 250 dp. Auf einem Startbildschirm mit vier Apps pro Reihe sind das 2 × 2, 4 × 2 und 4 × 4 Zellen.

• Kleine Widgets haben keine Legende und keine Fußzeile. Ein Alarm-Widget beginnt mit seiner Zusammenfassung, z. B. „1 im Alarm“.
• Mittlere und größere Widgets zeigen zusätzlich eine Schaltfläche zum Aktualisieren, eine Legende und eine Fußzeile mit dem Zeitfenster und der Zeit der letzten Aktualisierung, z. B. „Letzte 3 Stunden · Aktualisiert 14:05“. Alarmlisten zeigen, wie lange die letzte Änderung jedes Alarms her ist.
• Große Widgets zeigen mehr Achsenbeschriftungen. Extragroß auf dem iPad ist das große Layout mit mehr Platz; unter Android wird jedes Layout so gezeichnet, dass es den Platz füllt, den du ihm gibst.
• Ein Balken-Widget mit Gesamtwert überlässt auf kleinen und mittleren Widgets einen seiner Plätze dem Gesamtwert.
• Wie viele Zeilen passen, hängt von deiner Textgröße ab; alle weiteren werden als „+N weitere“ gezählt.
• Auf dem iPhone zeigt StandBy kleine Widgets, größer und auf Schwarz gezeichnet, und der Schreibtisch eines Mac zeigt die kleinen, mittleren und großen des iPhone (siehe StandBy und Auf deinem Mac).

Alarmlisten

Ein Alarm-Widget listet Alarme in dieser Reihenfolge auf, jeden mit seinem Zustand:

• Innerhalb jedes Zustands behalten Alarme die Reihenfolge, in der das Widget sie auflistet, oder mit "sortBy": "stateUpdatedTimestamp" kommt die jüngste Änderung zuerst.
• Mittlere und größere Widgets zeigen, wie lange der letzte Zustandswechsel jedes Alarms her ist.
• Die Zusammenfassung auf kleinen Widgets und dem Sperrbildschirm lautet N im Alarm in Rot, wenn ein Alarm im Alarmzustand ist, Alle OK in Grün, wenn alle OK sind, Keine Daten, wenn noch keiner genug Daten hat, und sonst N unbekannt, wobei die ohne Daten und die nicht gefundenen gezählt werden.
• Die Vorlage Alarmübersicht zählt stattdessen die Alarme in jedem Zustand, z. B. „2 ausgelöst, 4 unzureichende Daten, 14 OK“: siehe Vorlagen.
• Eine Alarm-Vorlage über alle Konten gibt jedem Konto eine Zeile, die ernstesten zuerst, mit dem Symbol seines ernstesten Zustands, z. B. „prod: 2 ausgelöst“; Alarme listet darunter die Alarme des Kontos auf, die nicht OK sind. Siehe Alarme in allen Konten.

Sperrbildschirm

Sperrbildschirm-Widgets auf iPhone und iPad zeigen einen Hauptwert, den du ohne Entsperren ablesen kannst. Android-Smartphones haben keine Sperrbildschirm-Widgets.

• Rechteckig: der Titel, der Wert und die Datenreihe oder der Balken, aus dem er stammt (oder eine Warnung, wenn er veraltet ist).
• Rund: der Wert und eine Beschriftung aus etwa 8 Zeichen des Titels.
• Inline, über der Uhr: der Wert und der Titel, gekürzt auf ganze Wörter mit etwa 18 Zeichen.
• Schwellenwerte: Neben einem Wert jenseits der Warn- oder Alarmschwelle des Widgets steht das Symbol dieser Schwelle, da der Sperrbildschirm einfarbig zeichnet (siehe Warn- und Alarmschwellen).

Übersicht-Widgets

Ein Widget Übersicht zeigt zwei bis vier deiner Widgets mit ihren neuesten Werten (siehe Mehrere Werte in einem Widget): zwei auf einem kleinen Widget, vier auf mittleren und größeren und auf iPhone und iPad das erste auf dem Sperrbildschirm.

• Der Wert ist der Hauptwert jedes Widgets auf dem Sperrbildschirm, wie in der Tabelle oben. Ein Alarm-Widget, auch die Vorlage „Alarmübersicht“, zeigt seine Zusammenfassung, z. B. „1 im Alarm“ in Rot mit einem roten Dreieck, „Alle OK“ in Grün mit einem grünen Häkchen oder „Keine Alarme“, wenn es keine hat. Ein Alarm-Widget über alle Konten zeigt stattdessen die Zeile seines ernstesten Kontos, das Aufmerksamkeit braucht, z. B. „prod: 2 ausgelöst“ oder „dev: zum Aktualisieren anmelden“, damit ein Konto, das nicht gelesen werden konnte, nicht hinter dem „Alle OK“ der anderen verschwindet.
• Schwellenwerte: Ein Wert jenseits der Warnschwelle seines Widgets ist orange mit einem eingekreisten „!“, jenseits der Alarmschwelle rot mit einem Dreieck, wie im Widget selbst (siehe Warn- und Alarmschwellen). Gemessen wird der angezeigte Wert; eine Summe von Balken, die selbst nicht gemessen wird, übernimmt die schlimmste Schwelle, die einer ihrer Balken überschreitet.
• Der Trend, ein Pfeil und ein Prozentwert wie „+12 %“, zeigt, wie sich der Wert seit dem vorherigen Punkt verändert hat: bei einer Zahl, wenn ihr Widget einen Trend zeigt, bei einer Messanzeige und bei einem Linien- oder gestapelten Flächendiagramm. Balken, Kreise, Tabellen, Alarme und als Säulen gezeichnete Diagramme haben keinen: Eine Säule ist meist ein noch laufender Zeitraum, z. B. die bisherigen Ausgaben von heute.
• Text-Widgets haben keinen Wert, daher bietet eine Übersicht sie nicht an.
• Ein Widget, das nicht aktualisiert werden konnte, behält seinen letzten Wert und zeigt anstelle seines Trends in Orange, warum: „Zum Aktualisieren anmelden“, „Konto nicht hinzugefügt“ oder „Nicht aktualisiert seit 14:05“; ohne Wert, der erhalten bleiben kann, „Zugriff verweigert“, „AWS nicht erreichbar“ und Ähnliches. Daten, die mehr als einen Tag alt sind, werden blass dargestellt.

Dashboard-Einstellungen, die CloudPeek nutzt

CloudPeek liest das JSON des Dashboards und fragt die Daten so ab wie die CloudWatch-Konsole. Vorlagen und KI-Widgets sind im selben JSON geschrieben, daher gilt all das auch für sie.

Unterstützt

• Metriken: Metrikzeilen mit den Kurzformen "." und "..."; Ausdrücke für Metrikberechnungen, SEARCH und Metrics Insights (SELECT … FROM SCHEMA(…)); "visible": false für Eingaben, die nicht gezeichnet werden sollen.
• Pro Metrik: id, label (einschließlich dynamischer Beschriftungen wie ${PROP('Dim.ServiceName')} und ${LAST}), color, stat, period, region, accountId und yAxis.
• Pro Widget: title, view, stacked, stat (Average, wenn nicht gesetzt), period, region, accountId, start, end, setPeriodToTimeRange, sparkline, trend, min und max der Y-Achse auf beiden Seiten, horizontale annotations (Wert, Farbe, Achse und visible) und "legend": {"position": "hidden"}.
• Rechte Y-Achse: Metriken mit "yAxis": "right" werden auf einer eigenen Skala gezeichnet, die rechts beschriftet ist.
• Pro Dashboard: start, end und periodOverride.
• Alarm-Widgets: alarms und sortBy.

Nicht verwendet

• Beschriftungen von Anmerkungen und der Y-Achse (die Linien und Grenzen werden ohne ihren Text gezeichnet), Anmerkungsbänder (nur ihre erste Kante wird gezeichnet) und vertikale Anmerkungen.
• Legendenpositionen außer „ausgeblendet“, liveData, singleValueFullPrecision und Zusammenfassungsoptionen für Tabellen.
• Dashboard-Variablen: Widgets verwenden die im Dashboard gespeicherten Werte.

Zeitbereich und Zeitraum

• Zeitbereich: der start des Widgets, falls vorhanden, sonst der des Dashboards, sonst die letzten 3 Stunden. Relative Zeitbereiche wie -PT3H oder -P7D und absolute Zeitstempel funktionieren beide. Jedes Widget zeigt das Zeitfenster, das es abdeckt, z. B. „Letzte 3 Stunden“.
• Zeitraum: der period der Metrik, sonst der des Widgets, sonst 5 Minuten. Wie die Konsole vergrößert CloudPeek ihn, wenn der Zeitbereich zu viele Punkte bräuchte (mehr als 300 oder 1.440 mit "periodOverride": "inherit"), in den Stufen 1 Minute, 5 Minuten, 15 Minuten, 1 Stunde, 3 Stunden, 6 Stunden, 1 Tag, 1 Woche und 30 Tage.
• Ältere Daten haben in CloudWatch eine gröbere Auflösung, daher verwenden Zeitbereiche, die vor mehr als 15 Tagen beginnen, Zeiträume von mindestens 5 Minuten, und solche, die vor mehr als 63 Tagen beginnen, Zeiträume von mindestens 1 Stunde.
• setPeriodToTimeRange lässt Zahl-, Messanzeige-, Balken-, Kreis- und Tabellen-Widgets wie in der Konsole einen einzigen Zeitraum für den gesamten Zeitbereich verwenden.

Wie Werte dargestellt werden

• Zahlen haben drei signifikante Stellen, mit K, M, B und T für Tausend, Millionen, Milliarden und Billionen: 1.23K, 45.6M. Ein Wert, den drei Stellen auf eine irreführend runde Zahl runden würden, behält mehr Stellen, sodass 99,96 nicht als 100 angezeigt wird. CloudWatch-Einheiten werden nicht angezeigt, schreib die Einheit also in die Beschriftung, z. B. „Latenz (s)“.
• Währung: Wenn jede Metrik eines Widgets AWS/Billing EstimatedCharges in derselben Währung ist, werden die Werte als Geldbeträge angezeigt: unter 100 mit Cent, bis 10.000 als ganze Beträge, darüber kompakt, z. B. $12.3K. Eine SEARCH über AWS/Billing, die keine Currency nennt, wird in US-Dollar angezeigt, der einzigen Währung, in der AWS Gebühren veröffentlicht.
• Servicenamen auf Fakturierungs-Widgets werden gekürzt: Aus AmazonEC2 wird EC2 und aus AWSLambda wird Lambda.
• Beschriftungen: Eine Metrik ohne Beschriftung wird nach der Metrik benannt oder nach den Dimensionswerten, die sie von den anderen im Widget unterscheiden.
• Trends bei Zahlen vergleichen den neuesten Datenpunkt mit dem vorherigen.
• Farben: deine color bei jeder Metrik, sonst die Standardpalette von CloudWatch.
• Warn- und Alarmschwellen: Der neueste Wert einer Zahl, einer Messanzeige, eines Balkens oder eines Diagramms jenseits einer Schwelle, die du in CloudPeek festgelegt hast, ist orange oder rot und hat ein Symbol (siehe Warn- und Alarmschwellen). CloudPeek schreibt seine Schwellen als horizontale Anmerkungen mit der Markierung "cloudPeekLevel" in das Widget; Diagramme zeichnen sie als gestrichelte Linien. Die eigenen Anmerkungen deines Dashboards werden ebenfalls als Linien gezeichnet, färben aber nie einen Wert ein.

Konten, Regionen und Limits

• Regionen: Jede Metrik verwendet ihre eigene region, sonst die des Widgets, sonst die Standardregion des Kontos in CloudPeek. Ein Widget kann Regionen mischen; CloudPeek fragt jede parallel ab.
• Konten: Jedes Widget wird mit dem Konto aktualisiert, für das es erstellt wurde. Um Metriken eines anderen Kontos in einem Widget zu zeigen, verwende accountId bei der Metrik zusammen mit kontoübergreifender CloudWatch-Beobachtbarkeit oder füge dieses Konto zu CloudPeek hinzu und erstelle das Widget dafür.
• Alarme werden in dem Konto gesucht, für das das Widget erstellt wurde, und zwar in der Region des jeweiligen ARN. Die Alarm-Vorlagen lesen bis zu 1.000 Alarme in der Region, in der sie hinzugefügt wurden (nur solche, deren Namen mit dem unter Anzeigen gewählten Text beginnen, falls einer gewählt wurde); darüber hinaus werden die im Zustand ALARM behalten.
• Umfang: Ein Widget kann bis zu 500 Metriken pro Region auf einmal abfragen und behält bis zu 400 Punkte pro Linie. Diagramme zeichnen höchstens 30 Datenreihen: Ein Liniendiagramm zeigt die 30 mit den höchsten Werten, und ein gestapeltes Diagramm fasst den Rest als „Sonstige“ zusammen.

Text-Widgets

Text-Widgets eignen sich für eine Runbook-Notiz neben den Diagrammen. CloudPeek zeigt:

• Fett, kursiv, code und Links.
• Überschriften, als fette Zeilen.
• Aufzählungen (*, - oder +), als Aufzählungspunkte.
• Die Schaltflächen von CloudWatch, [button:Label](https://…), als einfache Links.

Horizontale Linien werden weggelassen, und mehrere Leerzeilen hintereinander werden zusammengezogen. Tabellen, Bilder und Codeblöcke bleiben besser dem Dashboard in der Konsole vorbehalten. Ein Text-Widget ohne Titel wird nach seiner ersten Zeile benannt.