Référence des widgets

À propos de cette page

Cette page sert de référence : comment chaque type de widget CloudWatch est dessiné, à chaque taille, et quelles parties exactes du JSON d’un tableau de bord CloudPeek utilise. Les préréglages et les widgets IA sont écrits dans le même JSON : elle s’applique donc aussi à eux. Pour créer des widgets, voir Créer un widget.

La création de widgets a désormais sa propre page : Créer un widget.

Les préréglages ont désormais leur propre page : Préréglages.

Les widgets IA ont désormais leur propre page : Widgets IA.

L’onglet Widgets fait désormais partie de Écran d’accueil et écran verrouillé.

L’actualisation et la fraîcheur des données font désormais partie de Fonctionnement de CloudPeek.

Types de widgets

Chaque vue de widget de métriques CloudWatch, ainsi que les widgets de texte et d’état des alarmes, devient un widget natif sur iPhone, iPad et Android, dessiné aux couleurs de votre tableau de bord avec ses seuils et les limites de ses axes.

Quand une liste ne tient pas

• Barres : si additionner les barres restantes a un sens (devise, ou décomptes et sommes d’une même métrique), la dernière barre devient une barre grise Autres avec leur total. Sinon, vous verrez « +N de plus ». Les barres affichées sont les plus éloignées de zéro, ou les plus basses quand les seuils du widget sont réglés sur En dessous (voir Seuils d’avertissement et d’alarme).
• Totaux : un widget à barres ou en secteurs affiche un Total quand le tableau de bord en a un, par exemple la ligne EstimatedCharges de tout le compte ou une expression SUM(METRICS()). Cette ligne n’est pas dessinée comme une barre à part entière. Un widget en devise à plusieurs barres en calcule lui-même le total.
• Secteurs : chaque secteur est dessiné ; la légende en liste autant qu’il en tient, puis « +N de plus ». Si le total dépasse la somme des secteurs, la différence forme un secteur gris Autres.
• Les légendes des graphiques linéaires et en aires empilées listent jusqu’à quatre séries sur les widgets moyens (moins avec les grandes tailles de texte) et quatre sur les grands, chacune avec sa dernière valeur, puis « +N de plus ». Les petits widgets n’ont pas de légende.
• Les tableaux et listes d’alarmes affichent autant de lignes qu’il en tient, puis « +N de plus ». Un tableau avec une ligne par période affiche les plus récentes, puis « +N plus tôt ».

Tailles

Chaque widget existe dans toutes les tailles. CloudPeek affiche un aperçu de chacune avant que vous l’ajoutiez. Sur Android, vous choisissez la taille d’un widget de l’écran d’accueil en le redimensionnant, et il affiche la mise en page adaptée à la place dont il dispose : petite à partir de 110 × 110 dp, moyenne à partir de 250 × 110 dp et grande à partir de 250 × 250 dp. Sur un écran d’accueil de quatre applications de large, cela correspond à 2 × 2, 4 × 2 et 4 × 4 cellules.

• Les petits widgets n’ont ni légende ni pied de widget. Un widget d’alarmes met en avant son résumé, par exemple « 1 en alarme ».
• Les widgets moyens et plus grands ajoutent un bouton d’actualisation, une légende et un pied de widget indiquant la fenêtre de temps et l’heure de mise à jour, par exemple « 3 dernières heures · Mis à jour 14:05 ». Les listes d’alarmes indiquent depuis combien de temps chaque alarme a changé.
• Les grands widgets ajoutent davantage de libellés d’axe. Le format très grand, sur iPad, reprend la mise en page du grand avec plus de place ; sur Android, chaque mise en page est dessinée pour occuper toute la place que vous lui donnez.
• Un widget à barres avec un Total cède l’une de ses places au Total sur les petits et moyens widgets.
• Le nombre de lignes qui tiennent dépend de votre taille de texte ; les suivantes sont comptées dans « +N de plus ».
• Sur iPhone, le mode En veille affiche les petits widgets, dessinés en plus grand sur fond noir, et le bureau d’un Mac affiche les petits, moyens et grands widgets de l’iPhone (voir En veille et Sur votre Mac).

Listes d’alarmes

Un widget d’alarmes liste les alarmes dans cet ordre, chacune avec son état :

• Pour chaque état, les alarmes gardent l’ordre dans lequel le widget les liste ou, avec "sortBy": "stateUpdatedTimestamp", le changement le plus récent vient en premier.
• Les widgets moyens et plus grands indiquent depuis combien de temps chaque alarme a changé d’état.
• Le résumé, sur les petits widgets et l’écran verrouillé, indique N en alarme en rouge quand une alarme est en alarme, Tout est OK en vert quand toutes sont à OK, Aucune donnée quand aucune n’a encore assez de données, et sinon N d’état inconnu, en comptant celles sans données ou introuvables.
• Le préréglage Résumé des alarmes compte plutôt les alarmes dans chaque état, par exemple « 2 en alarme, 4 données insuffisantes, 14 OK » : voir Préréglages.
• Un préréglage d’alarmes couvrant tous les comptes consacre une ligne à chaque compte, la plus grave en premier, avec le symbole de son état le plus grave, par exemple « prod : 2 en alarme » ; Alarmes liste en dessous les alarmes du compte qui ne sont pas à OK. Voir Alarmes de tous les comptes.

Écran verrouillé

Les widgets de l’écran verrouillé, sur iPhone et iPad, affichent une seule valeur principale, lisible sans déverrouiller. Les téléphones Android n’ont pas de widgets sur l’écran verrouillé.

• Rectangulaire : le titre, la valeur, et la série ou la barre dont elle provient (ou un avertissement si elle n’est pas à jour).
• Circulaire : la valeur et une légende d’environ 8 caractères tirée du titre.
• En ligne, au-dessus de l’horloge : la valeur et le titre, coupé à des mots entiers sur environ 18 caractères.
• Seuils : une valeur qui dépasse le seuil d’avertissement ou d’alarme du widget est accompagnée du symbole de ce seuil, car l’écran verrouillé dessine en une seule couleur (voir Seuils d’avertissement et d’alarme).

Widgets Vue d’ensemble

Un widget Vue d’ensemble affiche deux à quatre de vos widgets sous forme de leur dernière valeur (voir Plusieurs valeurs dans un widget) : deux sur un petit widget, quatre sur les moyens et plus grands et, sur iPhone et iPad, le premier sur l’écran verrouillé.

• La valeur est la valeur principale de chaque widget sur l’écran verrouillé, indiquée dans le tableau ci-dessus. Un widget d’alarmes, y compris le préréglage Résumé des alarmes, affiche son résumé, par exemple « 1 en alarme » en rouge avec un triangle rouge, « Tout est OK » en vert avec une coche verte, ou « Aucune alarme » quand il n’en a aucune. Un widget d’alarmes couvrant tous les comptes affiche plutôt la ligne de son compte le plus grave qui demande votre attention, par exemple « prod : 2 en alarme » ou « dev : connectez-vous pour actualiser », pour qu’un compte illisible ne soit pas masqué par le « Tout est OK » des autres.
• Seuils : une valeur qui dépasse le seuil d’avertissement de son widget s’affiche en orange avec un « ! » cerclé, et au-delà du seuil d’alarme en rouge avec un triangle, comme dans le widget lui-même (voir Seuils d’avertissement et d’alarme). C’est la valeur affichée qui est mesurée ; un total de barres, qui ne l’est pas, prend le pire seuil dépassé par l’une de ses barres.
• La tendance, une flèche et un pourcentage comme « +12 % », indique l’évolution de la valeur depuis le point précédent : pour un nombre quand son widget affiche une tendance, une jauge, et un graphique linéaire ou en aires empilées. Les barres, secteurs, tableaux, alarmes et graphiques dessinés en colonnes n’en ont pas : une colonne correspond généralement à une période encore en cours, comme les dépenses du jour jusqu’ici.
• Les widgets de texte n’ont pas de valeur : un widget Vue d’ensemble ne les propose donc pas.
• Un widget qui n’a pas pu s’actualiser garde sa dernière valeur et indique pourquoi à la place de sa tendance, en orange : « Connectez-vous pour actualiser », « Compte non ajouté » ou « Pas à jour depuis 14:05 » ; s’il n’a aucune valeur à garder, « Accès refusé », « AWS injoignable », etc. Les données de plus d’un jour sont estompées.

Paramètres de tableau de bord utilisés par CloudPeek

CloudPeek lit le JSON du tableau de bord et l’interroge comme le fait la console CloudWatch. Les préréglages et les widgets IA sont écrits dans le même JSON : tout ceci s’applique donc aussi à eux.

Pris en charge

• Métriques : lignes de métriques avec les raccourcis "." et "..." ; expressions de calculs de métriques, SEARCH et Metrics Insights (SELECT … FROM SCHEMA(…)) ; "visible": false pour les entrées à ne pas dessiner.
• Par métrique : id, label (y compris les libellés dynamiques comme ${PROP('Dim.ServiceName')} et ${LAST}), color, stat, period, region, accountId et yAxis.
• Par widget : title, view, stacked, stat (Average s’il n’est pas défini), period, region, accountId, start, end, setPeriodToTimeRange, sparkline, trend, min et max de l’axe Y de chaque côté, annotations horizontales (valeur, couleur, axe et visible), et "legend": {"position": "hidden"}.
• Axe Y de droite : les métriques avec "yAxis": "right" sont dessinées sur leur propre échelle, graduée à droite.
• Par tableau de bord : start, end et periodOverride.
• Widgets d’alarmes : alarms et sortBy.

Non utilisés

• Les libellés d’annotation et les libellés de l’axe Y (les lignes et les limites sont dessinées, sans leur texte), les bandes d’annotation (seul leur premier bord est dessiné) et les annotations verticales.
• Les positions de légende autres que masquée, liveData, singleValueFullPrecision et les options de synthèse des tableaux.
• Les variables de tableau de bord : les widgets utilisent les valeurs enregistrées dans le tableau de bord.

Plage de temps et période

• Plage de temps : le start du widget s’il en a un, sinon celui du tableau de bord, sinon les 3 dernières heures. Les plages relatives comme -PT3H ou -P7D et les horodatages absolus fonctionnent tous deux. Chaque widget affiche la fenêtre qu’il couvre, par exemple « 3 dernières heures ».
• Période : la period de la métrique, sinon celle du widget, sinon 5 minutes. Comme la console, CloudPeek l’augmente quand la plage nécessiterait trop de points (plus de 300, ou 1 440 avec "periodOverride": "inherit"), par paliers de 1 minute, 5 minutes, 15 minutes, 1 heure, 3 heures, 6 heures, 1 jour, 1 semaine et 30 jours.
• Les données plus anciennes ont une résolution moins fine dans CloudWatch : les plages commençant il y a plus de 15 jours utilisent donc des périodes d’au moins 5 minutes, et celles commençant il y a plus de 63 jours, des périodes d’au moins 1 heure.
• setPeriodToTimeRange fait utiliser aux widgets de type nombre, jauge, barres, secteurs et tableau une seule période pour toute la plage, comme dans la console.

Affichage des valeurs

• Les nombres ont trois chiffres significatifs, avec K, M, B et T pour les milliers, millions, milliards et billions : 1.23K, 45.6M. Une valeur que trois chiffres arrondiraient à un nombre rond trompeur en garde davantage : ainsi, 99,96 ne s’affiche pas comme 100. Les unités CloudWatch ne sont pas affichées : indiquez donc l’unité dans le libellé, par exemple « Latence (s) ».
• Devise : quand toutes les métriques d’un widget sont des EstimatedCharges de AWS/Billing dans la même devise, les valeurs s’affichent comme des montants : avec les centimes en dessous de 100, en montants entiers jusqu’à 10 000, puis en format compact, par exemple $12.3K. Un SEARCH sur AWS/Billing qui ne précise pas de Currency s’affiche en dollars américains, la seule devise dans laquelle AWS publie les frais.
• Les noms de services des widgets de facturation sont raccourcis : AmazonEC2 devient EC2 et AWSLambda devient Lambda.
• Libellés : une métrique sans libellé prend le nom de la métrique, ou des valeurs de dimension qui la distinguent des autres métriques du widget.
• Les tendances des nombres comparent le dernier point de données au précédent.
• Couleurs : votre color sur chaque métrique, sinon la palette par défaut de CloudWatch.
• Seuils d’avertissement et d’alarme : la dernière valeur d’un nombre, d’une jauge, d’une barre ou d’un graphique qui dépasse un seuil défini dans CloudPeek s’affiche en orange ou en rouge, avec un symbole (voir Seuils d’avertissement et d’alarme). CloudPeek écrit ses seuils dans le widget sous forme d’annotations horizontales marquées "cloudPeekLevel", que les graphiques dessinent en lignes pointillées. Les annotations propres à votre tableau de bord sont aussi dessinées en lignes, mais ne colorent jamais une valeur.

Comptes, régions et limites

• Régions : chaque métrique utilise sa propre region, sinon celle du widget, sinon la région par défaut du compte dans CloudPeek. Un même widget peut mélanger plusieurs régions ; CloudPeek interroge chacune en parallèle.
• Comptes : chaque widget s’actualise avec le compte pour lequel il a été créé. Pour afficher les métriques d’un autre compte dans un widget, utilisez accountId sur la métrique avec l’observabilité entre comptes CloudWatch, ou ajoutez ce compte à CloudPeek et créez le widget pour lui.
• Les alarmes sont recherchées dans le compte pour lequel le widget a été créé, dans la région de chaque ARN. Les préréglages d’alarmes lisent jusqu’à 1 000 alarmes dans la région où ils ont été ajoutés (uniquement celles dont le nom commence par le texte choisi sous Afficher, s’il y en a un) ; au-delà, ce sont celles à l’état ALARM qui sont conservées.
• Taille : un widget peut demander jusqu’à 500 métriques par région à la fois, et conserve jusqu’à 400 points par ligne. Les graphiques dessinent au plus 30 séries : un graphique linéaire affiche les 30 aux valeurs les plus élevées, et un graphique empilé regroupe le reste dans Autres.

Widgets de texte

Les widgets de texte sont pratiques pour une note de runbook à côté des graphiques. CloudPeek affiche :

• Le gras, l’italique, le code et les liens.
• Les titres, sous forme de lignes en gras.
• Les listes à puces (*, - ou +), sous forme de puces.
• Les boutons de CloudWatch, [button:Label](https://…), sous forme de simples liens.

Les lignes horizontales sont omises, et les suites de lignes vides sont réduites. Mieux vaut réserver les tableaux, les images et les blocs de code au tableau de bord dans la console. Un widget de texte sans titre prend le nom de sa première ligne.