View a markdown version of this page

Structure et syntaxe du corps du tableau de bord - Amazon CloudWatch
Structure globaleStructure du tableau de widgetsStructure du tableau de variablesPropriétés d'un objet Log WidgetPropriétés d'un objet widget métriqueWidget métrique : format pour chaque métrique du tableauPropriétés d'un objet du widget Metrics ExplorerPropriétés d'un objet du widget d'état des alarmes

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

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 ce tableau 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 paramètre 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 métriques Lambda par fonction et utilise une variable de tableau de bord afin que les utilisateurs du tableau de bord puissent passer d'un nom de fonction Lambda à un autre et voir les trois métriques 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. Le premier inclut deux mesures et une expression mathématique qui additionne leur total. Le deuxième widget est une expression de recherche qui affiche toutes CPUUtilization 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 inclut des exemples illustrant chaque partie de la DashboardBody syntaxe. Pour plus d'exemples illustrant la syntaxe complète des commandes, consultez PutDashboardle 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 du 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 du 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 variables tableau, celui-ci peut contenir entre 0 et 25 objets variables.

Obligatoire : non

end

Fin de la plage de temps à 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 pour start. 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, start sans end spécifier, une plage de temps relative se terminant par l'heure actuelle. Dans ce cas, la valeur de start doit commencer par -PT si vous spécifiez un intervalle de temps en minutes ou en heures, et doit commencer par -P si vous spécifiez un intervalle 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, -PT5M affiche les 5 dernières minutes, -PT8H les 8 dernières heures et -P3M les trois derniers mois.

Vous pouvez également l'utiliser start avec un end champ 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 omettezstart, le tableau de bord affiche la plage de temps par défaut lors du chargement.

Type : chaîne

Obligatoire : non

Dérogation de période

Utilisez ce champ pour spécifier la période de chargement du tableau de bord pour les graphiques. La spécification auto fait en sorte que la période de tous les graphiques du tableau de bord s'adapte automatiquement à la plage de temps du tableau de bord. La spécification inherit garantit 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

Type : 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 y est spécifié. Sinon, ce n'est pas nécessaire.

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 x est spécifié. Sinon, ce n'est pas nécessaire.

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 varient en fonction du type de widget. Pour plus d'informations sur le format deproperties, voir Propriétés d'un objet widget métrique 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 dans les définitions du widget, telle queregion.

  • Tout nom de dimension pour une métrique, tel que InstanceId ouFunctionName.

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 | pattern

Type : 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 input d'utiliser une zone de texte dans laquelle l'utilisateur peut saisir des valeurs.

  • Spécifiez select d'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 l'utilisation radio d'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 | radio

Type : Chaîne

Obligatoire : oui

values

Si vous inputType êtes select ou radio si 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 une valeur booléenne, 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 values tableau, 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 inputType c'est le cas select ou radio si vous n'utilisez pas une requête de recherche métrique pour renseigner les valeurs.

id

Un identifiant pour cette variable. Il peut comporter 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 pattern_1, pattern_2, ... est utilisé pour l'étiquette.

Type : chaîne

Obligatoire : non

defaultValue

La valeur par défaut de la variable, lorsque le tableau de bord est ouvert pour la première fois.

  • Si inputType c'est le casinput, vous le spécifiez defaultValue ici manuellement et utilisez jusqu'à 255 caractères

  • Dans inputType l'selectaffirmativeradio, vous devez spécifier une valeur possible valide que vous avez spécifiée dans le values tableau ou qui a été récupérée 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 du type de cette variable

Obligatoire : non

search

Spécifiez ce champ pour renseigner le vôtre select ou le champ de radio saisie à 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 trouve 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 compte

La search chaîne que vous spécifiez peut comporter 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 defaultValue est utilisée tant que cette valeur par défaut est une ou les ressources extraites par la recherche. Lorsque vous utilisez une expression de recherche pour remplir votre champ de saisie, vous pouvez également spécifier la valeur spéciale __FIRST pourdefaultValue, afin que la valeur par défaut soit la première valeur renvoyée par la recherche. (La valeur spéciale inclut 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 inputType c'est le cas select ou radio si vous ne le spécifiez pasvalues.

Remplir à partir de

Si vous utilisez le search champ pour remplir 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 search valeur est"search": "{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\"", vous pouvez spécifier InstanceId pourpopulateFrom.

Type : Chaîne

Obligatoire : Oui, si inputType c'est le cas select ou radio si 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 true est utilisée.

L'utilisation false permet 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 montre 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 balisage pris en charge dans les widgets de CloudWatch texte, voir Utilisation de Markdown dans la console.

markdown

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 transparent rend le widget transparent. La valeur solid est 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 de journal avec CloudWatch Logs Insights.

Un log widget peut inclure les champs suivants dans son properties champ.

accountId

L'ID de compte du AWS compte contenant les journaux, s'il s'agit d'une requête entre comptes.

Type : chaîne

Obligatoire : non

region

Région de la requête de logs.

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 query chaîne commence par les noms des groupes de journaux qui doivent être interrogés. Vous devez préalablement inscrire le nom de chaque groupe de journaux par. SOURCE Séparez plusieurs groupes de journaux par un caractère en forme de tube (|).

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 la requête par \n|

Par exemple, la ligne suivante représente une requête de deux groupes de journaux, service_log1 etservice_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 le mode d'affichage des résultats de la requête. Spécifiez table pour afficher les résultats sous forme de tableau. Spécifiez timeSeries pour afficher cette métrique sous forme de graphique linéaire. Spécifiez bar pour l'afficher sous forme de graphique à barres. Spécifiez pie pour 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 widget métrique

Un widget de ce type metric peut contenir les champs suivants properties :

accountId

Spécifie l'ID du AWS compte d'où proviendront toutes les statistiques 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 cela, le compte courant est utilisé par défaut. Utilisez ce paramètre uniquement pour les widgets métriques.

Vous pouvez également utiliser un accountId champ dans chaque métrique du tableau de metrics pour créer un widget unique qui inclut les métriques de plusieurs comptes.

Type : chaîne

Obligatoire : non

annotations

Pour inclure une alarme ou une annotation dans le widget, spécifiez un annotations tableau. Pour plus d'informations sur le format, consultezObjet du widget du tableau de bord : propriétés des annotations. Utilisez ce paramètre uniquement pour les widgets métriques.

Type : objet

Obligatoire : une annotation d'alarme n'est requise que lorsque le widget type metrics est metric spécifié ou non. Aucune annotation horizontale ou verticale n'est requise.

Données en direct

Spécifiez true pour afficher les données en temps réel 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, consultez la section Utiliser les données en temps réel.

Type : booléen

Obligatoire : non

légende

Spécifiez legend pour déterminer l'endroit où la légende des lignes du graphique est affichée. Le legend champ contient un autre champ appeléposition. Les valeurs possibles pour position sont rightbottom, ethidden.

Par exemple, ce qui suit fait apparaître la légende sur la droite du graphique.

"legend": {
     "position": "right"
}

Type : objet

Obligatoire : non

métriques

Spécifiez un metrics tableau pour inclure une ou plusieurs mesures (sans alarmes), une requête Metrics Insights, des expressions mathématiques ou des expressions de recherche. Un metrics tableau 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 expression champ ne peut pas inclure à la fois une requête Metrics Insights et une expression mathématique, mais vous pouvez utiliser les résultats renvoyés par une requête Metrics Insights à partir d'une expression comme entrée dans une expression mathématique dans une autre expression du tableau.

Type : Tableau de tableaux

Obligatoire : Oui, lorsque le widget type annotations est metric spécifié ou non.

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 remplacé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 : n'importe quel multiple de 60, 60 étant le minimum.

Type : Integer

Obligatoire : non

region

Région de la métrique.

Type : Chaîne

Obligatoire : oui

sparkline

Spécifiez true pour afficher la fonction Sparkline sous le widget numérique. Spécifiez false pour afficher le widget numérique seul. 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 true d'afficher le graphique sous forme de lignes empilées ou false de lignes séparées. Ce paramètre est ignoré si tel view est le cassingleValue. 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 remplacée dans la définition de chaque métrique individuelle du metrics tableau. 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 table section pour inclure les modifications liées à la table de données dans le widget. Pour plus d'informations sur le format, consultezObjet du widget du tableau de bord : propriétés du tableau de bord.

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 indiquent le nombre de minutes. Par exemple, +0130 indique une heure et 30 minutes avant l'heure 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 timeSeries d'afficher cette métrique sous forme de graphique linéaire ou à aires empilées. Spécifiez singleValue pour afficher cette métrique sous forme de graphique numérique. Spécifiez gauge d'afficher cette métrique sous forme de graphique de jauge. Spécifiez bar pour afficher cette métrique sous forme de graphique à barres. Spécifiez pie pour afficher cette métrique sous forme de graphique circulaire.

Note

Si vous le spécifiezgauge, vous devez définir une valeur pour min et max sur le côté gauche deyAxis.

Valeurs Valides: timeSeries | singleValue | gauge | bar | pie | table

Type : 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 graphiques, à l'exception des mesures spécifiques qui remplacent ce paramètre. Pour de plus amples informations, veuillez consulter Objet du widget du tableau de bord : format des propriétés YAxis.

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 possède le format suivant :

[ Namespace, MetricName, [{DimensionName,DimensionValue}...] {Rendering Properties Object} ]

Le format de chaque expression du metrics tableau est le suivant :

[ {"expression" : "expression", ["label" : "label"] , ["id" : "id"] } ]
accountId

Spécifie l'ID du AWS compte d'où provient cette métrique. Cela vous permet de créer un widget qui contient les statistiques de plusieurs comptes sur un tableau de bord multi-comptes. Pour plus d'informations, consultez Console Cross-Account Cross-Region CloudWatch .

Si vous omettez cela, 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 vous avez plusieurs entrées dans le metrics tableau, pour chacune d'entre elles après la première, vous pouvez uniquement spécifier "." 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 metrics tableau, pour chacune d'entre elles après la première, vous pouvez uniquement spécifier "." d'utiliser 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 pour obtenir une correspondance exacte, chaque guillemet doit être remplacé par une barre oblique inverse.

Pour plus d'informations sur la syntaxe des requêtes de Metrics Insights, consultez la section Composants et syntaxe des requêtes de Metrics Insights.

Pour plus d'informations sur les expressions mathématiques ou les expressions de recherche, consultez Using Metric Math ou Using Search Expressions in Graphs 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 les données affichées. Si vous avez plusieurs entrées dans le metrics tableau, pour chacune d'elles après la première, vous pouvez uniquement spécifier "." 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 dimension 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

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étriques

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 the DiskReadBytes metric for three instances.
        [ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-xyz" ],
        [ ".", ".", ".", "i-abc" ],
        [ ".", ".", ".", "i-123" ]
       
 // The following example includes two metrics and a math expression to sum them.
        [ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-123",{ "id": "m1" } ],
        [ ".", ".", ".", "i-abc", { "id": "m2" } ],
        [ { "expression": "SUM(METRICS())", "label": "Sum of DiskReadbytes", "id": "e3" } ]
       
  // The following example is a search expression showing the EC2 CPUUtilization for each instance in the Region.
        [ { "expression": "SEARCH('{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\"', 'Average', 300)", "id": "e1" } ],

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 métriques du widget.

Type : chaîne

Obligatoire : non

point

Période de 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 : un 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 métriques du tableau. Par défaut, CloudWatch utilise Average si vous ne spécifiez aucune statistique au niveau du tableau ou de la métrique.

Valeurs Valides: SampleCount | Average | Sum | Minimum | Maximum | p??

Type : chaîne qui est une CloudWatch statistique valide.

Obligatoire : non

visible

Réglez ce paramètre true pour que la métrique apparaisse dans le graphique ou false pour qu'elle soit masquée. La valeur par défaut est true.

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 | right

Type : 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 du tableau de bord : propriétés des annotations

Les annotations incluent des alarmes, des annotations horizontales et des annotations verticales. Un seul widget métrique peut comporter jusqu'à une alarme ou une ou plusieurs annotations horizontales ou verticales. Un seul widget ne peut pas contenir à 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

Un ensemble d'annotations horizontales. Les annotations horizontales proposent plusieurs options d'ombrage de fond, notamment l'ombrage au-dessus de la ligne d'annotation, l'ombrage en dessous de la ligne d'annotation et l'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 possède le format suivant :

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

La valeur métrique dans le 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 redimensionné de telle 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 above l'ombrage au-dessus de l'annotation, l'belowombrage en dessous de l'annotation et l'absence none d'ombrage. S'il fill est omis, il n'y a pas d'ombrage.

L'exception concerne les annotations avec ombrage de bande. Ces annotations comportent toujours un ombrage entre les deux valeurs, et toute valeur pour fill est ignorée.

Type : chaîne

Obligatoire : non

visible

Définissez cette option true pour que l'annotation apparaisse dans le graphique ou false pour qu'elle soit masquée. La valeur par défaut est true.

Type : booléen

Obligatoire : non

Axe Y

Si le graphique inclut plusieurs mesures, indique si les nombres indiqués Value font référence à la métrique associée à la gauche Y-axis ou à la droite Y-axis,. Les valeurs valides sont right et left.

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

Un ensemble d'annotations verticales. Pour chaque annotation verticale, vous pouvez choisir d'utiliser un ombrage de remplissage avant l'annotation, après celle-ci ou entre deux lignes verticales liées sous la forme d'une annotation à canal unique. Chaque annotation verticale du tableau qui est une annotation unique, au lieu d'une annotation de canal, a le format suivant :

{value, label, color, fill, visible}

Chaque annotation verticale qui est une annotation de canal possède le format suivant :

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

Date et heure dans le 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 redimensionné de telle sorte que toutes les annotations verticales visibles apparaissent sur le graphique.

Ceci est défini 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 before l'ombrage avant l'annotation, l'afterombrage après l'annotation et l'absence none d'ombrage. S'il fill est omis, il n'y a pas d'ombrage.

L'exception concerne les annotations avec ombrage de bande. Ces annotations comportent toujours un ombrage entre les deux valeurs, et toute valeur pour fill est ignorée.

Type : chaîne

Obligatoire : non

visible

Définissez cette option true pour que l'annotation apparaisse dans le graphique ou false pour qu'elle soit masquée. La valeur par défaut est true.

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 du tableau de bord : format des propriétés YAxis

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 indique les unités. Définissez ce paramètre dans l'widgetobjet pour affecter toutes les mesures du widget. Pour remplacer 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 facultatifs pour la gauche Y-axis.

Type : objet YAxis

Obligatoire : non

droite

Réglages facultatifs pour la droite Y-axis.

Type : objet YAxis

Obligatoire : non

Chacun des right objets left et peut inclure les paramètres suivants :

étiquette

Une étiquette 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 du tableau de bord : propriétés du tableau de bord

Si vous spécifiez un widget table de mesures, vous pouvez inclure des visualisations relatives à la visibilité des colonnes de résumé, des colonnes de points de données et de la mise en page du tableau. Ces propriétés ne prennent effet que lorsque le type de vue du widget est le même 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 | horizontal

Type : chaîne

Obligatoire : non

Résumé autocollant

Définissez cette option true pour que les colonnes de résumé que vous incluez dans le tableau restent persistantes, 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 est false.

L'étiquette du widget est toujours collante, quel que soit votre choix dans ce champ.

Valeurs valides : true | false

Type : booléen

Obligatoire : non

montrer TimeSeriesData

Définissez cette valeur false si 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 | false

Type : 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 Sum résumé est une somme de tous les points de données rendus dans sa ligne respective. Les colonnes récapitulatives ne sont pas le même concept que les statistiques CloudWatch métriques.

La valeur par défaut est [“MIN“, "MAX","SUM", "AVG"].

Valeurs Valides: "MIN" | "MAX" | "SUM" | "AVG"

Type : Array

Obligatoire : non

Par exemple, le 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 du 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 comporter les champs suivants dans le widget properties :

Agrégé par

Objet qui indique comment agréger les métriques issues de plusieurs ressources. Les valeurs valides pour le key champ de cet objet sont les clés des balises et des propriétés des ressources. Cet objet contient les champs suivants.

  • clé — La balise ou la clé de propriété de ressource à utiliser pour agréger les métriques.

  • func — 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 les mesures affichées dans le widget.

Si vous spécifiez des clés différentes, 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 : balise ou propriété de ressource sur laquelle filtrer.

    En key effet, toutes les clés de balise sont valides pour être spécifiées. Les propriétés de ressources EC2 et Lambda suivantes sont également valides pour : key

    • EC2 :

      Architecture, Hypervisor, CoreCount, ImageId, InstanceId, InstanceLifecycle, InstanceType, InstanceFamily, InstanceSize, Affinity, AvailabilityZone, Tenancy, Platform, RootDeviceType SecurityGroups, State, SubnetId, VirtualizationType, and VpcId

    • Lambda :

      FunctionName, Runtime, Language, MemorySize, Version, SecurityGroupIds, SubnetIds, SubnetIdCount, VpcId et Timeout

  • value — (Facultatif) La valeur de la balise ou de la propriété de ressource sur laquelle filtrer. Si ce paramètre est omis, les métriques correspondant à toutes les valeurs de cette balise ou propriété de ressource sont affichées.

Type : objet

Obligatoire : oui

métriques

Spécifiez un metrics tableau pour inclure une ou plusieurs métriques. Un metrics tableau peut inclure 1 à 100 métriques. 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::Instance ou AWS::Lambda::Function.

    Vous devez utiliser la même valeur resourceType pour toutes les mesures du widget.

    Pour obtenir la liste complète des valeurs valides, consultezValeurs ResourceType valides pour un objet widget Metric Explorer.

  • stat — La statistique de cette métrique, si elle doit être différente de la statistique utilisée pour les autres métriques du tableau. Par défaut, CloudWatch utilise Average si vous ne spécifiez aucune statistique au niveau du tableau ou de la 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 : n'importe quel multiple de 60, 60 étant le minimum.

Type : Integer

Obligatoire : non

Séparer par

Spécifie comment diviser les métriques de plusieurs ressources en différentes lignes sur 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 indique 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 legend champ contient un autre champ appeléposition. Les valeurs possibles pour position sont rightbottom, ethidden.

    Par exemple, ce qui suit fait apparaître la légende 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és —

    Spécifiez true d'afficher le graphique sous forme de graphique à aires empilées ou de l'falseafficher sous forme de lignes séparées.

  • voir —

    Spécifie le mode d'affichage de chaque graphique. Spécifiez timeSeries pour afficher cette métrique sous forme de graphique linéaire. Spécifiez bar pour l'afficher sous forme de graphique à barres. Spécifiez pie pour l'afficher sous forme de graphique circulaire. La valeur par défaut est timeSeries.

  • widgets PerRow —

    Spécifie le nombre de graphiques affichés dans chaque ligne du widget d'explorateur de métriques.

Type : objet

Obligatoire : non

Exemple

L'exemple suivant affiche trois statistiques 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 métriques 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 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::Broker

  • AWS::ApiGateway::RestApi

  • AWS::AppStream::Fleet

  • AWS::AppSync::GraphQLApi

  • AWS::CloudFront::Distribution

  • AWS::CodeBuild::Project

  • AWS::Datasync::Agent

  • AWS::Datasync::Task

  • AWS::DMS::ReplicationInstance

  • AWS::DynamoDB::Table

  • AWS::EC2::CapacityReservation

  • AWS::EC2::Instance

  • AWS::EC2::NatGateway

  • AWS::EC2::TransitGateway

  • AWS::EC2::Volume

  • AWS::EC2::VPNConnection

  • AWS::ECS::Cluster

  • AWS::EFS::FileSystem

  • AWS::ElastiCache::CacheCluster

  • AWS::ElastiCache::ReplicationGroup

  • AWS::ElasticBeanstalk::Environment

  • AWS::ElasticLoadBalancing::LoadBalancer

  • AWS::ElasticLoadBalancingV2::LoadBalancer/ApplicationELB

  • AWS::ElasticLoadBalancingV2::LoadBalancer/GatewayELB

  • AWS::ElasticLoadBalancingV2::LoadBalancer/NetworkELB

  • AWS::ElasticLoadBalancingV2::TargetGroup

  • AWS::EMR::Cluster

  • AWS::Events::Rule

  • AWS::FSx::FileSystem

  • AWS::GameLift::Fleet

  • AWS::GlobalAccelerator::Accelerator

  • AWS::IoT::TopicRule

  • AWS::IoT1Click::Device

  • AWS::IoTAnalytics::Channel

  • AWS::IoTAnalytics::Dataset

  • AWS::IoTAnalytics::Datastore

  • AWS::IoTAnalytics::Pipeline

  • AWS::Kafka::Cluster

  • AWS::Kinesis::Stream

  • AWS::KinesisAnalytics::Application

  • AWS::KinesisFirehose::DeliveryStream

  • AWS::KinesisVideo::Stream

  • AWS::KMS::Key

  • AWS::Lambda::Function

  • AWS::Logs::LogGroup

  • AWS::MediaPackage::Channel

  • AWS::MediaStore::Container

  • AWS::OpsWorks::Instance

  • AWS::OpsWorks::Layer

  • AWS::OpsWorks::Stack

  • AWS::QLDB::Ledger

  • AWS::RDS::DBInstance

  • AWS::Redshift::Cluster

  • AWS::RoboMaker::SimulationJob

  • AWS::Route53::HealthCheck

  • AWS::Route53Resolver::ResolverEndpoint

  • AWS::S3::Bucket

  • AWS::SageMaker::Endpoint

  • AWS::ServiceCatalog::CloudFormationProduct

  • AWS::SES::ConfigurationSet

  • AWS::SNS::Topic

  • AWS::SQS::Queue

  • AWS::StepFunctions::Activity

  • AWS::StepFunctions::StateMachine

  • AWS::StorageGateway::Gateway

  • AWS::Synthetics::Canary

  • AWS::Transfer::Server

  • AWS::WorkMail::Organization

  • AWS::WorkSpaces::Workspace

Propriétés d'un objet du widget d'état des alarmes

Un widget de ce type alarm peut contenir les champs suivantsproperties.

alarmes

Un tableau d'ARN d'alarmes à inclure dans le widget. Le réseau peut avoir de 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 default de les trier par ordre alphabétique par nom d'alarme.

Choisissez stateUpdatedTimestamp de les trier d'abord par état d'alarme, avec les alarmes à l'état ALARM en premier, les alarmes INSUFFIENT_DATA ensuite et les alarmes OK en dernier. Au sein de chaque groupe, les alarmes sont triées en fonction de leur dernier changement d'état, les modifications d'état les plus récentes étant répertoriées en premier.

Choisissez timestamp de les trier en fonction de l'heure à laquelle les alarmes ont récemment changé d'état, 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 uniquement pour les 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 s'affichentalarms.

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 il affiche uniquement les alarmes qui sont actuellement dans l'état ALARM ou INSUFFIENT_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"
    }
}