GetMetricWidgetImage: Structure et syntaxe du widget métrique

Structure globale Format pour chaque métrique du tableau de métriques Format des propriétés d'annotation Format des propriétés YAxis

MetricWidgetest un paramètre d'entrée pour l'https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricWidgetImage.htmlAPI. Il s'agit d'une chaîne au format JSON.

Table des matières

Structure globale
Format pour chaque métrique du tableau de métriques
Format des propriétés d'annotation
Format des propriétés YAxis

La MetricWidget chaîne peut inclure les paramètres suivants :

métriques

Les métriques à inclure dans le graphique, sous forme de metrics tableau. Cela peut inclure à la fois des expressions mathématiques métriques et métriques brutes. Un metrics tableau peut inclure 1 à 100 métriques et expressions. Pour plus d'informations sur le format demetrics, consultezFormat pour chaque métrique du tableau de métriques.

Type : Tableau de tableaux

Obligatoire : oui.

annotations

Les annotations horizontales et verticales à ajouter au graphique, sous forme de tableaux d'annotations. Pour plus d'informations sur le format, consultezFormat des propriétés d'annotation.

Obligatoire : non

end

Date et heure de fin des métriques indiquées dans le graphique. Cela peut être exprimé sous la forme d'une valeur absolue, telle que 2018-04-25, T12:00:00.000Z ou d'une valeur relative telle que -PID.

Si vous ne le spécifiez pasend, la valeur par défaut de -PT0H (l'heure actuelle) est utilisée.

Type : chaîne

Obligatoire : non

height

Hauteur du widget en pixels. La valeur par défaut est 400.

Valeurs valides : 1 à 2000

Type : Integer

Obligatoire : Non, mais vous devez le définir si vous définissez également une valeur pourwidth.

légende

Spécifie l'emplacement et la visibilité de la légende du graphe. legendcontient un champ,position. La valeur de position peut être bottom, right ou hidden. La valeur par défaut est bottom.

Type : chaîne

Obligatoire : non

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

point

Période par défaut, en secondes, pour toutes les mesures de ce widget. Cette valeur par défaut peut être remplacée dans chaque définition de métrique. La valeur par défaut est 300.

Valeurs valides : 1, 5, 10, 30, 60 et tout multiple de 60. Les valeurs 1, 5, 10 et 30 concernent uniquement les mesures à haute résolution.

Type : Integer

Obligatoire : non

region

Ce paramètre est facultatif. Si vous l'incluez, il doit spécifier la région locale.

Type : chaîne

Obligatoire : non

empilé

Spécifiez true d'afficher le graphique sous forme de lignes empilées ou false de lignes séparées. La valeur par défaut est false.

Type : booléen

Obligatoire : non

démarrer

Date et heure de début des mesures indiquées dans le graphique. Cela peut être exprimé sous la forme d'une valeur absolue, telle que 2018-04-25, T12:00:00.000Z ou d'une valeur relative telle que -PID.

Si vous ne le spécifiez passtart, la valeur par défaut de -PT3H (il y a trois heures) est utilisée.

Type : chaîne

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.

Si vous ne spécifiez pas ce paramètre, la valeur par défaut Average est utilisée.

Valeurs valides : SampleCount | Average | Sum Minimum | Maximum | p?? | |TM(??:??), TC(??:??) TS(??:??) | WM(??:??) | PR(??:??) | IQM

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

Obligatoire : non

thème

Palette de couleurs utilisée pour styliser le graphique. La valeur par défaut est light.

Valeurs valides : light | dark

Type : chaîne

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.

Type : chaîne

Obligatoire : non

afficher

Le format d'affichage. Spécifiez timeSeries pour afficher cette métrique sous forme de graphique linéaire. Spécifiez bar pour afficher la métrique sous forme de graphique à barres. Spécifiez pie pour afficher la métrique sous forme de graphique circulaire. La valeur par défaut est timeSeries.

Valeurs valides : timeSeries | bar | pie

Type : chaîne

Obligatoire : non

width

Largeur du widget en pixels. La valeur par défaut est 600.

Valeurs valides : 1 à 2000

Type : Integer

Obligatoire : Non, mais vous devez le définir si vous définissez également une valeur pourwidth.

Axe Y

Limites des minimums et des maximums de l'axe Y. Cela s'applique à chaque métrique représentée graphiquement, à moins que des métriques spécifiques ne la remplacent. Pour plus d'informations sur le format, consultezFormat des propriétés YAxis.

Type : objet YAxis

Obligatoire : non

Chaque élément du metrics tableau est une CloudWatch métrique à afficher dans le graphique ou à utiliser dans le cadre d'une expression mathématique affichée dans le graphique. Pour plus d'informations sur les expressions mathématiques, consultez la section Utiliser les mathématiques métriques dans le guide de CloudWatch l'utilisateur Amazon.

Le format de chaque métrique du tableau est le suivant :


[Namespace, MetricName, Dimension1Name, Dimension1Value, Dimension2Name, Dimension2Value... 
            {Options Object}]

Namespace

L' AWS espace de noms contenant la métrique. Pour utiliser le même espace de noms que la métrique précédente dans le tableau, vous pouvez spécifier "." pour chaque entrée après la première.

Type : Chaîne

Obligatoire : oui

MetricName

Le nom de la CloudWatch métrique. Pour utiliser le même nom que la métrique précédente dans le tableau, vous pouvez spécifier "." pour chaque entrée après la première.

Type : Chaîne

Obligatoire : oui

DimensionName

Le nom d'une dimension permettant d'affiner les données affichées. Pour utiliser le même nom de dimension que la métrique précédente du tableau, vous pouvez spécifier "." pour chaque entrée après la première. Vous pouvez spécifier des dimensions nulles pour une métrique, ou jusqu'à autant de dimensions que la métrique prend en charge.

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, sauf s'il existe un nom de dimension correspondant.

Objet d'options

Spécifie soit des propriétés de rendu personnalisées à utiliser pour la CloudWatch métrique spécifiée, soit une expression mathématique à afficher sur le graphique. Pour plus d'informations sur le format, consultezFormat d'objet des options.

Type : Objet d'options

Obligatoire : non

Exemples


// The simplest example, a metric with no dimensions
        [ "AWS/EC2", "CPUUtilization" ]
        
 // A metric with a single dimension
        [ "AWS/EC2", "CPUUtilization", "InstanceId", "i-01234567890123456" ]
        
 // A metric with a single dimension and rendering properties
        [ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-01234567890123456", { yAxis: "right"} ]
       
 // The following example graphs the DiskReadBytes metric for three instances.
        [ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-01234567890123456" ],
        [ ".", ".", ".", "i-abc" ],
        [ ".", ".", ".", "i-123" ]

Spécifie soit des propriétés de rendu personnalisées à utiliser pour la CloudWatch métrique spécifiée, soit une expression mathématique à afficher sur le graphique.

Si cet objet est spécifié dans le cadre d'une CloudWatch métrique du metrics tableau, il définit des propriétés de rendu personnalisées pour cette métrique et remplace les valeurs par défaut utilisées pour l'ensemble du graphique.

Vous pouvez également spécifier cet objet pour ajouter une expression mathématique au graphique. Dans ce cas, les autres paramètres de cet objet spécifient les options d'affichage du résultat de l'expression mathématique.

Cette section décrit le format de ces objets d'options.

color

Code couleur hexadécimal HTML à six chiffres à utiliser pour cette métrique ou expression.

Type : chaîne

Obligatoire : non

expression

Expression mathématique à afficher. Pour plus d'informations sur les fonctions et le format d'expression mathématique pris en charge, consultez la section Syntaxe et fonctions mathématiques métriques dans le guide de CloudWatch l'utilisateur Amazon.

Type : chaîne qui est une expression mathématique CloudWatch métrique valide.

Obligatoire : Oui s'il s'agit d'une expression.

étiquette

L'étiquette à afficher pour cette métrique ou expression 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

id

Identifiant pour cette métrique ou expression, qui doit être unique dans ce widget. L'identifiant peut être utilisé comme variable pour représenter cette métrique ou cette expression dans des expressions mathématiques. Les caractères valides sont les lettres, les chiffres et le trait de soulignement. Le premier caractère doit être une lettre minuscule.

Type : chaîne

Obligatoire : non

point

Période de cette métrique, en secondes. Si cela est spécifié, cela remplace la période par défaut utilisée pour les autres mesures de ce graphique. Ce paramètre ne s'applique pas aux expressions mathématiques.

Valeurs valides : 1, 5, 10, 30, 60 et tout multiple de 60. Les valeurs 1, 5, 10 et 30 concernent uniquement les mesures à haute résolution.

Type : Integer

Obligatoire : non

stat

La statistique à afficher pour cette métrique, si elle doit être différente de la statistique utilisée pour les autres métriques du graphique. Ce paramètre ne s'applique pas aux expressions mathématiques.

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

Obligatoire : non

visible

Spécifie si cette métrique ou expression est affichée sur le graphique. La valeur par défaut est true.

Le réglage visible sur false est utile si vous souhaitez masquer les métriques brutes utilisées dans les expressions mathématiques et afficher uniquement les résultats des expressions sur le graphique.

Type : booléen

Obligatoire : non

Axe Y

Où sur le graphique afficher l'axe Y pour cette métrique ou expression. La valeur par défaut est left.

Valeurs valides : left | right

Type : chaîne

Obligatoire : non

Exemple

Dans l'exemple suivant, CloudWatch récupère une apiLatency métrique personnalisée. En haut, la statistique p50 est spécifiée pour indiquer la valeur médiane. Ensuite, pour la même métrique sur la même instance (cela est spécifié par les quatre champs qui ne sont que des points), la valeur moyenne est représentée graphiquement. Vient ensuite un objet d'options avec une expression mathématique indiquant la valeur intermédiaire des deux mesures. Enfin, une autre expression indique le taux de variation.

Pour afficher uniquement les résultats des deux expressions sur le graphique et masquer les mesures brutes, vous pouvez remplacer les deux premières instances visible de parfalse.


{
        "metrics": [
            [
                "MyNamespace", 
                "apiLatency", 
                "InstanceId", 
                "i-0987654321abcdef0", 
                {
                    "id": "m1",
                    "stat": "p50",
                    "label": "Median value",
                    "visible": true,
                    "color": "#dddddd",
                    "yAxis": "left",
                    "period": 300
                }
            ],
            [
                ".", 
                ".", 
                ".", 
                ".", 
                {
                    "id": "m2",
                    "stat": "Average",
                    "label": "Average value",
                    "visible": true,
                    "color": "#cccccc",
                    "yAxis": "left",
                    "period": 300
                }
            ],
            [
                {
                    "expression": "(m1+m2)/2",
                    "id": "e1",
                    "label": "Half way between average and median",
                    "visible": true,
                    "color": "#000000",
                    "yAxis": "left"
                }
            ],
            [
                {
                    "expression": "RATE(e1)",
                    "yAxis": "right",
                    "label": "rate of change of the half way point"
                }
            ]
        ]
    }

Un même graphique peut comporter plusieurs annotations horizontales et verticales. Toutes les annotations horizontales sont spécifiées dans un horizontal champ, et toutes les annotations verticales sont spécifiées dans un vertical champ.

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 seule annotation. Chaque annotation horizontale du tableau qui ne comporte pas d'ombrage de bande a le format suivant :


{value, label, color, fill, yAxis, visible}

Chaque annotation horizontale comportant un ombrage de bande a le format suivant :


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

vertical

Un ensemble d'annotations verticales. Les annotations verticales proposent plusieurs options d'ombrage de fond, notamment l'ombrage avant la ligne d'annotation, l'ombrage après 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 verticale du tableau qui ne comporte pas d'ombrage de bande a le format suivant :


{value, label, color, fill, visible}

Chaque annotation verticale comportant un ombrage de bande a le format suivant :


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

Le horizontal tableau peut inclure les champs suivants.

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 pour 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, si des annotations horizontales sont utilisées.

é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

Le vertical tableau peut inclure les champs suivants.

value

Horodatage où la ligne d'annotation verticale doit apparaître. Cela doit être spécifié sous forme d'horodatage absolu, tel que2018-08-28T15:25:26Z. 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.

Type : Chaîne

Obligatoire : Oui, si des annotations verticales sont utilisées.

étiquette

Chaîne descriptive 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

Exemples


// 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 horizontal band annotation. Each value has a label, but other parameters for the band need to be 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"
              }
         ]
     ]
}

// 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 vertical band 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"
            }
        ]
    ]
}

Définit les valeurs minimale et maximale Y-axis du graphique. Définissez ce paramètre dans l'MetricWidgetobjet pour affecter toutes les mesures du widget. Pour remplacer les paramètres du widget pour une métrique particulière, définissez-la dans l'objet d'options correspondant à cette métrique dans le metrics tableau.

gauche

Facultatif min et max paramètres pour la gauche Y-axis.

Type : objet YAxis

Obligatoire : non

droite

Facultatif min et max paramètres pour le droit Y-axis.

Type : objet YAxis

Obligatoire : non

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

min

La valeur minimale pour cela Y-axis.

Type : Float

Obligatoire : non

max

La valeur maximale pour cela Y-axis.

Type : Float

Obligatoire : non

Exemple


{
  left: {
    min: 0,
    max: 100
  },
  right: {
    min: 0
  }
}

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Créer une alerte à partir d'une métrique sur un graphique

Utilisation de la détection d'anomalies