Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Structure et syntaxe du corps du tableau de bord
Table des matières
Structure globale
A DashboardBody est une chaîne au format JSON. Il peut inclure un tableau de 0 à 500 objets de widget, ainsi que quelques autres paramètres. Le tableau de bord doit inclure un widgets tableau, mais celui-ci peut être vide.
Voici un exemple de cette structure avec un widget métrique et un widget texte, une plage de temps commençant six heures avant l'heure actuelle et le réglage de période de chaque graphique étant toujours respecté.
{ "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" } } ] }
L'exemple suivant affiche trois mesures Lambda par fonction et utilise une variable de tableau de bord afin que les utilisateurs du tableau de bord puissent basculer entre différents noms de fonctions Lambda et voir les trois mesures pour chaque fonction. Cela vous permet de créer un tableau de bord flexible unique qui peut afficher les indicateurs clés pour différentes ressources. Dans cet exemple, les fonctions sont découvertes par une requête de recherche métrique, de sorte que le tableau de bord découvre automatiquement les nouvelles fonctions Lambda lors de leur création.
{ "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" }] }
L'exemple suivant comporte deux widgets. La première inclut deux mesures et une expression mathématique qui fait la somme de leur total. Le second widget est une expression de recherche qui affiche le CPUUtilization pour toutes les instances EC2 de la région.
{ "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" } } ] }
Le reste de cette section comprend des exemples illustrant chaque partie de la DashboardBody syntaxe. Pour plus d'exemples illustrant la syntaxe complète des commandes, consultez PutDashboard le manuel Amazon CloudWatch API Reference.
Le niveau supérieur de l'objet JSON peut inclure les propriétés suivantes.
- gadget
-
La liste des widgets du tableau de bord. Pour de plus amples informations, veuillez consulter Structure du tableau de widgets.
Obligatoire : oui
- variables
-
Tableau d'objets variables de tableau de bord utilisés dans le tableau de bord. Pour plus d'informations sur les champs que vous pouvez utiliser dans chaque objet variable de tableau de bord, consultezStructure du tableau de variables.
Pour plus d'informations sur les variables de tableau de bord, voir Création de tableaux de bord flexibles avec des variables de tableau de bord.
Si vous incluez un
variablestableau, celui-ci peut contenir entre 0 et 25 objets variables.Obligatoire : non
- end
-
Fin de la plage horaire à utiliser pour chaque widget du tableau de bord lors du chargement du tableau de bord. Si vous spécifiez une valeur pour
end, vous devez également en spécifier une pourstart. Pour chacune de ces valeurs, spécifiez une heure absolue au format ISO 8601. Par exemple,2018-12-17T06:00:00.000Z.Type : chaîne
Obligatoire : non
- démarrer
-
Début de la plage horaire à utiliser pour chaque widget du tableau de bord.
Vous pouvez spécifier
startsansendspécifier une plage de temps relative qui se termine par l'heure actuelle. Dans ce cas, la valeur destartdoit commencer par-PTsi vous spécifiez une plage de temps en minutes ou en heures, et doit commencer par-Psi vous spécifiez une plage de temps en jours, semaines ou mois. Vous pouvez ensuite utiliser M, H, D, W et M comme abréviations pour les minutes, les heures, les jours, les semaines et les mois. Par exemple,-PT5Maffiche les 5 dernières minutes,-PT8Hles 8 dernières heures et-P3Mles trois derniers mois.Vous pouvez également l'utiliser
startavec unendchamp pour spécifier une plage de temps absolue. Lorsque vous spécifiez une plage de temps absolue, utilisez le format ISO 8601. Par exemple,2018-12-17T06:00:00.000Z.Si vous omettez
start, le tableau de bord affiche la plage horaire par défaut lors du chargement.Type : chaîne
Obligatoire : non
- Période dérogatoire
-
Utilisez ce champ pour spécifier la période des graphiques lorsque le tableau de bord se charge. En
autospécifiant, la période de tous les graphiques du tableau de bord s'adapte automatiquement à la plage horaire du tableau de bord. La spécificationinheritgarantit que la période définie pour chaque graphique est toujours respectée.Valeurs valides : auto | inherit
Type : chaîne
Obligatoire : non
Structure du tableau de widgets
Chaque widget, quel que soit son type, peut avoir les propriétés suivantes.
- type
-
Type de widget.
Valeurs Valides:
metric|text|log|alarm|explorer|chartType : Chaîne
Obligatoire : oui
- x
-
Position horizontale du widget sur la grille de 24 colonnes du tableau de bord. La position par défaut est la prochaine position disponible.
Valeurs valides : 0—23
Type : Integer
Obligatoire : Oui, si cela
yest spécifié. Sinon, ce n'est pas obligatoire. - y
-
Position verticale du widget sur la grille de 24 colonnes du tableau de bord. La position par défaut est la prochaine position disponible.
Valeurs valides : n'importe quel entier, égal ou supérieur à 0.
Type : Integer
Obligatoire : Oui, si cela
xest spécifié. Sinon, ce n'est pas obligatoire. - width
-
Largeur du widget en unités de grille (dans une grille de 24 colonnes). La valeur par défaut est 6.
Valeurs valides : 1 à 24
Type : Integer
Obligatoire : non
- height
-
Hauteur du widget en unités de grille. La valeur par défaut est 6.
Valeurs valides : 1 à 1000
Type : Integer
Obligatoire : non
- propriétés
-
Les propriétés détaillées du widget, qui diffèrent selon le type de widget. Pour plus d'informations sur le format de
properties, consultez Propriétés d'un objet de widget métriquePropriétés d'un objet de widget graphique, ouPropriétés d'un objet de widget de texte.Type : objet
Obligatoire : oui
Structure du tableau de variables
Chaque variable de tableau de bord du tableau peut avoir les propriétés suivantes.
- type
-
Type de variable de tableau de bord. CloudWatch prend en charge deux types, les variables de propriété et les variables de modèle.
Les variables de propriété modifient les valeurs de toutes les instances d'une propriété dans tous les widgets du tableau de bord. Une propriété peut être l'une des suivantes :
Toute propriété JSON figurant dans les définitions du widget, telle que
region.N'importe quel nom de dimension pour une métrique, tel que
InstanceIdouFunctionName.
Une variable de modèle modifie un modèle d'expression régulière dans le JSON du tableau de bord. Utilisez-le lorsque vous devez modifier une partie de la valeur d'une propriété JSON, ou même une propriété JSON.
Les variables de propriété s'appliquent à la plupart des cas d'utilisation et sont moins complexes à configurer.
Valeurs valides :
property|patternType : Chaîne
Obligatoire : oui
- inputType
-
Détermine la manière dont l'utilisateur du tableau de bord saisit la valeur de la variable.
Spécifiez
inputd'utiliser une zone de texte dans laquelle l'utilisateur peut saisir des valeurs.Spécifiez
selectd'utiliser un ensemble déroulant de valeurs que vous définissez ou une liste déroulante de valeurs trouvées par une requête de recherche métrique.Spécifiez
radiod'utiliser un ensemble de boutons radio, avec des valeurs que vous définissez ou que vous trouvez à l'aide d'une requête de recherche métrique.
Valeurs valides :
input|select|radioType : Chaîne
Obligatoire : oui
- values
-
Si
inputTypec'est le casselectouradioet que vous souhaitez définir les valeurs de variables possibles au lieu d'utiliser une recherche par requête métrique, spécifiez ces valeurs ici.valuesest un tableau dans lequel chaque objet du tableau contient une valeur obligatoire et une étiquette facultative. Chaque valeur peut être une chaîne, un nombre ou un booléen, et chaque étiquette doit être une chaîne. Chacune de ces valeurs et étiquettes peut comporter jusqu'à 255 caractères.Si vous spécifiez un
valuestableau, il doit inclure au moins un élément et peut en inclure jusqu'à 500.Par exemple, ce qui suit crée une liste de trois régions possibles à utiliser comme valeurs pour une variable.
"values": [ { "label": "US East (IAD)", "value": "us-east-1" }, { "label": "US West (SFO)", "value": "us-west-1" }, { "label": "EU (DUB)", "value": "eu-west-1" } ]Type : Array
Obligatoire : Oui si
inputTypec'est le casselectouradiosi vous n'utilisez pas de requête de recherche métrique pour renseigner les valeurs. - id
-
Un identifiant pour cette variable. Il peut contenir jusqu'à 32 caractères, et les caractères valides sont
0-9A-Za-z-_Type : Chaîne
Obligatoire : oui
- étiquette
-
Une étiquette à afficher pour le champ de saisie. Il peut comporter jusqu'à 30 caractères.
Si vous omettez ce champ pour une variable de propriété, le nom de la propriété s'affiche sous forme d'étiquette. Si vous l'omettez pour une variable de modèle, il
est utilisé pour l'étiquette.pattern_1,pattern_2, ...Type : chaîne
Obligatoire : non
- defaultValue
-
La valeur par défaut de la variable, lors de la première ouverture du tableau de bord.
Si
inputTypec'est le casinput, vous le spécifiezdefaultValueici manuellement et utilisez jusqu'à 255 caractèresSi
inputTypec'est le casselectouradio, vous devez spécifier une valeur possible valide que vous avez spécifiée dans levaluestableau ou qui a été extraite lors de la recherche par requête métrique.
Valeurs valides : toute valeur valide pour cette variable
Type : chaîne, nombre ou booléen, selon la valeur de type de cette variable
Obligatoire : non
- search
-
Spécifiez ce champ pour renseigner votre champ
selectou votre champ deradiosaisie à l'aide d'une expression de recherche métrique. Pour la valeur de ce champ, spécifiez un espace de noms, un nom de dimension et un nom de métrique. La dimension que vous spécifiez doit être valide pour cette métrique. CloudWatch recherche toutes les ressources qui publient cette métrique et cette dimension, et en remplit la liste.Par exemple, spécifiez
"search": "{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\""de rechercher des instances Amazon EC2 dans le compte, ou spécifiez de"search": "{AWS/Lambda,FunctionName} MetricName=\"Duration\"",renvoyer les fonctions Lambda dans le compteLa
searchchaîne que vous spécifiez peut contenir jusqu'à 2 048 caractères.Note
Si vous utilisez une expression de recherche et que vous souhaitez également spécifier une valeur par défaut, la valeur par défaut que vous spécifiez
defaultValueest utilisée tant que cette valeur par défaut correspond à l'une des ressources extraites par la recherche. Lorsque vous utilisez une expression de recherche pour renseigner votre champ de saisie, vous pouvez également spécifier la valeur spéciale__FIRSTpourdefaultValue, pour que la valeur par défaut soit la première valeur renvoyée par la recherche. (La valeur spéciale comprend deux traits de soulignement, puis le PREMIER) Les valeurs renvoyées par la recherche sont toujours triées par ordre alphabétique.Type : Chaîne
Obligatoire : Oui si
inputTypec'est le casselectouradiosi vous ne le spécifiez pasvalues. - Remplir à partir de
-
Si vous utilisez le
searchchamp pour renseigner votre champ de saisie à l'aide d'une expression de recherche, spécifiez ce champ avec le nom d'une dimension que la recherche récupérera.Par exemple, si votre
searchvaleur est"search": "{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\"", vous pouvez spécifierInstanceIdpourpopulateFrom.Type : Chaîne
Obligatoire : Oui si
inputTypec'est le casselectouradiosi vous ne le spécifiez pasvalues. - visible
-
Spécifie si l'étiquette et le champ de saisie sont visibles sur le tableau de bord. Si vous ne spécifiez pas ce paramètre, la valeur par défaut
trueest utilisée.L'utilisation
falsepermet de gagner de la place sur le tableau de bord, mais oblige l'utilisateur à modifier l'URL du tableau de bord pour modifier les valeurs des variables.Type : booléen
Obligatoire : non
Exemples de variables
L'exemple suivant utilise une variable de propriété pour modifier la région de tous les widgets à l'aide d'un champ de saisie de texte. Lorsque le tableau de bord est ouvert pour la première fois, la valeur par défaut de us-east-1 est utilisée pour la variable.
"variables": [ { "type": "property", "property": "region", "inputType": "input", "id": "region", "label": "Region", "defaultValue": "us-east-1", "visible": true } ],
L'exemple suivant utilise une variable de modèle pour modifier la région de tous les widgets, dans le cas où la région est parfois définie au milieu d'une chaîne telle qu'un ARN.
"variables": [ { "type": "pattern", "pattern": "us-east-1", "inputType": "input", "id": "region", "label": "Region", "defaultValue": "us-east-1", "visible": true } ],
L'exemple suivant génère une variable de fonction Lambda, avec un bouton radio pour chaque fonction. Les fonctions sont découvertes par une recherche par requête métrique.
"variables": [ { "type": "pattern", "pattern": "originalFuncNameInDashboard", "inputType": "radio", "id": "functionName", "label": "Function", "visible": true, "search": "{AWS/Lambda,FunctionName} MetricName=\"Duration\"", "populateFrom": "FunctionName", "defaultValue": "__FIRST" } ],
L'exemple suivant montre comment spécifier plusieurs variables dans un tableau de bord et présente plusieurs types de variables.
"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" } ] } ]
Propriétés d'un objet de widget de texte
Un widget de type text peut avoir un ou deux paramètres dans la properties section. Le markdown champ est obligatoire et le transparent champ est facultatif.
Pour plus d'informations sur le style de démarquage pris en charge dans les widgets de CloudWatch texte, voir Utilisation du Markdown dans la console.
- démarquage
-
Le texte à afficher par le widget. Utilisez ce paramètre uniquement pour les widgets de texte.
Type : Chaîne
Obligatoire : Oui (lorsque le widget l'
typeesttext). - contexte
-
Spécifie si le widget de texte possède un arrière-plan uni ou transparent. La valeur
transparentrend le widget transparent. La valeursolidest la valeur par défaut.Type : chaîne
Obligatoire : non
{ "widgets":[ { "type":"text", "x":0, "y":7, "width":3, "height":3, "properties":{ "markdown":"Hello world", "background": "transparent" } } ] }
Propriétés d'un objet Log Widget
Un widget de type log représente les résultats d'une requête CloudWatch Logs Insights. Pour plus d'informations, consultez la section Analyse des données des CloudWatch journaux avec Logs Insights.
Un log widget peut inclure les champs suivants dans son properties champ.
- accountId
-
L'identifiant du AWS compte contenant les journaux, s'il s'agit d'une requête intercomptes.
Type : chaîne
Obligatoire : non
- region
-
La région de la requête des journaux.
Type : Chaîne
Obligatoire : oui
- title
-
Le texte du titre à afficher par le widget.
Type : chaîne
Obligatoire : non
- query
-
Contient la fonction de requête CloudWatch Logs Insights.
Type : Chaîne
Obligatoire : Oui (lorsque le widget l'
typeestlog).La
querychaîne commence par les noms des groupes de journaux qui doivent être interrogés. Vous devez ajouter au préalable le nom de chaque groupe de journaux.SOURCESéparez plusieurs groupes de journaux par un caractère pipe (|).Ajoutez un autre caractère de canal après la liste des groupes de journaux, puis spécifiez la syntaxe de la requête. Séparez chaque ligne de la syntaxe de requête par
\n|Par exemple, la ligne suivante représente une requête de deux groupes de journaux,
service_log1etservice_log2. La requête affiche les canaris présentant des défauts."query": "SOURCE 'service_log1' | SOURCE 'service_log2' |filter Fault > 0\n| fields Fault.Message\n| stats count(*) by Canary.Name, Fault.Message" - afficher
-
Spécifie la manière dont les résultats de la requête sont affichés. Spécifiez
tablesi vous souhaitez afficher les résultats sous forme de tableau. SpécifieztimeSeriesd'afficher cette métrique sous forme de graphique linéaire. Spécifiezbarde l'afficher sous forme de graphique à barres. Spécifiezpiede l'afficher sous forme de graphique circulaire.Si vous omettez ce paramètre, les résultats sont affichés sous forme de tableau.
Type : Chaîne
Obligatoire : Non (lorsque le widget l'
typeestlog).
{ "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" } } ] }
Propriétés d'un objet de widget métrique
Un widget de type metric peut contenir les champs suivants properties :
- accountId
-
Spécifie l'identifiant du AWS compte d'où proviendront toutes les mesures de ce widget. Cela est utile pour les tableaux de bord multicomptes qui incluent des widgets provenant de plusieurs comptes. Pour plus d'informations, consultez Console Cross-Account Cross-Region CloudWatch .
Si vous omettez cette option, le compte courant est utilisé par défaut. Utilisez ce paramètre uniquement pour les widgets métriques.
Vous pouvez également utiliser un
accountIdchamp dans chaque métrique du tableaumetricspour créer un widget unique qui inclut des mesures provenant de plusieurs comptes.Type : chaîne
Obligatoire : non
- annotations
-
Pour inclure une alarme ou une annotation dans le widget, spécifiez un
annotationstableau. Pour plus d'informations sur le format, consultezObjet du widget de tableau de bord : propriétés d'annotation. Utilisez ce paramètre uniquement pour les widgets métriques.Type : objet
Obligatoire : une annotation d'alarme est requise uniquement lorsque le widget
typeest spécifiémetricet n'metricsest pas spécifié. Aucune annotation horizontale ou verticale n'est requise. - Données en direct
-
Spécifiez
truepour afficher les données en direct dans le widget. Les données en direct sont des données publiées au cours de la dernière minute et qui n'ont pas été entièrement agrégées. Pour plus d'informations, voir Utiliser les données en temps réel.Type : booléen
Obligatoire : non
- légende
-
Spécifiez
legendpour déterminer où s'affiche la légende des lignes du graphique. Lelegendchamp contient un autre champ appeléposition. Les valeurs possibles pourpositionsontrightbottom, ethidden.Par exemple, ce qui suit fait apparaître la légende sur la droite du graphique.
"legend": { "position": "right" }Type : objet
Obligatoire : non
- metrics
-
Spécifiez un
metricstableau pour inclure une ou plusieurs métriques (sans alarmes), une requête Metrics Insights, des expressions mathématiques ou des expressions de recherche. Unmetricstableau peut inclure de 0 à 500 métriques et expressions. Utilisez ce paramètre uniquement pour les widgets métriques. Pour plus d'informations sur le format demetrics, consultezWidget métrique : format pour chaque métrique du tableau.Un tableau de métriques ne peut inclure qu'une seule requête Metrics Insights.
Un seul
expressionchamp ne peut pas inclure à la fois une requête Metrics Insights et une expression mathématique. Vous pouvez toutefois utiliser les résultats renvoyés par une requête Metrics Insights à partir d'une expression comme entrée dans une expression mathématique d'une autre expression du tableau.Type : Tableau de tableaux
Obligatoire : Oui, lorsque le widget
typeest spécifiémetricet n'annotationsest pas spécifié. - point
-
Période par défaut, en secondes, pour toutes les mesures de ce widget. La période est la durée représentée par un point de données sur le graphique. Cette valeur par défaut peut être modifiée dans chaque définition de métrique. Utilisez ce paramètre uniquement pour les widgets métriques. La valeur par défaut est 300.
Valeurs valides : Tout multiple de 60, 60 étant le minimum.
Type : Integer
Obligatoire : non
- region
-
La région de la métrique.
Type : Chaîne
Obligatoire : oui
- sparkline
-
Spécifiez
truepour afficher la fonction sparkline sous le widget numérique. Spécifiezfalsed'afficher le widget numérique lui-même. Ce paramètre est ignoré si la vue ne l'est passingleValue. Utilisez ce paramètre uniquement pour les widgets métriques.Type : booléen
Obligatoire : non
- empilé
-
Spécifiez
trued'afficher le graphique sous la forme d'une ligne empilée oufalsede l'afficher sous forme de lignes séparées. Ce paramètre est ignoré s'ilviewest définisingleValue. Utilisez ce paramètre uniquement pour les widgets métriques.Type : booléen
Obligatoire : non
- stat
-
La statistique par défaut à afficher pour chaque métrique du tableau. Cette valeur par défaut peut être modifiée dans la définition de chaque métrique individuelle du
metricstableau. Utilisez ce paramètre uniquement pour les widgets métriques.Valeurs Valides:
SampleCount|Average|Sum|Minimum|Maximum|p??Type : chaîne qui est une CloudWatch statistique valide.
Obligatoire : non
- table
-
Incluez une
tablesection pour inclure les modifications liées à la table de données dans le widget. Pour plus d'informations sur le format, consultezObjet du widget de tableau de bord : propriétés du tableau.Type : objet
Obligatoire : non
- timezone
-
Fuseau horaire à utiliser pour afficher les heures dans le graphique. Le format est + ou - suivi de quatre chiffres. Les deux premiers chiffres indiquent le nombre d'heures en avance ou en retard par rapport à l'UTC, et les deux derniers chiffres sont le nombre de minutes. Par exemple,
+0130indique une heure et 30 minutes en avance sur l'UTC. La valeur par défaut est+0000.Type : chaîne
Obligatoire : non
- title
-
Titre à afficher pour le graphique ou le numéro. Utilisez ce paramètre uniquement pour les widgets métriques.
Type : chaîne
Obligatoire : non
- afficher
-
Spécifiez
timeSeriesd'afficher cette métrique sous forme de graphique linéaire ou à aires empilées. SpécifiezsingleValued'afficher cette métrique sous forme de graphique numérique. Spécifiezgauged'afficher cette métrique sous forme de graphique de jauge. Spécifiezbard'afficher cette métrique sous forme de graphique à barres. Spécifiezpied'afficher cette métrique sous forme de graphique circulaire.Note
Si vous spécifiez
gauge, vous devez définir une valeur pourminetmaxsur le côté gauche deyAxis.Valeurs Valides:
timeSeries|singleValue|gauge|bar|pie|tableType : chaîne
Obligatoire : non
- Axe Y
-
Les valeurs minimale et maximale pour les côtés gauche et droit d'un graphique Y-axis. Cette propriété s'applique à toutes les mesures représentées sous forme de graphique, à l'exception des mesures spécifiques qui remplacent ce paramètre. Pour de plus amples informations, veuillez consulter Objet du widget de tableau de bord : format des propriétés de l'axe Y.
Type : objet YAxis
Obligatoire : non
Exemple : widgets de zone empilée et de jauge
{ "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, } } } }
Widget métrique : format pour chaque métrique du tableau
Chaque élément du metrics tableau est soit une métrique unique, soit une expression mathématique ou une expression de recherche. Chaque métrique du metrics tableau a le format suivant :
[Namespace,MetricName, [{DimensionName,DimensionValue}...] {Rendering Properties Object} ]
Chaque expression du metrics tableau est au format suivant :
[ {"expression" : "expression", ["label" : "label"] , ["id" : "id"] } ]
- accountId
-
Spécifie l'ID de AWS compte d'où provient cette métrique. Cela vous permet de créer un widget contenant des statistiques provenant de plusieurs comptes sur un tableau de bord multicompte. Pour plus d'informations, consultez Console Cross-Account Cross-Region CloudWatch .
Si vous omettez cette option, le compte courant est utilisé par défaut. Utilisez ce paramètre uniquement pour les widgets métriques.
Type : chaîne
Obligatoire : non
- Namespace
-
L' AWS espace de noms contenant la métrique. Si le
metricstableau contient plusieurs entrées, pour chacune d'elles après la première, vous pouvez spécifier uniquement d'"."utiliser le même espace de noms que la métrique précédente dans le tableau.Type : Chaîne
Obligatoire : oui
- MetricName
-
Le nom de la CloudWatch métrique. Si vous avez plusieurs entrées dans le
metricstableau, pour chacune d'elles après la première, vous pouvez spécifier"."d'utiliser uniquement le même nom de métrique que la métrique précédente dans le tableau.Type : Chaîne
Obligatoire : Oui, pour une seule métrique
- expression
-
La requête, l'expression mathématique ou l'expression de recherche Metrics Insights, s'il s'agit d'une expression au lieu d'une seule métrique.
Dans une expression de recherche utilisant des guillemets doubles pour obtenir une correspondance exacte, chaque guillemet double doit être remplacé par une barre oblique inverse.
Pour plus d'informations sur la syntaxe des requêtes Metrics Insights, consultez la section Composants et syntaxe des requêtes Metrics Insights.
Pour plus d'informations sur les expressions mathématiques ou les expressions de recherche, consultez la section Utilisation des mathématiques métriques ou Utilisation d'expressions de recherche dans les graphiques dans le Guide de CloudWatch l'utilisateur Amazon.
Type : Chaîne
Obligatoire : Oui, pour une expression
Exemple d'expression pour une requête Metrics Insights :
[ { "expression": "SELECT MAX(CPUUtilization) FROM SCHEMA(\"AWS/EC2\", InstanceId) GROUP BY InstanceId LIMIT 10", "label": "View the 10 max CPU Utilization", "id": "q1" } ] - DimensionName
-
Le nom d'une dimension permettant d'affiner davantage les données affichées. Si le
metricstableau contient plusieurs entrées, pour chacune d'elles après la première, vous pouvez spécifier uniquement"."d'utiliser le même nom de dimension que dans la dimension correspondante spécifiée dans la métrique précédente du tableau. Vous pouvez spécifier 0 dimensions pour une métrique, ou jusqu'à autant de dimensions que le support de la métrique.Type : chaîne
Obligatoire : non
- DimensionValue
-
La valeur à utiliser pour cette dimension pour la métrique. Obligatoire s'il existe un nom de dimension correspondant.
Type : chaîne
Obligatoire : non
- id
-
L'identifiant de cette série chronologique. Cet identifiant peut être utilisé dans le cadre d'une expression mathématique. L'identifiant doit commencer par une lettre minuscule.
Type : chaîne
Obligatoire : non
- étiquette
-
L'étiquette à afficher dans le graphique pour représenter cette série chronologique.
Type : chaîne
Obligatoire : non
- region
-
La région de la métrique. Utilisez ce paramètre uniquement pour les widgets métriques. Si vous omettez cette option, la région actuelle est utilisée par défaut.
Type : chaîne
Obligatoire : non
- Objet de propriétés de rendu
-
Spécifie les propriétés de rendu à utiliser pour cette métrique particulière, en remplaçant les valeurs spécifiées pour l'ensemble du widget. Pour plus d'informations sur le format, consultezObjet du widget de tableau de bord : format d'objet des propriétés de rendu.
Type : Objet de propriétés de rendu métrique
Obligatoire : non
// 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 theDiskReadBytesmetric 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 EC2CPUUtilizationfor each instance in the Region. [ { "expression": "SEARCH('{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\"', 'Average', 300)", "id": "e1" } ],
Rubriques
Objet du widget de tableau de bord : format d'objet des propriétés de rendu
Chaque métrique du metrics tableau peut éventuellement avoir des propriétés de rendu personnalisées qui remplacent les propriétés de rendu par défaut spécifiées dans le yAxis paramètre de l'widgetobjet. Cette section décrit le format de ces propriétés de rendu personnalisées par métrique.
- color
-
Code couleur hexadécimal HTML à six chiffres à utiliser pour cette métrique.
Type : chaîne
Obligatoire : non
- étiquette
-
L'étiquette à afficher pour cette métrique dans la légende du graphique. Si cela n'est pas spécifié, la métrique reçoit une étiquette générée automatiquement qui la distingue des autres mesures du widget.
Type : chaîne
Obligatoire : non
- point
-
Période pour cette métrique, en secondes. La période est la durée représentée par un point de données sur le graphique.
Valeurs valides : multiple de 60, avec un minimum de 60.
Type : Integer
Obligatoire : non
- stat
-
La statistique de cette métrique, si elle doit être différente de celle utilisée pour les autres mesures du tableau. Par défaut, CloudWatch utilise Average si vous ne spécifiez pas de statistique au niveau d'un tableau ou d'une métrique.
Valeurs Valides:
SampleCount|Average|Sum|Minimum|Maximum|p??Type : chaîne qui est une CloudWatch statistique valide.
Obligatoire : non
- visible
-
Définissez cette option
truepour que la métrique apparaisse dans le graphique oufalsepour qu'elle soit masquée. La valeur par défaut esttrue.Type : booléen
Obligatoire : non
- Axe Y
-
Où sur le graphique afficher l'axe Y pour cette métrique. La valeur par défaut est
left.Valeurs valides :
left|rightType : chaîne
Obligatoire : non
// 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"} ]
Objet du widget de tableau de bord : propriétés d'annotation
Les annotations incluent des alarmes, des annotations horizontales et des annotations verticales. Un seul widget de mesure peut avoir jusqu'à une alarme, ou il peut comporter une ou plusieurs annotations horizontales ou verticales. Un seul widget ne peut pas avoir à la fois une alarme et des annotations horizontales ou verticales.
Annotations d'alarme
Si vous spécifiez une annotation d'alarme, vous ne pouvez pas également spécifier un metrics tableau dans le même widget.
- alarmes
-
L'Amazon Resource Name (ARN) de l'alarme.
Type : tableau de chaînes. Il peut y avoir 0 à 1 chaînes dans le tableau.
Obligatoire : uniquement si aucune métrique n'est répertoriée.
"annotations": { "alarms": [ "arn1" ] }
Annotations horizontales
- horizontaux
-
Tableau d'annotations horizontales. Les annotations horizontales proposent plusieurs options pour l'ombrage de remplissage, notamment un ombrage au-dessus de la ligne d'annotation, un ombrage en dessous de la ligne d'annotation et un ombrage « en bande » qui apparaît entre deux lignes d'annotation liées dans le cadre d'une annotation à canal unique. Chaque annotation horizontale du tableau qui est une annotation unique, au lieu d'une annotation de bande, a le format suivant :
{value,label,color,fill,yAxis,visible}Chaque annotation horizontale qui est une annotation de bande a le format suivant :
[ {value,label,color,yAxis,visible}, {value,label} ]
- value
-
Valeur métrique du graphique où la ligne d'annotation horizontale doit apparaître. Dans une annotation d'ombrage de bande, les deux valeurs de Value définissent les bords supérieur et inférieur de la bande.
Sur un graphique comportant des annotations horizontales, le graphique est mis à l'échelle de sorte que toutes les annotations horizontales visibles apparaissent sur le graphique.
Type : Float
Obligatoire : oui
- étiquette
-
Chaîne qui apparaît sur le graphique à côté de l'annotation.
Type : chaîne
Obligatoire : non
- color
-
Code couleur hexadécimal HTML à six chiffres à utiliser pour l'annotation. Cette couleur est utilisée à la fois pour la ligne d'annotation et pour l'ombrage de remplissage.
Type : chaîne
Obligatoire : non
- remplir
-
Comment utiliser l'ombrage de remplissage avec l'annotation. Les valeurs valides concernent
abovel'ombrage au-dessus de l'annotation, l'belowombrage en dessous de l'annotation et l'absence d'noneombrage. S'ilfillest omis, il n'y a pas d'ombrage.L'exception est une annotation avec ombrage en bande. Ces annotations comportent toujours un ombrage entre les deux valeurs, et toute valeur pour
fillest ignorée.Type : chaîne
Obligatoire : non
- visible
-
Définissez cette option
truepour que l'annotation apparaisse dans le graphique oufalsepour qu'elle soit masquée. La valeur par défaut esttrue.Type : booléen
Obligatoire : non
- Axe Y
-
Si le graphique inclut plusieurs métriques, spécifie si les nombres indiqués
Valuese réfèrent à la métrique associée à la gauche Y-axis ou à la droite Y-axis,. Les valeurs valides sontrightetleft.Type : chaîne
Obligatoire : non
// 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 } ] }
Annotations verticales
- vertical
-
Tableau d'annotations verticales. Pour chaque annotation verticale, vous pouvez choisir d'appliquer un ombrage de remplissage avant l'annotation, après celle-ci ou entre deux lignes verticales reliées en tant qu'annotation à canal unique. Chaque annotation verticale du tableau qui est une annotation unique, au lieu d'une annotation de bande, a le format suivant :
{value,label,color,fill,visible}Chaque annotation verticale qui est une annotation de bande a le format suivant :
[ {value,label,color,visible}, {value,label} ]
- value
-
Date et heure du graphique où la ligne d'annotation verticale doit apparaître. Dans une annotation d'ombrage de bande, les deux valeurs de Value définissent les bords de début et de fin de la bande.
Sur un graphique comportant des annotations verticales, le graphique est mis à l'échelle de sorte que toutes les annotations verticales visibles apparaissent sur le graphique.
Elle est définie comme une chaîne au format ISO 8601. Pour plus d'informations, consultez ISO 8601
. Type : Chaîne
Obligatoire : oui
- étiquette
-
Chaîne qui apparaît sur le graphique à côté de l'annotation.
Type : chaîne
Obligatoire : non
- color
-
Code couleur hexadécimal HTML à six chiffres à utiliser pour l'annotation. Cette couleur est utilisée à la fois pour la ligne d'annotation et pour l'ombrage de remplissage.
Type : chaîne
Obligatoire : non
- remplir
-
Comment utiliser l'ombrage de remplissage avec l'annotation. Les valeurs valides concernent
beforel'ombrage avant l'annotation, l'afterombrage après l'annotation et l'absence d'noneombrage. S'ilfillest omis, il n'y a pas d'ombrage.L'exception est une annotation avec ombrage en bande. Ces annotations comportent toujours un ombrage entre les deux valeurs, et toute valeur pour
fillest ignorée.Type : chaîne
Obligatoire : non
- visible
-
Définissez cette option
truepour que l'annotation apparaisse dans le graphique oufalsepour qu'elle soit masquée. La valeur par défaut esttrue.Type : booléen
Obligatoire : non
// 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" } ] ] }
Objet du widget de tableau de bord : format des propriétés de l'axe Y
Définit les paramètres Y-axis du graphique. Les paramètres incluent le maximum et le minimum, une étiquette pour l'axe et si l'axe affiche les unités. Définissez cette option dans l'widgetobjet pour affecter toutes les mesures du widget. Pour modifier les paramètres du widget pour une métrique particulière, définissez-la pour la métrique du metrics tableau.
{ left: { min: 0, max: 100 }, right: { min: 0 } }
- gauche
-
Réglages optionnels pour la gauche Y-axis.
Type : objet YAxis
Obligatoire : non
- droite
-
Paramètres optionnels pour la droite Y-axis.
Type : objet YAxis
Obligatoire : non
Chacun des right objets left et peut inclure les paramètres suivants :
- étiquette
-
Un label pour cela Y-axis
Type : chaîne
Obligatoire : non
- min
-
La valeur minimale pour cela Y-axis
Type : Float
Obligatoire : non
- max
-
La valeur maximale pour cela Y-axis
Type : Float
Obligatoire : non
- Afficher les unités
-
Détermine si les unités sont affichées pour la métrique associée à cet axe. Par défaut, la valeur est true.
Type : booléen
Obligatoire : non
Objet du widget de tableau de bord : propriétés du tableau
Si vous spécifiez un widget table de mesure, vous pouvez inclure des visualisations relatives à la visibilité des colonnes de résumé, des colonnes de points de données et à la disposition des tableaux. Ces propriétés ne s'appliquent que lorsque le type d'affichage du widget est défini table et ne modifient pas les autres types de vue s'ils sont inclus. La table propriété n'est pas obligatoire pour utiliser un widget de tableau.
- layout
-
Utilisez ce champ pour transformer le tableau de telle sorte que les points de données s'étendent verticalement ou horizontalement. La valeur par défaut est
horizontal.Valeurs valides :
vertical|horizontalType : chaîne
Obligatoire : non
- Résumé autocollant
-
Réglez cette option
truepour que les colonnes de résumé que vous incluez dans le tableau restent collantes, afin que vous puissiez explorer les colonnes de données tout en ayant toujours les colonnes de résumé dans votre fenêtre d'affichage. La valeur par défaut estfalse.L'étiquette du widget est toujours collante, quel que soit votre choix dans ce champ.
Valeurs valides :
true|falseType : booléen
Obligatoire : non
- montrer TimeSeriesData
-
Définissez cette option
falsesi vous souhaitez que seules les colonnes d'étiquette et de résumé soient affichées, en masquant les autres colonnes de données.La valeur par défaut est
true.Valeurs valides :
true|falseType : booléen
Obligatoire : non
- Colonnes récapitulatives
-
Les colonnes récapitulatives sont une nouvelle propriété introduite avec le widget de tableau. Ces colonnes constituent un sous-ensemble spécifique des résumés de votre tableau actuel. Par exemple, le
Sumrésumé est la somme de tous les points de données rendus dans sa ligne respective. Les colonnes récapitulatives n'ont pas le même concept que n'importe quelle statistique CloudWatch métrique.La valeur par défaut est
["MIN", "MAX","SUM", "AVG"].Valeurs Valides:
"MIN"|"MAX"|"SUM"|"AVG"Type : Array
Obligatoire : non
Par exemple, le code JSON suivant crée un tableau affichant le minimum et le maximum de chaque métrique du tableau.
"table": { "summaryColumns": ["MIN", "MAX"], "layout": "vertical", "stickySummary": true, "showTimeSeriesData": false, },
Propriétés d'un objet de widget Metrics Explorer
Un widget de type explorer représente un widget d'explorateur de métriques. Pour plus d'informations, voir Utiliser l'explorateur de métriques pour surveiller les ressources en fonction de leurs balises et de leurs propriétés
Vous pouvez également ajouter des widgets d'explorateur de métriques à un tableau de bord à l'aide de CloudFormation. Pour plus d'informations, consultez AWS::CloudWatch : :Dashboard.
Ce type de widget peut contenir les champs suivants dans le widget properties :
- Agréger par
-
Un objet qui spécifie comment agréger des métriques provenant de plusieurs ressources. Les valeurs valides pour le
keychamp de cet objet sont les clés des balises et les propriétés des ressources. Cet objet contient les champs suivants.key : clé de propriété de balise ou de ressource à utiliser pour agréger les métriques.
func — La fonction d'agrégation à utiliser. Les valeurs valides sont
AVG|MIN|MAX|STDDEV|SUM
Type : objet
Obligatoire : non
- labels
-
Tableau des balises ou des propriétés des ressources utilisées pour déterminer quelles mesures sont affichées dans le widget.
Si vous spécifiez différentes clés, seules les ressources correspondant à toutes les key/value paires sont affichées. Si vous spécifiez plusieurs valeurs pour une seule clé, les ressources correspondant à l'une des valeurs de cette clé sont affichées.
key — La balise ou la propriété de ressource sur laquelle filtrer.
Pour
key, toutes les clés de tag sont valides pour être spécifiées. Les propriétés de ressources EC2 et Lambda suivantes sont également valides pour :keyEC2 :
Architecture,Hypervisor,CoreCount,ImageId,InstanceId,InstanceLifecycle,InstanceType,InstanceFamily,InstanceSize,Affinity,AvailabilityZone,Tenancy,Platform,RootDeviceTypeSecurityGroups,State,SubnetId,VirtualizationType, andVpcIdLambda :
FunctionName,Runtime,Language,MemorySize,Version,SecurityGroupIds,SubnetIds,SubnetIdCount,VpcIdetTimeout
value — (Facultatif) La valeur de la balise ou de la propriété de ressource sur laquelle filtrer. Si cette option est omise, les mesures correspondant à toutes les valeurs de cette balise ou de cette propriété de ressource sont affichées.
Type : objet
Obligatoire : oui
- metrics
-
Spécifiez un
metricstableau pour inclure une ou plusieurs mesures. Unmetricstableau peut inclure 1 à 100 mesures. Chaque objet du tableau doit contenir les champs suivants.metricName — Le nom de la métrique.
ResourceType : type de ressource publiant la métrique, décrit dans le format utilisé par. AWS CloudFormation Par exemple,
AWS::EC2::InstanceouAWS::Lambda::Function.Vous devez utiliser la même valeur
resourceTypepour toutes les mesures du widget.Pour obtenir la liste complète des valeurs valides, consultezValeurs ResourceType valides pour un objet de widget Metric Explorer.
-
stat — La statistique de cette métrique, si elle doit être différente de celle utilisée pour les autres métriques du tableau. Par défaut, CloudWatch utilise Average si vous ne spécifiez pas de statistique au niveau d'un tableau ou d'une métrique.
Valeurs Valides:
SampleCount|Average|Sum|Minimum|Maximum|p??
Type : tableau d’objets
Obligatoire : oui
- point
-
Période par défaut, en secondes, pour toutes les mesures de ce widget. La période est la durée représentée par un point de données sur le graphique. La valeur par défaut est 300.
Valeurs valides : Tout multiple de 60, 60 étant le minimum.
Type : Integer
Obligatoire : non
- Diviser par
-
Spécifie comment répartir les métriques de plusieurs ressources en différentes lignes d'un graphique ou en différents graphiques. Les valeurs valides sont les clés des balises et les clés des propriétés des ressources.
Type : chaîne
Obligatoire : non
- title
-
Titre à afficher pour le widget. La valeur par défaut est
Explorer.Type : chaîne
Obligatoire : non
- Options du widget
-
Objet qui spécifie la façon dont le widget apparaît sur le tableau de bord. Il peut contenir les champs suivants.
légende —
Détermine l'endroit où la légende de chaque graphique est affichée. Le
legendchamp contient un autre champ appeléposition. Les valeurs possibles pourpositionsontrightbottom, ethidden.Par exemple, dans les cas suivants, la légende apparaît sur la droite du graphique.
"legend": { "position": "right" }lignes PerPage —
Spécifie le nombre de lignes de graphiques affichées par page dans le widget.
empilé —
Spécifiez
trued'afficher le graphique sous forme de graphique à aires empilées oufalsede l'afficher sous forme de lignes distinctes.voir —
Spécifie le mode d'affichage de chaque graphique. Spécifiez
timeSeriesd'afficher cette métrique sous forme de graphique linéaire. Spécifiezbarde l'afficher sous forme de graphique à barres. Spécifiezpiede l'afficher sous forme de graphique circulaire. La valeur par défaut esttimeSeries.widgets PerRow —
Spécifie le nombre de graphiques affichés dans chaque ligne du widget de l'explorateur de métriques.
Type : objet
Obligatoire : non
Exemple
L'exemple suivant affiche trois mesures pour chacune des instances EC2 en cours d'exécution du compte, les graphiques du widget étant divisés par zone de disponibilité. Dans chaque graphique, les statistiques sont agrégées par type d'instance.
{ "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" } } ] }
Valeurs ResourceType valides pour un objet de widget Metric Explorer
Les valeurs valides pour le resourceType champ de la metrics section d'un widget d'explorateur de métriques sont les suivantes :
AWS::AmazonMQ::BrokerAWS::ApiGateway::RestApiAWS::AppStream::FleetAWS::AppSync::GraphQLApiAWS::CloudFront::DistributionAWS::CodeBuild::ProjectAWS::Datasync::AgentAWS::Datasync::TaskAWS::DMS::ReplicationInstanceAWS::DynamoDB::TableAWS::EC2::CapacityReservationAWS::EC2::InstanceAWS::EC2::NatGatewayAWS::EC2::TransitGatewayAWS::EC2::VolumeAWS::EC2::VPNConnectionAWS::ECS::ClusterAWS::EFS::FileSystemAWS::ElastiCache::CacheClusterAWS::ElastiCache::ReplicationGroupAWS::ElasticBeanstalk::EnvironmentAWS::ElasticLoadBalancing::LoadBalancerAWS::ElasticLoadBalancingV2::LoadBalancer/ApplicationELBAWS::ElasticLoadBalancingV2::LoadBalancer/GatewayELBAWS::ElasticLoadBalancingV2::LoadBalancer/NetworkELBAWS::ElasticLoadBalancingV2::TargetGroupAWS::EMR::ClusterAWS::Events::RuleAWS::FSx::FileSystemAWS::GameLift::FleetAWS::GlobalAccelerator::AcceleratorAWS::IoT::TopicRuleAWS::IoT1Click::DeviceAWS::IoTAnalytics::ChannelAWS::IoTAnalytics::DatasetAWS::IoTAnalytics::DatastoreAWS::IoTAnalytics::PipelineAWS::Kafka::ClusterAWS::Kinesis::StreamAWS::KinesisAnalytics::ApplicationAWS::KinesisFirehose::DeliveryStreamAWS::KinesisVideo::StreamAWS::KMS::KeyAWS::Lambda::FunctionAWS::Logs::LogGroupAWS::MediaPackage::ChannelAWS::MediaStore::ContainerAWS::OpsWorks::InstanceAWS::OpsWorks::LayerAWS::OpsWorks::StackAWS::QLDB::LedgerAWS::RDS::DBInstanceAWS::Redshift::ClusterAWS::RoboMaker::SimulationJobAWS::Route53::HealthCheckAWS::Route53Resolver::ResolverEndpointAWS::S3::BucketAWS::SageMaker::EndpointAWS::ServiceCatalog::CloudFormationProductAWS::SES::ConfigurationSetAWS::SNS::TopicAWS::SQS::QueueAWS::StepFunctions::ActivityAWS::StepFunctions::StateMachineAWS::StorageGateway::GatewayAWS::Synthetics::CanaryAWS::Transfer::ServerAWS::WorkMail::OrganizationAWS::WorkSpaces::Workspace
Propriétés d'un objet du widget d'état d'alarme
Un widget de type alarm peut contenir les champs suivantsproperties.
- alarmes
-
Un tableau d'ARN d'alarme à inclure dans le widget. Le tableau peut avoir 1 à 100 ARN.
Type : tableau de chaînes
Obligatoire : Oui (lorsque le widget l'
typeestalarm). - Trier par
-
Spécifie comment trier les alarmes dans le widget.
Choisissez
defaultde les trier par ordre alphabétique par nom d'alarme.Choisissez
stateUpdatedTimestampde les trier d'abord par état d'alarme, les alarmes étant en état ALARME en premier, les alarmes INSUFFISANT_DATA ensuite et les alarmes OK en dernier. Dans chaque groupe, les alarmes sont triées selon leur date de dernière modification d'état, les modifications d'état les plus récentes étant répertoriées en premier.Choisissez
timestampde les trier en fonction de l'heure à laquelle les alarmes ont changé d'état pour la dernière fois, quel que soit l'état actuel de l'alarme. L'alarme qui a changé d'état le plus récemment est répertoriée en premier.Si vous omettez ce champ, les alarmes sont triées par ordre alphabétique.
Type : Chaîne
Valeurs valides : par défaut | état UpdatedTimestamp | horodatage
Obligatoire : non
- states
-
Utilisez ce champ pour filtrer la liste des alarmes affichées dans le widget en fonction des alarmes actuellement dans les états spécifiés. Vous pouvez spécifier un ou plusieurs états d'alarme dans la valeur de ce champ. Les états d'alarme que vous pouvez spécifier sont
ALARMINSUFFICIENT_DATA, etOK.Si vous omettez ce champ ou si vous spécifiez un tableau vide, toutes les alarmes spécifiées
alarmssont affichées.Type : tableau de chaînes
Obligatoire : non
- title
-
Le texte du titre à afficher par le widget.
Type : chaîne
Obligatoire : non
L'exemple suivant est un widget d'état des alarmes qui affiche quatre alarmes spécifiées par leur nom, quel que soit leur état actuel :
{ "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" } }
L'exemple de widget suivant spécifie les quatre mêmes alarmes, mais le widget affiche uniquement les alarmes qui sont actuellement dans l'état ALARM ou INSUFFISANT_DATA :
{ "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" } }
Propriétés d'un objet de widget graphique
Un widget de type chart est un widget graphique multi-sources de données qui prend en charge les requêtes ProMQL par rapport à des métriques. CloudWatch Utilisez un widget graphique pour visualiser les métriques qui peuvent être interrogées avec ProMQL, y compris les métriques ingérées via le protocole OTLP ( OpenTelemetry Line Protocol) et les métriques AWS distribuées qui ont été enrichies pour oTel. Pour plus d'informations sur les requêtes avec ProMQL, consultez. Métriques de requête avec ProMQL
Un widget de type chart peut contenir les champs suivants properties :
- afficher
-
La visualisation à utiliser pour le widget.
Valeurs valides :
line|bar|pienumber|solidgauge|column|legend|histogram|heatmap|scatterType : Chaîne
Obligatoire : oui
- title
-
Le titre à afficher pour le widget.
Type : chaîne
Obligatoire : non
- description
-
Description facultative du widget.
Type : chaîne
Obligatoire : non
- region
-
La AWS région à utiliser pour toutes les requêtes du widget. Chaque requête du
data.queriestableau peut remplacer ce champ par son propreregionchamp.Type : chaîne
Obligatoire : non
- data
-
Les requêtes à tracer dans le widget. L'
dataobjet contient unqueriestableau dans lequel chaque entrée définit une requête. Pour plus d'informations sur le format, consultezWidget graphique : format pour chaque requête du tableau.Type : objet
Obligatoire : oui
- Options de tracé
-
Options de visualisation du widget, telles que le placement de la légende, la configuration des axes et les paramètres de style spécifiques à la vue (par exemple, largeur de ligne ou barres empilées). Les champs exacts disponibles dépendent de la valeur de
view. Si vous omettezplotOptions, les paramètres par défaut de l'affichage sont utilisés. Pour la liste complète des champs, voirWidget graphique : référence PlotOptions.Type : objet
Obligatoire : non
Widget graphique : format pour chaque requête du tableau
Chaque entrée du data.queries tableau définit une requête unique. Pour créer un widget graphique qui interroge des CloudWatch métriques, définissez type surcloudwatch-metrics, définissez sur language ou sur PromQL ou SQL et fournissez l'expression de requête sous forme de chaîne dans le query champ. Un seul widget graphique peut mélanger des requêtes écrites dans différentes langues.
- id
-
Un identifiant pour cette requête. L'identifiant doit être unique dans le widget.
Type : Chaîne
Obligatoire : oui
- type
-
Le type de requête. Pour ProMQL, utilisez.
cloudwatch-metricsValeurs valides :
cloudwatch-metricsType : Chaîne
Obligatoire : oui
- langage
-
La langue de requête pour cette requête. Spécifiez
PromQLd'écrire la requête dans le langage de requête Prometheus ouSQLd'écrire la requête dans CloudWatch Metrics Insights SQL.Valeurs valides :
PromQL|SQLType : Chaîne
Obligatoire : oui
- query
-
L'expression de requête à évaluer, sous forme de chaîne. La syntaxe dépend du
languagechamp.Pour ProMQL, fournissez une expression en langage de requête Prometheus. Par exemple,
sum by (InstanceId) (rate(CPUUtilization[5m])). Pour plus d'informations sur la syntaxe ProMQL et les libellés disponibles sur les métriques AWS distribuées, consultez. Interroger un vendeur AWS métriques avec ProMQLPour SQL, fournissez une requête SQL CloudWatch Metrics Insights. Par exemple,
SELECT AVG(CPUUtilization) FROM SCHEMA("AWS/EC2", InstanceId) GROUP BY InstanceId. Pour plus d'informations sur la syntaxe des requêtes Metrics Insights, consultez la section Composants et syntaxe des requêtes Metrics Insights.Type : Chaîne
Obligatoire : oui
- étiquette
-
L'étiquette à afficher dans la légende de la série de cette requête. Spécifiez la valeur spéciale
__verbose__pour inclure toutes les étiquettes de métriques dans le nom de chaque série.Type : chaîne
Obligatoire : non
- region
-
La AWS région dans laquelle évaluer cette requête. En cas d'omission, le widget
regionest utilisé.Type : chaîne
Obligatoire : non
- accountId
-
Le AWS compte dans lequel évaluer cette requête. Utilisez-le pour les requêtes intercomptes sur un tableau de bord de compte de surveillance.
Type : chaîne
Obligatoire : non
- step
-
Résolution de la requête, en secondes. Cela contrôle la fréquence à laquelle l'expression ProMQL est évaluée sur la plage de temps du widget.
Type : Number
Obligatoire : non
- visible
-
Définissez cette
falseoption pour masquer la série de cette requête dans le graphique tout en conservant la requête dans la définition du widget. La valeur par défaut esttrue.Type : booléen
Obligatoire : non
Widget graphique : référence PlotOptions
L'plotOptionsobjet contrôle le mode de rendu du graphique. Il peut contenir un ensemble de champs communs partagés par tousview, ainsi qu'un style objet dont la forme dépend de celle choisieview. Certaines vues acceptent également les axes (yAxis,xAxis) et annotations les objets.
Le tableau suivant récapitule les champs pris view en charge par chacun.
voir |
sous-objet de style |
Axe Y/Axe X |
Support pour les annotations |
|---|---|---|---|
|
LineStyle |
Oui |
Oui (vertical et horizontal) |
|
BarStyle |
Oui |
Oui (vertical et horizontal) |
|
BarStyle |
Oui |
Non |
|
PieStyle |
Non |
Non |
|
NumberStyle |
Non |
Non |
|
GaugeStyle |
Non |
Oui (horizontal) |
|
ScatterStyle |
Oui |
Oui (vertical et horizontal) |
|
BarStyle + HistogramStyle |
Oui |
Non |
|
HeatmapStyle |
Oui |
Non |
Champs PlotOptions courants
Les champs suivants sont valides plotOptions pour tousview.
- légende
-
Configure la légende. L'objet comporte les champs suivants :
position : endroit où la légende apparaît sur le widget. Les valeurs valides sont
bottometright.show — Booléen. Réglez
falsesur pour masquer la légende.
Type : objet
Obligatoire : non
View-specific champs de style
La forme de l'styleobjet dépend de la valeur deview.
- Options de ligne
-
Utilisé quand
viewc'estline. Configure le rendu des lignes. L'objet comporte les champs suivants :largeur : nombre. Largeur de ligne en pixels.
motif : schéma de trait de ligne. Les valeurs valides sont
solid,dashedetdotted.spline : booléen. Si
true, trace une courbe lissée passant par les points de données.rempli — Booléen. Si
true, remplit la zone située en dessous de la ligne.empilé : booléen. Si
true, empile les zones remplies d'une série à l'autre. Utilisez avecfilled: truepour un graphique à aires empilées.color : couleur hexadécimale HTML à six chiffres.
Type : objet
Obligatoire : non
- Options de barre
-
Utilisé quand
viewc'estbarcolumn, ouhistogram. Configure le rendu des barres. L'objet comporte les champs suivants :empilé : booléen. Si
true, les barres de différentes séries sont empilées.orientation : direction de la barre. Les valeurs valides sont
verticalethorizontal.
Type : objet
Obligatoire : non
- Options de tartes
-
Utilisé quand
viewc'est le caspie. L'objet comporte les champs suivants :Taille intérieure : chaîne. Un pourcentage similaire
"50%". Définissez sur"0%"pour un graphique circulaire plein ou sur une valeur différente de zéro pour un graphique en anneau.
Type : objet
Obligatoire : non
- Options numériques
-
Utilisé quand
viewc'est le casnumber. L'objet comporte les champs suivants :sparkline — Booléen. Si
true, affiche une ligne scintillante en dessous du chiffre.tronquer : booléen. Si
true, tronque les grands nombres (par exemple, s'affiche à la1.2Kplace de1234).
Type : objet
Obligatoire : non
- Options de jauge
-
Utilisé quand
viewc'est le cassolidgauge. L'objet comporte les champs suivants :min : nombre. La valeur minimale de la jauge.
max : nombre. La valeur maximale de la jauge.
Type : objet
Obligatoire : non
- Options de couleur
-
Utilisé quand
viewc'est le casheatmap. Configure le dégradé de couleurs. L'objet comporte les champs suivants :Couleur prédéfinie : chaîne. Nom d'une échelle de couleurs intégrée.
MinColor : couleur hexadécimale HTML à six chiffres utilisée à l'extrémité inférieure d'un dégradé personnalisé.
MidColor : couleur hexadécimale HTML à six chiffres utilisée au milieu d'un dégradé personnalisé.
MaxColor : couleur hexadécimale HTML à six chiffres utilisée en haut d'un dégradé personnalisé.
Type : objet
Obligatoire : non
- Options d'histogramme
-
Utilisé quand
viewc'esthistogramle cas, en plus debarOptions. L'objet comporte les champs suivants :Nombre de seaux — Nombre. Nombre de compartiments dans lesquels diviser les données.
BucketSize : nombre ou chaîne permettant de
"auto"dimensionner automatiquement les compartiments.Combiner les séries — Booléen. Combine toutes les séries en un seul histogramme.
Type : objet
Obligatoire : non
- Options d'agrégation
-
Utilisé quand
viewc'est le cashistogram. Contrôle la manière dont les points de données sont agrégés avant leur classification. L'objet comporte les champs suivants :BinInterval — Chaîne. La largeur du bac en tant que durée. Par exemple,
"5m"pour les bacs de cinq minutes.
Type : objet
Obligatoire : non
- étiquette
-
Utilisée avec les styles de ligne, de barre et de dispersion pour étiqueter les points de données directement sur le graphique. L'objet comporte les champs suivants :
position : endroit où l'étiquette apparaît par rapport à son point de données. Les valeurs valides sont
insideoutsidetop,bottom,left, etright.show — Booléen. Réglez
truepour afficher les étiquettes.
Type : objet
Obligatoire : non
- Options de marquage
-
Utilisé avec les styles de ligne et de dispersion pour configurer les marqueurs dessinés aux points de données. L'objet comporte les champs suivants :
activé : booléen. Réglez sur
truepour dessiner des marqueurs.Type de symbole : chaîne. Forme du marqueur. Par exemple,
circle,squareoudiamond.Taille du symbole : chiffre. Taille du marqueur en pixels.
BorderWidth : nombre. Largeur de la bordure du marqueur en pixels.
BorderColor : couleur hexadécimale HTML à six chiffres pour la bordure du marqueur.
FillColor : couleur hexadécimale HTML à six chiffres pour le remplissage du marqueur.
FillOpacity : valeur comprise entre 0 et 1.
Type : objet
Obligatoire : non
Champs YAxis et XAxis
Pour view les valeurs qui prennent en charge les axes, vous pouvez inclure yAxis des xAxis objets dansplotOptions.
- Axe Y
-
Tableau d'objets à un ou deux axes. La première entrée configure l'axe gauche et la deuxième entrée (si elle est présente) configure l'axe droit. Chaque objet d'axe contient les champs suivants :
min : nombre. Limite inférieure de l'axe.
max : nombre. Limite supérieure de l'axe.
type : échelle des axes. Les valeurs valides sont
linear,logarithmic,datetimeetcategory.titre : chaîne. Libellé de l'axe affiché le long de l'axe.
Afficher les unités : valeur booléenne. Indique s'il faut afficher les suffixes des unités (par exemple,
K,M) sur les étiquettes à cocher.
Type : tableau d'objets
Obligatoire : non
- Axe X
-
Objet à axe unique qui configure l'axe X. L'objet comporte les champs suivants :
min : nombre. Limite inférieure de l'axe.
max : nombre. Limite supérieure de l'axe.
type : échelle des axes. Les valeurs valides sont
linear,logarithmic,datetimeetcategory.titre : chaîne. Libellé de l'axe affiché le long de l'axe.
label : chaîne. Cochez le format de l'étiquette.
Type : objet
Obligatoire : non
annotations
Pour les view valeurs qui prennent en charge les annotations, vous pouvez ajouter des lignes de référence ou des bandes ombrées au graphique. L'annotationsobjet peut contenir les tableaux suivants :
- vertical
-
Annotations sur l'axe temporel. Chaque entrée est soit un objet d'annotation, soit un tableau de deux objets d'annotation pour définir une bande (zone ombrée entre deux valeurs). Chaque objet d'annotation contient les champs suivants :
type : type d'annotation. Utilisez
static.label : chaîne. Texte affiché à côté de l'annotation.
valeur : numéro, chaîne d' ISO-8601 horodatage ou catégorie. Emplacement sur l'axe temporel où l'annotation apparaît.
couleur : couleur hexadécimale HTML à six chiffres utilisée pour la ligne d'annotation et tout ombrage de remplissage.
fill : comment utiliser l'ombrage de remplissage. Les valeurs valides sont
before(ombrage avant l'annotation),after(ombrage après l'annotation) etbetween(utilisées pour les annotations de bande pour ombrer les deux valeurs).
Type : Array
Obligatoire : non
- horizontaux
-
Annotations sur l'axe des valeurs. Chaque entrée est soit un objet d'annotation, soit un tableau de deux objets d'annotation pour définir une bande. Chaque objet d'annotation contient les champs suivants :
type : type d'annotation. Utilisez
static.label : chaîne. Texte affiché à côté de l'annotation.
valeur : nombre. La valeur sur l'axe des valeurs où l'annotation apparaît.
couleur : couleur hexadécimale HTML à six chiffres utilisée pour la ligne d'annotation et tout ombrage de remplissage.
fill : comment utiliser l'ombrage de remplissage. Les valeurs valides sont
above(ombrage au-dessus de l'annotation),below(ombrage en dessous de l'annotation) etbetween(utilisées pour les annotations de bande afin d'ombrer entre les deux valeurs).
Type : Array
Obligatoire : non
Exemple : graphique linéaire ProMQL
L'exemple suivant affiche un graphique linéaire qui trace une requête ProMQL par rapport à des métriques AWS distribuées dans. us-east-1
{ "type": "chart", "x": 0, "y": 0, "width": 12, "height": 6, "properties": { "view": "line", "title": "EC2 CPU by instance", "region": "us-east-1", "data": { "queries": [ { "id": "a", "type": "cloudwatch-metrics", "language": "PromQL", "query": "sum by (InstanceId) (rate(CPUUtilization[5m]))" } ] }, "plotOptions": { "legend": { "position": "bottom", "show": true } } } }
Exemple : graphique combinant une requête ProMQL et une requête SQL
L'exemple suivant montre un graphique linéaire qui trace deux requêtes par rapport à la même métrique, l'une écrite dans ProMQL et l'autre écrite dans CloudWatch Metrics Insights SQL.
{ "type": "chart", "x": 0, "y": 6, "width": 12, "height": 6, "properties": { "view": "line", "title": "EC2 CPU utilization (PromQL and SQL)", "region": "us-east-1", "data": { "queries": [ { "id": "promql_cpu", "type": "cloudwatch-metrics", "language": "PromQL", "query": "sum by (InstanceId) (rate(CPUUtilization[5m]))", "label": "PromQL" }, { "id": "sql_cpu", "type": "cloudwatch-metrics", "language": "SQL", "query": "SELECT AVG(CPUUtilization) FROM SCHEMA(\"AWS/EC2\", InstanceId) GROUP BY InstanceId", "label": "SQL" } ] }, "plotOptions": { "legend": { "position": "right", "show": true } } } }