GetMetricWidgetImage: Struttura e sintassi del widget metrico

MetricWidgetè un parametro di input per l'https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricWidgetImage.htmlAPI. È una stringa in formato JSON.

Struttura generale

La MetricWidget stringa può includere i seguenti parametri:

metriche

Le metriche da includere nel grafico, come metrics matrice. Ciò può includere sia espressioni matematiche metriche non elaborate che metriche. Un metrics array può includere da 1 a 100 metriche ed espressioni. Per ulteriori informazioni sul formato di, vedere. metrics Formato per ogni metrica nell'array di metriche

Tipo: matrice di matrici

Obbligatorio: sì.

annotations

Le annotazioni orizzontali e verticali da aggiungere al grafico, come matrici di annotazioni. Per ulteriori informazioni sul formato, vedere. Formato delle proprietà delle annotazioni

Obbligatorio: no

end

La data e l'ora della fine delle metriche mostrate nel grafico. Può essere espresso come valore assoluto, ad esempio 2018-04-25 T12:00:00.000Z o come valore relativo come -PID.

Se non si specificaend, viene utilizzato il valore predefinito di -PT0H (l'ora corrente).

▬Tipo: stringa

Obbligatorio: no

height

L'altezza del widget in pixel. Il valore predefinito è 400.

Valori validi: 1—2000

Tipo: numero intero

Obbligatorio: No, ma è necessario impostarlo se si imposta anche un valore per. width

mito

Speciifica la posizione e la visibilità della legenda del grafico. legendcontiene un campo,position. Il valore di position può essere bottom, right o hidden. Il valore predefinito è bottom.

▬Tipo: stringa

Obbligatorio: no

Dati in tempo reale

trueSpecificare di visualizzare i dati in tempo reale nel widget. I dati in tempo reale sono dati pubblicati all'ultimo minuto che non sono stati completamente aggregati. Per ulteriori informazioni, consulta Use Live Data.

Tipo: Booleano

Obbligatorio: no

punto

Il periodo predefinito, in secondi, per tutte le metriche in questo widget. Questa impostazione predefinita può essere sostituita all'interno di ogni definizione di metrica. Il valore predefinito è 300.

Valori validi: 1, 5, 10, 30, 60 e qualsiasi multiplo di 60. 1, 5, 10 e 30 sono solo per metriche ad alta risoluzione.

Tipo: Integer

Obbligatorio: no

region

Questo parametro è facoltativo. Se lo includi, deve specificare la regione locale.

▬Tipo: stringa

Obbligatorio: no

a barre in pila

Specificate true di visualizzare il grafico come una linea in false pila o di visualizzarlo come linee separate. Il valore predefinito è false.

Tipo: Booleano

Obbligatorio: no

rapida

La data e l'ora di inizio delle metriche mostrate nel grafico. Può essere espresso come valore assoluto, ad esempio 2018-04-25 T12:00:00.000Z o come valore relativo come -PID.

Se non lo specifichistart, viene utilizzato il valore predefinito di -PT3H (tre ore fa).

▬Tipo: stringa

Obbligatorio: no

stat

La statistica predefinita da visualizzare per ogni metrica nell'array. Questa impostazione predefinita può essere sostituita all'interno della definizione di ogni singola metrica dell'array. metrics

Se lo ometti, verrà utilizzato il valore predefinito Average.

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

Tipo: Stringa che è una CloudWatch statistica valida.

Obbligatorio: no

tema

La tavolozza dei colori usata per definire lo stile del grafico. Il valore predefinito è light.

Valori validi: light | dark

▬Tipo: stringa

Obbligatorio: no

timezone

Il fuso orario da utilizzare per visualizzare gli orari nel grafico. Il formato è + o - seguito da quattro cifre. Le prime due cifre indicano il numero di ore in anticipo o in ritardo rispetto all'UTC e le ultime due cifre indicano il numero di minuti. Ad esempio, +0130 indica un orario precedente di 1 ora e 30 minuti rispetto all'UTC. Il valore predefinito è +0000.

▬Tipo: stringa

Obbligatorio: no

titolo

Il titolo da visualizzare per il grafico.

▬Tipo: stringa

Obbligatorio: no

visualizzazione

Il formato di visualizzazione. timeSeriesSpecificate di visualizzare questa metrica come grafico a linee. barSpecificate di visualizzare la metrica come grafico a barre. pieSpecificate di visualizzare la metrica come grafico a torta. Il valore predefinito è timeSeries.

Valori validi: timeSeries | bar | pie

▬Tipo: stringa

Obbligatorio: no

width

La larghezza del widget in pixel. L'impostazione predefinita è 600.

Valori validi: 1—2000

Tipo: numero intero

Obbligatorio: No, ma è necessario impostarlo se si imposta anche un valore per. width

Asse y

Limiti per i minimi e i massimi dell'asse y. Questo vale per ogni metrica rappresentata graficamente, a meno che metriche specifiche non la sostituiscano. Per ulteriori informazioni sul formato, consulta. Formato delle proprietà yAxis

Tipo: oggetto yAxis

Obbligatorio: no

Formato per ogni metrica nell'array di metriche

Ogni elemento dell'metricsarray è una CloudWatch metrica da visualizzare nel grafico o da utilizzare come parte di un'espressione matematica visualizzata nel grafico. Per ulteriori informazioni sulle espressioni matematiche, consulta Use Metric Math nella Amazon CloudWatch User Guide.

Ogni metrica dell'array ha il seguente formato:

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

Namespace

Lo spazio dei AWS nomi contenente la metrica. Per utilizzare lo stesso spazio dei nomi della metrica precedente nell'array, puoi specificare "." per ogni voce dopo la prima.

Tipo: stringa

Obbligatorio: sì

MetricName

Il nome della metrica. CloudWatch Per utilizzare lo stesso nome della metrica precedente nell'array, puoi specificare "." per ogni voce dopo la prima.

Tipo: stringa

Obbligatorio: sì

DimensionName

Il nome di una dimensione per rifinire ulteriormente i dati visualizzati. Per utilizzare lo stesso nome di dimensione della metrica precedente nell'array, puoi specificare "." per ogni voce dopo la prima. È possibile specificare zero dimensioni per una metrica o fino a tante dimensioni quante sono supportate dalla metrica.

▬Tipo: stringa

Obbligatorio: no

DimensionValue

Il valore da usare per quella dimensione per la metrica. Obbligatorio se esiste un nome di dimensione corrispondente.

Tipo: String

Obbligatorio: No, a meno che non sia presente un nome di dimensione corrispondente.

Oggetto Options

Specifica le proprietà di rendering personalizzate da utilizzare per la CloudWatch metrica specificata o un'espressione matematica da visualizzare sul grafico. Per ulteriori informazioni sul formato, vedere. Opzioni: formato dell'oggetto

Tipo: oggetto Options

Obbligatorio: no

Esempi

// 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" ]

Opzioni: formato dell'oggetto

Specifica le proprietà di rendering personalizzate da utilizzare per la CloudWatch metrica specificata o un'espressione matematica da visualizzare sul grafico.

Se questo oggetto viene specificato come parte di una CloudWatch metrica nell'metricsarray, imposta proprietà di rendering personalizzate per questa metrica e sostituisce i valori predefiniti utilizzati per l'intero grafico.

È inoltre possibile specificare questo oggetto per aggiungere un'espressione matematica al grafico. In questo caso, le altre impostazioni di questo oggetto specificano le opzioni di visualizzazione per il risultato dell'espressione matematica.

Questa sezione descrive il formato di questi oggetti opzionali.

color

Il codice colore esadecimale HTML a sei cifre da utilizzare per questa metrica o espressione.

▬Tipo: stringa

Obbligatorio: no

expression

Un'espressione matematica da visualizzare. Per ulteriori informazioni sulle funzioni e sul formato delle espressioni matematiche supportati, consulta Metric Math Syntax and Functions nella Amazon User Guide. CloudWatch

Tipo: Stringa che è un'espressione matematica metrica valida CloudWatch .

Obbligatorio: Sì se si tratta di un'espressione.

etichetta

L'etichetta da visualizzare per questa metrica o espressione nella legenda del grafico. Se questo non è specificato, alla metrica viene assegnata un'etichetta generata automaticamente che la distingue dalle altre metriche del widget.

▬Tipo: stringa

Obbligatorio: no

id

Un identificatore per questa metrica o espressione, che deve essere univoco all'interno di questo widget. L'id può essere usato come variabile per rappresentare questa metrica o espressione all'interno di espressioni matematiche. I caratteri validi sono lettere, numeri e trattini bassi. Il primo carattere deve essere una lettera minuscola.

▬Tipo: stringa

Obbligatorio: no

punto

Periodo per questa metrica, in secondi. Se specificato, questo sostituisce il periodo predefinito utilizzato per altre metriche in questo grafico. Questo parametro non è applicabile alle espressioni matematiche.

Valori validi: 1, 5, 10, 30, 60 e qualsiasi multiplo di 60. 1, 5, 10 e 30 sono solo per metriche ad alta risoluzione.

Tipo: Integer

Obbligatorio: no

stat

La statistica da visualizzare per questa metrica, se deve essere diversa dalla statistica utilizzata per le altre metriche nel grafico. Questo parametro non è applicabile alle espressioni matematiche.

Valori validi: SampleCount | Average | Sum | Minimum | Maximum | p??

Tipo: stringa che è una CloudWatch statistica valida.

Obbligatorio: no

visible

Speciifica se questa metrica o espressione viene mostrata nel grafico. Il valore predefinito è true.

L'impostazione visible su false è utile se si desidera nascondere le metriche non elaborate utilizzate nelle espressioni matematiche e mostrare solo i risultati delle espressioni sul grafico.

Tipo: Booleano

Obbligatorio: no

Asse y

Punto del grafico in cui visualizzare l'asse y per questa metrica o espressione. Il valore predefinito è left.

Valori validi: left | right

▬Tipo: stringa

Obbligatorio: no

Esempio

Nell'esempio seguente, CloudWatch recupera una metrica personalizzata. apiLatency Nella parte superiore, viene specificata la statistica p50 per mostrare il valore mediano. Successivamente, per la stessa metrica sulla stessa istanza (questo è specificato dai quattro campi che sono solo periodi), viene rappresentato graficamente il valore medio. Il prossimo è un oggetto di opzioni con un'espressione matematica, che mostra il valore intermedio delle due metriche. Infine, un'altra espressione mostra la velocità di variazione.

Per mostrare solo i risultati delle due espressioni sul grafico e nascondere le metriche non elaborate, puoi modificare le prime due istanze di visible to. false

{
        "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"
                }
            ]
        ]
    }

Formato delle proprietà delle annotazioni

Un singolo grafico può avere più annotazioni orizzontali e verticali. Tutte le annotazioni orizzontali sono specificate in un horizontal campo e tutte le annotazioni verticali sono specificate in un campo. vertical

orizzontale

Una serie di annotazioni orizzontali. Le annotazioni orizzontali hanno diverse opzioni per l'ombreggiatura di riempimento, tra cui l'ombreggiatura sopra la riga di annotazione, l'ombreggiatura sotto la riga di annotazione e l'ombreggiatura «a banda» che appare tra due righe di annotazione collegate come parte di una singola annotazione. Ogni annotazione orizzontale nell'array che non presenta ombreggiatura a banda ha il seguente formato:

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

Ogni annotazione orizzontale che presenta un'ombreggiatura a banda ha il seguente formato:

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

verticale

Una serie di annotazioni verticali. Le annotazioni verticali hanno diverse opzioni per l'ombreggiatura di riempimento, tra cui l'ombreggiatura prima della riga di annotazione, l'ombreggiatura dopo la riga di annotazione e l'ombreggiatura «a banda» che appare tra due righe di annotazione collegate come parte di un'annotazione a banda singola. Ogni annotazione verticale nell'array che non presenta ombreggiatura a bande ha il seguente formato:

{value, label, color, fill, visible}

Ogni annotazione verticale che presenta un'ombreggiatura a bande ha il seguente formato:

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

L'horizontalarray può includere i seguenti campi.

value

Il valore metrico nel grafico in cui deve apparire la linea di annotazione orizzontale. In un'annotazione di ombreggiatura a banda, i due valori di Value definiscono i bordi superiore e inferiore della banda.

In un grafico con annotazioni orizzontali, il grafico viene ridimensionato in modo che tutte le annotazioni orizzontali visibili appaiano sul grafico.

Tipo: Float

Obbligatorio: Sì, se vengono utilizzate annotazioni orizzontali.

etichetta

Una stringa che appare nel grafico accanto all'annotazione.

▬Tipo: stringa

Obbligatorio: no

color

Il codice colore esadecimale HTML a sei cifre da utilizzare per l'annotazione. Questo colore viene utilizzato sia per la riga di annotazione che per l'ombreggiatura di riempimento.

▬Tipo: stringa

Obbligatorio: no

riempire

Come usare l'ombreggiatura di riempimento con l'annotazione. I valori validi sono above per l'ombreggiatura sopra l'annotazione, below per l'ombreggiatura al di sotto dell'annotazione e per nessuna ombreggiatura. none Se fill viene omesso, non c'è ombreggiatura.

L'eccezione è un'annotazione con ombreggiatura a banda. Queste annotazioni presentano sempre un'ombreggiatura tra i due valori e qualsiasi valore per viene ignorato. fill

▬Tipo: stringa

Obbligatorio: no

visible

Imposta questa true opzione per far apparire l'annotazione nel grafico o false per nasconderla. Il valore predefinito è true.

Tipo: Booleano

Obbligatorio: no

Asse y

Se il grafico include più metriche, specifica se i numeri si Value riferiscono alla metrica associata a sinistra Y-axis o a destra. Y-axis I valori validi sono right e left.

▬Tipo: stringa

Obbligatorio: no

L'verticalarray può includere i seguenti campi.

value

Il timestamp in cui deve apparire la riga di annotazione verticale. Questo deve essere specificato come timestamp assoluto, ad esempio. 2018-08-28T15:25:26Z In un'annotazione di ombreggiatura a banda, i due valori di Value definiscono i bordi iniziale e finale della banda.

Tipo: String

Obbligatorio: Sì, se vengono utilizzate annotazioni verticali.

etichetta

Una stringa descrittiva che appare nel grafico accanto all'annotazione.

▬Tipo: stringa

Obbligatorio: no

color

Il codice colore esadecimale HTML a sei cifre da utilizzare per l'annotazione. Questo colore viene utilizzato sia per la riga di annotazione che per l'ombreggiatura di riempimento.

▬Tipo: stringa

Obbligatorio: no

riempire

Come usare l'ombreggiatura di riempimento con l'annotazione. I valori validi sono before per l'ombreggiatura prima dell'annotazione, after per l'ombreggiatura dopo l'annotazione e per l'assenza di ombreggiatura. none Se fill viene omesso, non c'è ombreggiatura.

L'eccezione è un'annotazione con ombreggiatura a banda. Queste annotazioni presentano sempre un'ombreggiatura tra i due valori e qualsiasi valore per viene ignorato. fill

▬Tipo: stringa

Obbligatorio: no

visible

Imposta questa true opzione per far apparire l'annotazione nel grafico o false per nasconderla. Il valore predefinito è true.

Tipo: Booleano

Obbligatorio: no

Esempi

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

Formato delle proprietà yAxis

Definisce i valori minimo e massimo per Y-axis il grafico. Impostalo all'interno dell'MetricWidgetoggetto per influire su tutte le metriche del widget. Per sovrascrivere le impostazioni del widget per una particolare metrica, impostala nell'oggetto options relativo a quella metrica nell'array. metrics

sinistra

Opzionale min e max impostazioni per la sinistra. Y-axis

Tipo: oggetto yAxis

Obbligatorio: no

destra

Opzionale min e max impostazioni per la destra. Y-axis

Tipo: oggetto yAxis

Obbligatorio: no

Ciascuno degli right oggetti left e può includere i seguenti parametri:

min

Il valore minimo per questo Y-axis.

Tipo: Float

Obbligatorio: no

max

Il valore massimo per questo Y-axis.

Tipo: Float

Obbligatorio: no

Esempio

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