View a markdown version of this page

Struttura e sintassi del corpo del dashboard - Amazon CloudWatch

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Struttura e sintassi del corpo del dashboard

Struttura generale

A DashboardBody è una stringa in formato JSON. Può includere una serie di oggetti widget da 0 a 500, oltre ad alcuni altri parametri. La dashboard deve includere un widgets array, ma tale array può essere vuoto.

Di seguito è riportato un esempio di questa struttura con un widget metrico e un widget di testo, un intervallo di tempo che inizia sei ore prima dell'ora corrente e l'impostazione del periodo di ciascun grafico viene sempre rispettata.

{ "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'esempio successivo mostra tre metriche Lambda per funzione e utilizza una variabile dashboard in modo che gli utenti del dashboard possano passare da un nome di funzione Lambda all'altro e visualizzare tutte e tre le metriche per ciascuna funzione. Questo ti aiuta a creare un'unica dashboard flessibile in grado di visualizzare le metriche chiave per diverse risorse. In questo esempio le funzioni vengono scoperte da una query di ricerca metrica, quindi la dashboard rileva automaticamente le nuove funzioni Lambda quando vengono create.

{ "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'esempio successivo ha due widget. La prima include due metriche e un'espressione matematica che ne somma il totale. Il secondo widget è un'espressione di ricerca che mostra il CPUUtilization valore di tutte le istanze EC2 nella regione.

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

Il resto di questa sezione include esempi che illustrano ogni parte della sintassi. DashboardBody Per altri esempi che mostrano l'intera sintassi dei comandi, consulta Amazon CloudWatch API PutDashboard Reference.

Il livello superiore dell'oggetto JSON può includere le seguenti proprietà.

widget

L'elenco dei widget nella dashboard. Per ulteriori informazioni, consulta Struttura dell'array dei widget.

Obbligatorio: sì

variables

L'array di oggetti variabili del dashboard utilizzati nel dashboard. Per ulteriori informazioni sui campi che è possibile utilizzare in ogni oggetto variabile del dashboard, vedereStruttura dell'array di variabili.

Per ulteriori informazioni sulle variabili del dashboard, consulta Creare dashboard flessibili con variabili di dashboard.

Se includi un variables array, può contenere da 0 a 25 oggetti variabili.

Obbligatorio: no

end

La fine dell'intervallo di tempo da utilizzare per ogni widget sulla dashboard quando la dashboard viene caricata. Se specifichi un valore per end, devi specificare anche un valore per start. Per ognuno di questi valori, specifica un'ora assoluta nel formato ISO 8601. Ad esempio, 2018-12-17T06:00:00.000Z.

▬Tipo: stringa

Obbligatorio: no

rapida

L'inizio dell'intervallo di tempo da utilizzare per ogni widget sulla dashboard.

È possibile specificare start senza specificare di end specificare un intervallo di tempo relativo che termina con l'ora corrente. In questo caso, il valore di start deve iniziare con -PT se si specifica un intervallo di tempo in minuti o ore e deve iniziare con -P se si specifica un intervallo di tempo in giorni, settimane o mesi. È quindi possibile utilizzare M, H, D, W e M come abbreviazioni per minuti, ore, giorni, settimane e mesi. Ad esempio, -PT5M mostra gli ultimi 5 minuti, -PT8H mostra le ultime 8 ore e -P3M mostra gli ultimi tre mesi.

È inoltre possibile utilizzare, start insieme a un end campo, per specificare un intervallo di tempo assoluto. Quando si specifica un intervallo di tempo assoluto, utilizzare il formato ISO 8601. Ad esempio, 2018-12-17T06:00:00.000Z.

Se si omettestart, la dashboard mostra l'intervallo di tempo predefinito al momento del caricamento.

▬Tipo: stringa

Obbligatorio: no

PeriodOverride

Usa questo campo per specificare il periodo per i grafici al momento del caricamento del dashboard. La specificazione auto fa sì che il periodo di tutti i grafici sul dashboard si adatti automaticamente all'intervallo di tempo del dashboard. La specificazione inherit garantisce che il periodo impostato per ogni grafico venga sempre rispettato.

Valori validi: auto | inherit

▬Tipo: stringa

Obbligatorio: no

Struttura dell'array dei widget

Ogni widget di qualsiasi tipo può avere le seguenti proprietà.

tipo

Il tipo di widget.

Valori validi: metric | text | log | alarm | explorer | chart

Tipo: stringa

Obbligatorio: sì

x

La posizione orizzontale del widget sulla griglia del dashboard a 24 colonne. L'impostazione predefinita è la prossima posizione disponibile.

Valori validi: 0—23

Tipo: numero intero

Obbligatorio: Sì, se specificatoy. Altrimenti non richiesto.

y

La posizione verticale del widget sulla griglia del dashboard a 24 colonne. L'impostazione predefinita è la prossima posizione disponibile.

Valori validi: qualsiasi numero intero, 0 o superiore.

Tipo: numero intero

Obbligatorio: Sì, se x specificato. Altrimenti non richiesto.

width

La larghezza del widget in unità della griglia (in una griglia a 24 colonne). L'impostazione predefinita è 6.

Valori validi: 1—24

Tipo: Integer

Obbligatorio: no

height

L'altezza del widget in unità della griglia. L'impostazione predefinita è 6.

Valori validi: 1—1000

Tipo: Integer

Obbligatorio: no

properties

Le proprietà dettagliate del widget, che variano a seconda del tipo di widget. Per ulteriori informazioni sul formato diproperties, vedereProprietà di un oggetto Metric Widget,Proprietà di un oggetto Chart Widget, oProprietà di un oggetto Text Widget.

Tipo: oggetto

Obbligatorio: sì

Struttura dell'array di variabili

Ogni variabile del dashboard nell'array può avere le seguenti proprietà.

tipo

Il tipo di variabile del dashboard. CloudWatch supporta due tipi, variabili di proprietà e variabili di modello.

Le variabili di proprietà modificano i valori di tutte le istanze di una proprietà in tutti i widget della dashboard. Una proprietà può essere una delle seguenti:

  • Qualsiasi proprietà JSON nelle definizioni dei widget, ad esempioregion.

  • Qualsiasi nome di dimensione per una metrica, ad esempio InstanceId o. FunctionName

Una variabile pattern modifica un pattern di espressione regolare nel JSON del dashboard. Usala quando devi modificare solo una parte del valore di una proprietà JSON, o anche una proprietà JSON.

Le variabili di proprietà si applicano alla maggior parte dei casi d'uso e sono meno complesse da configurare.

Valori validi: property | pattern

Tipo: stringa

Obbligatorio: sì

inputType

Determina in che modo l'utente del dashboard inserisce il valore per la variabile.

  • Specifica input di utilizzare una casella di testo in cui l'utente può immettere valori.

  • Specifica select di utilizzare un set di valori a discesa da te definito o un elenco a discesa di valori trovati da una query di ricerca metrica.

  • Specifica di radio utilizzare un set di pulsanti di opzione, con valori che definisci o che trovi con una query di ricerca metrica.

Valori validi: input | select | radio

Tipo: stringa

Obbligatorio: sì

values

Se sei select o radio vuoi definire i inputType possibili valori delle variabili invece di utilizzare una ricerca tramite query metriche, specifica tali valori qui.

valuesè un array in cui ogni oggetto dell'array contiene un valore obbligatorio e un'etichetta opzionale. Ogni valore può essere una stringa, un numero o un valore booleano e ogni etichetta deve essere una stringa. Ciascuno di questi valori ed etichette può contenere fino a 255 caratteri.

Se si specifica un values array, questo deve includere almeno un elemento e può includere fino a 500.

Ad esempio, quanto segue crea un elenco di tre possibili regioni da utilizzare come valori per una variabile.

"values": [ { "label": "US East (IAD)", "value": "us-east-1" }, { "label": "US West (SFO)", "value": "us-west-1" }, { "label": "EU (DUB)", "value": "eu-west-1" } ]

Tipo: Array

Obbligatorio: Sì se inputType è select o radio e non stai utilizzando una query di ricerca metrica per compilare i valori.

id

Un ID per questa variabile. Può contenere fino a 32 caratteri e i caratteri validi sono 0-9A-Za-z-_

Tipo: stringa

Obbligatorio: sì

etichetta

Un'etichetta da visualizzare per il campo di immissione. Può contenere fino a 30 caratteri.

Se si omette questo campo per una variabile di proprietà, il nome della proprietà viene visualizzato come etichetta. Se lo si omette per una variabile modello, pattern_1, pattern_2, ... viene utilizzato per l'etichetta.

▬Tipo: stringa

Obbligatorio: no

defaultValue

Il valore predefinito per la variabile, quando il dashboard viene aperto per la prima volta.

  • In caso inputType input affermativo, è necessario specificarlo defaultValue qui manualmente e utilizzare fino a 255 caratteri

  • Se inputType è select oradio, è necessario specificare un possibile valore valido specificato nell'valuesarray o recuperato nella ricerca tramite query metrica.

Valori validi: qualsiasi valore valido per questa variabile

Tipo: stringa, numero o booleano, a seconda del valore del tipo per questa variabile

Obbligatorio: no

cerca

Specifica questo campo per compilare il tuo campo select o quello radio di input utilizzando un'espressione di ricerca metrica. Per il valore di questo campo, specifica uno spazio dei nomi, un nome di dimensione e un nome di metrica. La dimensione specificata deve essere valida per quella metrica. CloudWatch trova tutte le risorse che pubblicano la metrica e la dimensione e le inserisce nell'elenco.

Ad esempio, specifica "search": "{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\"" di cercare le istanze Amazon EC2 nell'account o specifica di restituire le funzioni "search": "{AWS/Lambda,FunctionName} MetricName=\"Duration\"", Lambda nell'account

La search stringa specificata può contenere fino a 2048 caratteri.

Nota

Se si utilizza un'espressione di ricerca e si desidera specificare anche un valore predefinito, defaultValue viene utilizzato il valore predefinito in cui si specifica, purché tale valore predefinito sia una delle risorse recuperate dalla ricerca. Quando si utilizza un'espressione di ricerca per compilare il campo di input, è inoltre possibile specificare il valore speciale __FIRST perdefaultValue, in modo che il valore predefinito sia il primo valore restituito dalla ricerca. (Il valore speciale include due caratteri di sottolineatura e quindi PRIMO) I valori restituiti dalla ricerca vengono sempre ordinati alfabeticamente.

Tipo: String

Obbligatorio: Sì se inputType è select o radio e non stai specificando. values

Compila da

Se si utilizza il search campo per compilare il campo di input utilizzando un'espressione di ricerca, specificare questo campo con il nome di una dimensione che verrà recuperata dalla ricerca.

Ad esempio, se il tuo search valore è"search": "{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\"", puoi specificare InstanceId per. populateFrom

Tipo: String

Obbligatorio: Sì se inputType è select o radio e non lo stai specificando. values

visible

Specifica se l'etichetta e il campo di input sono visibili nel pannello di controllo. Se lo ometti, verrà utilizzato il valore predefinito true.

L'utilizzo false consente di risparmiare spazio sulla dashboard, ma richiede all'utente di modificare l'URL del dashboard per modificare i valori delle variabili.

Tipo: Booleano

Obbligatorio: no

Esempi di variabili

L'esempio seguente utilizza una variabile di proprietà per modificare la regione di tutti i widget, utilizzando un campo di immissione di testo. Quando la dashboard viene aperta per la prima volta, per la variabile us-east-1 viene utilizzato il valore predefinito di.

"variables": [ { "type": "property", "property": "region", "inputType": "input", "id": "region", "label": "Region", "defaultValue": "us-east-1", "visible": true } ],

L'esempio seguente utilizza una variabile pattern per modificare la regione di tutti i widget, nel caso in cui a volte la regione sia impostata al centro di una stringa come un ARN.

"variables": [ { "type": "pattern", "pattern": "us-east-1", "inputType": "input", "id": "region", "label": "Region", "defaultValue": "us-east-1", "visible": true } ],

L'esempio seguente genera una variabile di funzione Lambda, con un pulsante di opzione per ogni funzione. Le funzioni vengono scoperte mediante una ricerca con query metriche.

"variables": [ { "type": "pattern", "pattern": "originalFuncNameInDashboard", "inputType": "radio", "id": "functionName", "label": "Function", "visible": true, "search": "{AWS/Lambda,FunctionName} MetricName=\"Duration\"", "populateFrom": "FunctionName", "defaultValue": "__FIRST" } ],

L'esempio seguente mostra come specificare più variabili in una dashboard e illustra diversi tipi di variabili.

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

Proprietà di un oggetto Text Widget

Un widget di tipo text può avere uno o due parametri nella properties sezione. Il markdown campo è obbligatorio e il transparent campo è facoltativo.

Per ulteriori informazioni sullo stile di markdown supportato nei widget di CloudWatch testo, vedi Utilizzo di Markdown nella console.

markdown

Il testo che deve essere visualizzato dal widget. Utilizzate questo parametro solo per i widget di testo.

Tipo: String

Obbligatorio: Sì (quando il widget type ètext).

sfondo

Specifica se il widget di testo ha uno sfondo solido o trasparente. Il valore transparent rende il widget trasparente. Il valore solid è quello predefinito.

▬Tipo: stringa

Obbligatorio: no

{ "widgets":[ { "type":"text", "x":0, "y":7, "width":3, "height":3, "properties":{ "markdown":"Hello world", "background": "transparent" } } ] }

Proprietà di un oggetto Log Widget

Un widget di tipo log rappresenta i risultati di una query CloudWatch Logs Insights. Per ulteriori informazioni, consulta Analisi dei dati di registro con CloudWatch Logs Insights.

Un log widget può includere i seguenti campi nel suo properties campo.

accountId

L'ID dell' AWS account che contiene i log, se si tratta di una query tra account.

▬Tipo: stringa

Obbligatorio: no

region

La regione della richiesta dei log.

Tipo: stringa

Obbligatorio: sì

titolo

Il testo del titolo che deve essere visualizzato dal widget.

▬Tipo: stringa

Obbligatorio: no

query

Contiene la funzione di interrogazione CloudWatch Logs Insights.

Tipo: String

Obbligatorio: Sì (quando il widget type èlog).

La query stringa inizia con i nomi dei gruppi di log da interrogare. È necessario anteporre il nome di ogni gruppo di log con. SOURCE Separa più gruppi di log con un carattere pipe (|).

Aggiungete un altro carattere pipe dopo l'elenco dei gruppi di log, quindi specificate la sintassi della query. Separate ogni riga della sintassi della query con \n|

Ad esempio, la riga seguente rappresenta una query di due gruppi di log service_log1 eservice_log2. La query visualizza i canarini con errori.

"query": "SOURCE 'service_log1' | SOURCE 'service_log2' |filter Fault > 0\n| fields Fault.Message\n| stats count(*) by Canary.Name, Fault.Message"
visualizzazione

Specifica come vengono visualizzati i risultati dell'interrogazione. Specifica table di visualizzare i risultati come tabella. timeSeriesSpecificate di visualizzare questa metrica come grafico a linee. barSpecificate di visualizzarla come grafico a barre. pieSpecificate di visualizzarlo come grafico a torta.

Se si omette questo parametro, i risultati vengono visualizzati come tabella.

Tipo: String

Obbligatorio: No (se il widget lo type èlog).

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

Proprietà di un oggetto Metric Widget

Un widget di tipo metric può contenere i seguenti properties campi:

accountId

Specifica l'ID AWS dell'account da cui provengono tutte le metriche di questo widget. Ciò è utile per le dashboard multiaccount che includono widget di più account. Per ulteriori informazioni, consulta Console Cross-Account Cross-Region CloudWatch .

Se lo ometti, l'account corrente viene utilizzato come predefinito. Utilizzate questo parametro solo per i widget metrici.

Puoi anche utilizzare un accountId campo all'interno di ciascuna metrica dell'array di metrics per creare un singolo widget che includa le metriche di più account.

▬Tipo: stringa

Obbligatorio: no

annotations

Per includere un avviso o un'annotazione nel widget, specifica un array. annotations Per ulteriori informazioni sul formato, vedereOggetto Dashboard Widget: proprietà delle annotazioni. Utilizzate questo parametro solo per i widget metrici.

Tipo: oggetto

Obbligatorio: un'annotazione di allarme è richiesta solo quando il widget type è specificato metric e non metrics è specificato. Non è richiesta un'annotazione orizzontale o verticale.

Dati in tempo reale

Specifica true 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 Usare i dati in tempo reale.

Tipo: Booleano

Obbligatorio: no

mito

Specifica legend per determinare dove viene visualizzata la legenda per le linee del grafico. Il legend campo contiene un altro campo chiamatoposition. I valori possibili per position sono rightbottom, ehidden.

Ad esempio, quanto segue fa apparire la legenda sulla destra del grafico.

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

Tipo: oggetto

Obbligatorio: no

metriche

Specificate un metrics array per includere una o più metriche (senza allarmi), una query Metrics Insights, espressioni matematiche o espressioni di ricerca. Un metrics array può includere da 0 a 500 metriche ed espressioni. Utilizzate questo parametro solo per i widget metrici. Per ulteriori informazioni sul formato dimetrics, vedere. Widget metrico: formato per ogni metrica nell'array

Un array di metriche può includere non più di una query di Metrics Insights.

Un singolo expression campo non può includere sia una query Metrics Insights che un'espressione matematica. Tuttavia, puoi utilizzare i risultati restituiti da una query di Metrics Insights da un'espressione come input in un'espressione matematica in un'espressione diversa nell'array.

Tipo: matrice di matrici

Obbligatorio: Sì, quando il widget type è metric e non annotations è specificato.

punto

Il periodo predefinito, in secondi, per tutte le metriche di questo widget. Il periodo è il periodo di tempo rappresentato da un punto dati sul grafico. Questa impostazione predefinita può essere sovrascritta all'interno di ciascuna definizione di metrica. Utilizzate questo parametro solo per i widget delle metriche. Il valore predefinito è 300.

Valori validi: qualsiasi multiplo di 60, con 60 come minimo.

Tipo: Integer

Obbligatorio: no

region

La regione della metrica.

Tipo: stringa

Obbligatorio: sì

sparkline

Specifica true di visualizzare la funzione sparkline sotto il widget numerico. falseSpecificate di visualizzare il widget numerico da solo. Questo parametro viene ignorato se view non singleValue lo è. Utilizzate questo parametro solo per i widget metrici.

Tipo: Booleano

Obbligatorio: no

a barre in pila

trueSpecificate di visualizzare il grafico come linea sovrapposta o false come linee separate. Questo parametro viene ignorato se view lo è. singleValue Utilizzate questo parametro solo per i widget metrici.

Tipo: Booleano

Obbligatorio: no

stat

La statistica predefinita da visualizzare per ogni metrica dell'array. Questa impostazione predefinita può essere sovrascritta all'interno della definizione di ogni singola metrica dell'array. metrics Utilizzate questo parametro solo per i widget delle metriche.

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

Tipo: stringa che è una statistica valida CloudWatch .

Obbligatorio: no

table

Includi una table sezione per includere nel widget le modifiche relative alla tabella di dati. Per ulteriori informazioni sul formato, vedere. Oggetto Dashboard Widget: proprietà della tabella

Tipo: oggetto

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 avanti o indietro rispetto all'UTC e le ultime due cifre indicano il numero di minuti. Ad esempio, +0130 indica un'ora e 30 minuti in anticipo rispetto all'UTC. Il valore predefinito è +0000.

▬Tipo: stringa

Obbligatorio: no

titolo

Il titolo da visualizzare per il grafico o il numero. Utilizzate questo parametro solo per i widget metrici.

▬Tipo: stringa

Obbligatorio: no

visualizzazione

Specificate timeSeries di visualizzare questa metrica come grafico a linee o ad area sovrapposta. Specificate singleValue di visualizzare questa metrica come grafico numerico. gaugeSpecificate di visualizzare questa metrica come grafico indicativo. Specificate bar di visualizzare questa metrica come grafico a barre. pieSpecificate di visualizzare questa metrica come grafico a torta.

Nota

Se si specificagauge, è necessario impostare un valore per min e max sul lato sinistro diyAxis.

Valori validi: timeSeries | singleValue | gauge | bar | pie | table

▬Tipo: stringa

Obbligatorio: no

Asse Y

I valori minimi e massimi per il lato sinistro e destro di un grafico. Y-axis Questa proprietà si applica a tutte le metriche grafiche, ad eccezione delle metriche specifiche che sovrascrivono questa impostazione. Per ulteriori informazioni, consulta Oggetto del widget del dashboard: yAxis Properties Format.

Tipo: oggetto YAxis

Obbligatorio: no

Esempio: widget per aree e indicatori in pila

{ "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 metrico: formato per ogni metrica nell'array

Ogni elemento dell'metricsarray è una singola metrica o un'espressione matematica o un'espressione di ricerca. Ogni singola metrica dell'metricsarray ha il seguente formato:

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

Ogni espressione nell'metricsarray ha il seguente formato:

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

Specifica l'ID AWS dell'account da cui proviene questa metrica. Ciò consente di creare un widget che contiene le metriche di più account su una dashboard con più account. Per ulteriori informazioni, consulta Console Cross-Account Cross-Region CloudWatch .

Se lo ometti, l'account corrente viene utilizzato come predefinito. Utilizzate questo parametro solo per i widget metrici.

▬Tipo: stringa

Obbligatorio: no

Namespace

Lo AWS spazio dei nomi contenente la metrica. Se nell'metricsarray sono presenti più voci, per ognuna dopo la prima puoi specificare di "." utilizzare solo lo stesso spazio dei nomi della metrica precedente nell'array.

Tipo: stringa

Obbligatorio: sì

MetricName

Il nome della metrica. CloudWatch Se nell'metricsarray sono presenti più voci, per ognuna dopo la prima puoi specificare di "." utilizzare solo lo stesso nome della metrica precedente nell'array.

Tipo: String

Obbligatorio: Sì, per una singola metrica

expression

La query, l'espressione matematica o l'espressione di ricerca di Metrics Insights, se si tratta di un'espressione anziché di una singola metrica.

In un'espressione di ricerca che utilizza virgolette doppie per una corrispondenza esatta, ogni virgoletta doppia deve essere preceduta da una barra rovesciata.

Per ulteriori informazioni sulla sintassi delle query di Metrics Insights, vedi Componenti e sintassi delle query di Metrics Insights.

Per ulteriori informazioni sulle espressioni matematiche o sulle espressioni di ricerca, consulta Using Metric Math o Using Search Expressions in Graphs nella Amazon User Guide. CloudWatch

Tipo: String

Obbligatorio: Sì, per un'espressione

Esempio di espressione per una query su 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

Il nome di una dimensione per perfezionare ulteriormente i dati visualizzati. Se nell'metricsarray sono presenti più voci, per ognuna dopo la prima è possibile specificare di "." utilizzare solo lo stesso nome di dimensione della dimensione corrispondente specificata nella metrica precedente nell'array. È possibile specificare 0 dimensioni per una metrica o fino a tante dimensioni quante sono le dimensioni supportate dalla metrica.

▬Tipo: stringa

Obbligatorio: no

DimensionValue

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

▬Tipo: stringa

Obbligatorio: no

id

L'ID di questa serie temporale. Questo ID può essere usato come parte di un'espressione matematica. L'ID deve iniziare con una lettera minuscola.

▬Tipo: stringa

Obbligatorio: no

etichetta

L'etichetta da visualizzare nel grafico per rappresentare questa serie temporale.

▬Tipo: stringa

Obbligatorio: no

region

La regione della metrica. Utilizzate questo parametro solo per i widget delle metriche. Se lo ometti, la regione corrente viene utilizzata come predefinita.

▬Tipo: stringa

Obbligatorio: no

Rendering Properties:

Specifica le proprietà di rendering da utilizzare per questa particolare metrica, sovrascrivendo i valori specificati per il widget generale. Per ulteriori informazioni sul formato, vedere. Oggetto Dashboard Widget: formato oggetto Rendering Properties

Tipo: oggetto Metric Render Properties

Obbligatorio: no

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

Oggetto Dashboard Widget: formato oggetto Rendering Properties

Ogni metrica dell'metricsarray può opzionalmente avere proprietà di rendering personalizzate che sovrascrivono le proprietà di rendering predefinite specificate nel yAxis parametro dell'oggetto. widget Questa sezione descrive il formato di tali proprietà di rendering personalizzate per metrica.

color

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

▬Tipo: stringa

Obbligatorio: no

etichetta

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

▬Tipo: stringa

Obbligatorio: no

punto

Il periodo per questa metrica, in secondi. Il periodo è il periodo di tempo rappresentato da un punto dati sul grafico.

Valori validi: un multiplo di 60, con un minimo di 60.

Tipo: Integer

Obbligatorio: no

stat

La statistica per questa metrica, se deve essere diversa dalla statistica utilizzata per le altre metriche dell'array. Per impostazione predefinita, CloudWatch utilizza Average se non si specifica una statistica a livello di matrice o di metrica.

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

Tipo: stringa che è una statistica valida CloudWatch .

Obbligatorio: no

visible

Impostalo in true modo che la metrica appaia nel grafico o che false sia nascosta. Il valore predefinito è true.

Tipo: Booleano

Obbligatorio: no

Asse Y

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

Valori validi: left | right

▬Tipo: stringa

Obbligatorio: no

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

Oggetto Dashboard Widget: proprietà delle annotazioni

Le annotazioni includono allarmi, annotazioni orizzontali e annotazioni verticali. Un singolo widget metrico può contenere fino a un allarme oppure una o più annotazioni orizzontali o verticali. Un singolo widget non può avere sia un allarme che annotazioni orizzontali o verticali.

Annotazioni di allarme

Se si specifica un'annotazione di allarme, non è possibile specificare anche un metrics array nello stesso widget.

allarmi

Il nome della risorsa Amazon (ARN) dell'allarme.

Tipo: Array of Strings. Nell'array possono esserci 0—1 stringhe.

Obbligatorio: solo se non è elencata alcuna metrica.

"annotations": { "alarms": [ "arn1" ] }

Annotazioni orizzontali

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 a banda. Ogni annotazione orizzontale nell'array che è una singola annotazione, anziché un'annotazione a banda, ha il seguente formato:

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

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

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

Il valore della metrica nel grafico in cui deve apparire la riga di annotazione orizzontale. In un'annotazione con ombreggiatura della banda, i due valori per 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ì

etichetta

Una stringa che appare sul 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 l'ombreggiatura al di sopra dell'annotazione, l'ombreggiatura al below di sotto dell'annotazione e l'assenza di ombreggiatura. none Se fill viene omesso, non vi è alcuna ombreggiatura.

L'eccezione è rappresentata da un'annotazione con ombreggiatura a bande. Queste annotazioni hanno sempre un'ombreggiatura tra i due valori e qualsiasi valore di viene ignorato. fill

▬Tipo: stringa

Obbligatorio: no

visible

Impostalo in true modo che l'annotazione appaia nel grafico o che sia false nascosta. Il valore predefinito è true.

Tipo: Booleano

Obbligatorio: no

Asse Y

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

▬Tipo: stringa

Obbligatorio: no

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

Annotazioni verticali

verticale

Una serie di annotazioni verticali. Per ogni annotazione verticale, puoi scegliere di inserire un'ombreggiatura di riempimento prima dell'annotazione, dopo di essa o tra due linee verticali collegate come un'unica annotazione a banda. Ogni annotazione verticale nell'array che è una singola annotazione, anziché un'annotazione a banda, ha il seguente formato:

{value, label, color, fill, visible}

Ogni annotazione verticale che è un'annotazione a banda ha il seguente formato:

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

La data e l'ora nel grafico in cui deve apparire la riga di annotazione verticale. In un'annotazione con ombreggiatura della banda, i due valori per Value definiscono i bordi iniziale e finale della banda.

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

Questa è definita come una stringa in formato ISO 8601. Per ulteriori informazioni, consulta il protocollo ISO 8601.

Tipo: stringa

Obbligatorio: sì

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 before l'ombreggiatura prima dell'annotazione, l'ombreggiatura dopo after l'annotazione e l'assenza di ombreggiatura. none Se fill viene omesso, non vi è alcuna ombreggiatura.

L'eccezione è rappresentata da un'annotazione con ombreggiatura a bande. Queste annotazioni hanno sempre un'ombreggiatura tra i due valori e qualsiasi valore di viene ignorato. fill

▬Tipo: stringa

Obbligatorio: no

visible

Impostatelo in true modo che l'annotazione appaia nel grafico o che sia false nascosta. Il valore predefinito è true.

Tipo: Booleano

Obbligatorio: no

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

Oggetto del widget del dashboard: yAxis Properties Format

Definisce le impostazioni per Y-axis il grafico. Le impostazioni includono il massimo e il minimo, un'etichetta per l'asse e se l'asse mostra le unità. Impostalo all'interno dell'widgetoggetto per influire su tutte le metriche del widget. Per sovrascrivere le impostazioni del widget per una particolare metrica, impostala per la metrica nell'array. metrics

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

Impostazioni opzionali per la sinistra. Y-axis

Tipo: oggetto YAxis

Obbligatorio: no

destra

Impostazioni opzionali per la destra. Y-axis

Tipo: oggetto YAxis

Obbligatorio: no

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

etichetta

Un'etichetta per questo Y-axis

▬Tipo: stringa

Obbligatorio: no

min

Il valore minimo per questo Y-axis

Tipo: Float

Obbligatorio: no

max

Il valore massimo per questo Y-axis

Tipo: Float

Obbligatorio: no

Mostra unità

Determina se vengono visualizzate le unità per la metrica associata a questo asse. Il valore predefinito è true.

Tipo: Booleano

Obbligatorio: no

Oggetto Dashboard Widget: proprietà della tabella

Se specifichi table un widget metrico, puoi includere visualizzazioni relative alla visibilità delle colonne di riepilogo, delle colonne dei punti dati e del layout della tabella. Queste proprietà hanno effetto solo quando è presente il tipo di visualizzazione del widget table e non alterano gli altri tipi di visualizzazione, se inclusi. La table proprietà non è richiesta per utilizzare un widget di tabella.

layout

Usa questo campo per trasformare la tabella in modo che i punti dati si estendano verticalmente o orizzontalmente. Il valore predefinito è horizontal.

Valori validi: vertical | horizontal

▬Tipo: stringa

Obbligatorio: no

Riepilogo permanente

Imposta questa opzione true per rendere permanenti le colonne di riepilogo che includi nella tabella, in modo da poter esplorare le colonne di dati mantenendo sempre le colonne di riepilogo nella finestra di visualizzazione. Il valore predefinito è false.

L'etichetta del widget è sempre adesiva, indipendentemente dalla tua scelta in questo campo.

Valori validi: true | false

Tipo: Booleano

Obbligatorio: no

mostrare TimeSeriesData

Impostalo su false se desideri che vengano visualizzate solo le colonne dell'etichetta e del riepilogo, nascondendo le altre colonne di dati.

Il valore predefinito è true.

Valori validi: true | false

Tipo: Booleano

Obbligatorio: no

Colonne di riepilogo

Le colonne di riepilogo sono una nuova proprietà introdotta con il widget della tabella. Queste colonne sono un sottoinsieme specifico di riepiloghi della tabella corrente. Ad esempio, il Sum riepilogo è una somma di tutti i punti dati renderizzati nella rispettiva riga. Le colonne di riepilogo non sono lo stesso concetto di qualsiasi statistica metrica. CloudWatch

Il valore predefinito è ["MIN", "MAX","SUM", "AVG"].

Valori validi: "MIN" | "MAX" | "SUM" | "AVG"

Tipo: Array

Obbligatorio: no

Ad esempio, il seguente JSON crea una tabella che mostra il minimo e il massimo di ciascuna metrica nella tabella.

"table": { "summaryColumns": ["MIN", "MAX"], "layout": "vertical", "stickySummary": true, "showTimeSeriesData": false, },

Proprietà di un oggetto Metrics Explorer Widget

Un widget di tipo explorer rappresenta un widget Metrics Explorer. Per ulteriori informazioni, consulta Utilizzare Metrics Explorer per monitorare le risorse in base ai tag e alle proprietà

Puoi anche aggiungere i widget di Metrics Explorer a una dashboard utilizzando. CloudFormation Per ulteriori informazioni, vedi AWS::CloudWatch: :Dashboard.

Questo tipo di widget può avere i seguenti campi all'interno del widgetproperties:

AggregateBy

Un oggetto che specifica come aggregare le metriche da più risorse. I valori validi per il key campo di questo oggetto sono le chiavi dei tag e le proprietà delle risorse. Questo oggetto contiene i seguenti campi.

  • key: il tag o la chiave della proprietà della risorsa da utilizzare per aggregare le metriche.

  • func — La funzione di aggregazione da utilizzare. I valori validi sono AVG | | | MIN | MAX STDDEV SUM

Tipo: oggetto

Obbligatorio: no

labels

Una matrice dei tag o delle proprietà delle risorse utilizzati per determinare quali metriche vengono visualizzate nel widget.

Se si specificano chiavi diverse, vengono visualizzate solo le risorse che corrispondono a tutte le key/value coppie. Se si specificano più valori per una singola chiave, vengono visualizzate le risorse che corrispondono a uno qualsiasi dei valori di quella chiave.

  • chiave: il tag o la proprietà della risorsa su cui filtrare.

    Perkey, tutte le chiavi dei tag sono valide per essere specificate. Le seguenti proprietà delle risorse EC2 e Lambda sono valide anche per: 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 e Timeout

  • value — (Facoltativo) Il valore del tag o della proprietà della risorsa su cui filtrare. Se viene omesso, vengono visualizzate le metriche corrispondenti a tutti i valori di quel tag o proprietà della risorsa.

Tipo: oggetto

Obbligatorio: sì

metriche

Specificate un metrics array per includere una o più metriche. Un metrics array può includere da 1 a 100 metriche. Ogni oggetto dell'array deve contenere i seguenti campi.

  • metricName: il nome della metrica.

  • ResourceType: il tipo di risorsa che pubblica la metrica, descritta nel formato utilizzato da. AWS CloudFormation Ad esempio AWS::EC2::Instance o AWS::Lambda::Function.

    È necessario utilizzare lo stesso valore resourceType per tutte le metriche del widget.

    Per un elenco completo dei valori validi, consultaValori ResourceType validi per un oggetto Metric Explorer Widget.

  • stat — La statistica per questa metrica, se deve essere diversa dalla statistica utilizzata per le altre metriche dell'array. Per impostazione predefinita, CloudWatch utilizza Average se non specifichi una statistica a livello di matrice o di metrica.

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

Tipo: matrice di oggetti

Obbligatorio: sì

punto

Il periodo predefinito, in secondi, per tutte le metriche in questo widget. Il periodo è il periodo di tempo rappresentato da un punto dati sul grafico. Il valore predefinito è 300.

Valori validi: qualsiasi multiplo di 60, con 60 come minimo.

Tipo: Integer

Obbligatorio: no

Dividi per

Specifica come suddividere le metriche di più risorse in diverse righe di un grafico o in grafici diversi. I valori validi sono le chiavi dei tag e le chiavi delle proprietà delle risorse.

▬Tipo: stringa

Obbligatorio: no

titolo

Il titolo da visualizzare per il widget. Il valore predefinito è Explorer.

▬Tipo: stringa

Obbligatorio: no

Opzioni del widget

Un oggetto che specifica la modalità di visualizzazione del widget sulla dashboard. Può contenere i seguenti campi.

  • leggenda

    Determina dove viene visualizzata la legenda per ogni grafico. Il legend campo contiene un altro campo chiamatoposition. I valori possibili per position sono rightbottom, ehidden.

    Ad esempio, quanto segue fa apparire la legenda sulla destra del grafico.

    "legend": { "position": "right" }
  • righe PerPage

    Specifica quante righe di grafici vengono visualizzate per pagina nel widget.

  • in pila —

    Specifica true di visualizzare il grafico come grafico ad area in false pila o di visualizzarlo come linee separate.

  • visualizzazione

    Specifica come viene visualizzato ciascun grafico. Specifica timeSeries di visualizzare questa metrica come grafico a linee. barSpecificate di visualizzarla come grafico a barre. pieSpecificate di visualizzarlo come grafico a torta. Il valore predefinito è timeSeries.

  • widget PerRow

    Specifica quanti grafici vengono visualizzati in ogni riga del widget Metrics Explorer.

Tipo: oggetto

Obbligatorio: no

Esempio

L'esempio seguente mostra tre metriche per ciascuna delle istanze EC2 in esecuzione dell'account, con i grafici del widget suddivisi per zona di disponibilità. All'interno di ogni grafico, le metriche sono aggregate per tipo di istanza.

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

Valori ResourceType validi per un oggetto Metric Explorer Widget

I valori validi per il resourceType campo nella metrics sezione di un widget Metrics Explorer sono i seguenti:

  • 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

Proprietà di un oggetto Alarm Status Widget

Un widget di tipo alarm può contenere i seguenti campiproperties.

allarmi

Una serie di ARN di allarme da includere nel widget. L'array può avere da 1 a 100 ARN.

Tipo: array di stringhe

Obbligatorio: Sì (se il widget type èalarm).

Ordina per

Specifica come ordinare gli allarmi nel widget.

Scegli default di ordinarli in ordine alfabetico in base al nome dell'allarme.

Scegliete stateUpdatedTimestamp di ordinarli prima in base allo stato di allarme, con gli allarmi in stato ALARM per primi, gli allarmi INSUFFICIENT_DATA per ultimi e gli allarmi OK per ultimi. All'interno di ciascun gruppo, gli allarmi vengono ordinati in base all'ultima modifica di stato, con le modifiche di stato più recenti elencate per prime.

Scegli timestamp di ordinarli in base all'ora in cui gli allarmi hanno cambiato stato più recentemente, indipendentemente dallo stato di allarme corrente. L'allarme che ha cambiato stato più recentemente viene elencato per primo.

Se si omette questo campo, gli allarmi vengono ordinati in ordine alfabetico.

Tipo: String

Valori validi: default | state | timestamp UpdatedTimestamp

Obbligatorio: no

states

Usa questo campo per filtrare l'elenco degli allarmi visualizzati nel widget in base ai soli allarmi attualmente negli stati specificati. È possibile specificare uno o più stati di allarme nel valore di questo campo. Gli stati di allarme che è possibile specificare sono ALARMINSUFFICIENT_DATA, eOK.

Se si omette questo campo o si specifica una matrice vuota, vengono visualizzati tutti gli allarmi specificati inalarms.

Tipo: array di stringhe

Obbligatorio: no

titolo

Il testo del titolo che deve essere visualizzato dal widget.

▬Tipo: stringa

Obbligatorio: no

L'esempio seguente è un widget sullo stato degli allarmi che visualizza quattro allarmi specificati per nome, indipendentemente dal loro stato attuale:

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

Il seguente widget di esempio specifica gli stessi quattro allarmi, ma mostra solo gli allarmi attualmente nello stato ALARM o INSUFFICIENT_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" } }

Proprietà di un oggetto Chart Widget

Un widget di tipo chart è un widget grafico con più fonti di dati che supporta le query ProMQL rispetto alle metriche. CloudWatch Usa un widget grafico per visualizzare le metriche interrogabili con ProMQL, comprese le metriche inserite tramite OpenTelemetry Line Protocol (OTLP) e le metriche vendute che sono state arricchite per OtEL. AWS Per ulteriori informazioni sulle Metriche delle query con ProMQL interrogazioni con ProMQL, vedere.

Un widget di tipo chart può contenere i seguenti campi: properties

visualizzazione

La visualizzazione da utilizzare per il widget.

Valori validi: line bar | pie | | number | solidgauge | column | | legend | histogram | heatmap scatter

Tipo: stringa

Obbligatorio: sì

titolo

Il titolo da visualizzare per il widget.

▬Tipo: stringa

Obbligatorio: no

description

Una descrizione opzionale per il widget.

▬Tipo: stringa

Obbligatorio: no

region

La AWS regione da utilizzare per tutte le query nel widget. Ogni interrogazione nell'data.queriesarray può sovrascriverla con un proprio campo. region

▬Tipo: stringa

Obbligatorio: no

data

Le interrogazioni da tracciare nel widget. L'dataoggetto contiene un queries array, in cui ogni voce definisce una query. Per ulteriori informazioni sul formato, vedereWidget grafico: formato per ogni interrogazione nell'array.

Tipo: oggetto

Obbligatorio: sì

Opzioni del grafico

Opzioni di visualizzazione per il widget, come il posizionamento della legenda, la configurazione degli assi e le impostazioni di stile specifiche della vista (ad esempio, larghezza della linea o barre sovrapposte). I campi esatti disponibili dipendono dal valore di. view Se si ometteplotOptions, vengono utilizzate le impostazioni predefinite per la vista. Per l'elenco completo dei campi, vedereWidget grafico: PlotOptions Reference.

Tipo: oggetto

Obbligatorio: no

Widget grafico: formato per ogni interrogazione nell'array

Ogni voce nell'data.queriesarray definisce una singola query. Per creare un widget grafico che interroghi le CloudWatch metriche, imposta type sucloudwatch-metrics, imposta su language PromQL o SQL e fornisci l'espressione di query come stringa nel query campo. Un singolo widget grafico può combinare query scritte in lingue diverse.

id

Un identificatore per questa query. L'ID deve essere univoco all'interno del widget.

Tipo: stringa

Obbligatorio: sì

tipo

Il tipo di richiesta. Per ProMQL, usacloudwatch-metrics.

Valori validi: cloudwatch-metrics

Tipo: stringa

Obbligatorio: sì

linguaggio

Il linguaggio di interrogazione per questa query. Specifica PromQL di scrivere la query in Prometheus Query Language o di SQL scrivere la query in CloudWatch Metrics Insights SQL.

Valori validi: PromQL | SQL

Tipo: stringa

Obbligatorio: sì

query

L'espressione di interrogazione da valutare, sotto forma di stringa. La sintassi dipende dal language campo.

Per ProMQL, fornisci un'espressione Prometheus Query Language. Ad esempio, sum by (InstanceId) (rate(CPUUtilization[5m])). Per informazioni sulla sintassi di ProMQL e sulle etichette disponibili sulle metriche vendute, vedere. AWS Interrogazione venduta AWS metriche con ProMQL

Per SQL, fornisci una query SQL di CloudWatch Metrics Insights. Ad esempio, SELECT AVG(CPUUtilization) FROM SCHEMA("AWS/EC2", InstanceId) GROUP BY InstanceId. Per informazioni sulla sintassi delle query di Metrics Insights, vedi Componenti e sintassi delle query di Metrics Insights.

Tipo: stringa

Obbligatorio: sì

etichetta

L'etichetta da visualizzare nella legenda della serie di questa query. Specificate il valore speciale __verbose__ per includere tutte le etichette metriche nel nome di ogni serie.

▬Tipo: stringa

Obbligatorio: no

region

La AWS regione in cui valutare questa query. Se omesso, region viene utilizzato quello del widget.

▬Tipo: stringa

Obbligatorio: no

accountId

L' AWS account in cui valutare questa richiesta. Usalo per domande su più account su una dashboard di monitoraggio degli account.

▬Tipo: stringa

Obbligatorio: no

fase

La risoluzione della query, in secondi. Questo controlla la frequenza con cui l'espressione ProMQL viene valutata nell'intervallo di tempo del widget.

Tipo: numero

Obbligatorio: no

visible

Imposta su false per nascondere la serie di questa query dal grafico mantenendo la query nella definizione del widget. Il valore predefinito è true.

Tipo: Booleano

Obbligatorio: no

Widget grafico: PlotOptions Reference

L'plotOptionsoggetto controlla il modo in cui il grafico viene renderizzato. Può contenere una serie di campi comuni condivisi da tuttiview, più un style oggetto la cui forma dipende dalla sceltaview. Alcune viste accettano anche assi (yAxis,xAxis) e annotations oggetti.

La tabella seguente riassume i campi view supportati da ciascuno.

vista

sottooggetto di stile

Asse y/Asse x

Supporto per le annotazioni

line

LineStyle

Sì (verticale e orizzontale)

bar

BarStyle

Sì (verticale e orizzontale)

column

BarStyle

No

pie

PieStyle

No

No

number

NumberStyle

No

No

solidgauge

GaugeStyle

No

Sì (orizzontale)

scatter

ScatterStyle

Sì (verticale e orizzontale)

histogram

BarStyle + HistogramStyle

No

heatmap

HeatmapStyle

No

Campi PlotOptions comuni

I seguenti campi sono validi plotOptions per ogni. view

mito

Configura la legenda. L'oggetto include i seguenti campi:

  • posizione: dove appare la legenda sul widget. I valori validi sono bottom e right.

  • show — Booleano. Imposta su per false nascondere la legenda.

Tipo: oggetto

Obbligatorio: no

View-specific campi di stile

La forma dell'styleoggetto dipende dal valore diview.

Opzioni di riga

Usato quando view èline. Configura il rendering delle linee. L'oggetto include i seguenti campi:

  • larghezza: numero. Larghezza della linea in pixel.

  • motivo: schema del tratto della linea. I valori validi sono solid, dashed e dotted.

  • spline: booleano. Setrue, disegna una curva smussata attraverso i punti dati.

  • riempito: booleano. Setrue, riempie l'area sotto la linea.

  • impilato: booleano. Setrue, impila le aree riempite tra le serie. Usa with filled: true per un grafico ad area in pila.

  • color: un colore esadecimale HTML a sei cifre.

Tipo: oggetto

Obbligatorio: no

Opzioni della barra

Usato quando view èbar,column, ohistogram. Configura il rendering delle barre. L'oggetto include i seguenti campi:

  • impilato: booleano. Setrue, le barre di serie diverse sono impilate.

  • orientamento: direzione della barra. I valori validi sono vertical e horizontal.

Tipo: oggetto

Obbligatorio: no

Opzioni Pie

Usato quando èview. pie L'oggetto include i seguenti campi:

  • InnerSize: stringa. Una percentuale simile. "50%" Impostato su "0%" per una torta solida o su un valore diverso da zero per un grafico a ciambella.

Tipo: oggetto

Obbligatorio: no

Opzioni numeriche

Usato quando view ènumber. L'oggetto include i seguenti campi:

  • sparkline: booleano. Setrue, visualizza una linea sparkline sotto il numero.

  • truncate: booleano. Setrue, tronca numeri grandi (ad esempio, visualizza invece di). 1.2K 1234

Tipo: oggetto

Obbligatorio: no

Opzioni dell'indicatore

Usato quando èview. solidgauge L'oggetto include i seguenti campi:

  • min— Numero. Il valore minimo dell'indicatore.

  • max— Numero. Il valore massimo dell'indicatore.

Tipo: oggetto

Obbligatorio: no

Opzioni di colore

Usato quando view èheatmap. Configura il gradiente di colore. L'oggetto include i seguenti campi:

  • Color Preset — String. Nome di una scala di colori incorporata.

  • minColor: un colore esadecimale HTML a sei cifre utilizzato nella parte inferiore di un gradiente personalizzato.

  • MidColor: un colore esadecimale HTML a sei cifre utilizzato nel punto medio di un gradiente personalizzato.

  • maxColor: un colore esadecimale HTML a sei cifre utilizzato nella parte superiore di un gradiente personalizzato.

Tipo: oggetto

Obbligatorio: no

Opzioni dell'istogramma

Usato quando view èhistogram, oltre a. barOptions L'oggetto include i seguenti campi:

  • BucketCount: numero. Numero di bucket in cui dividere i dati.

  • BucketSize: numero o stringa "auto" per dimensionare automaticamente i bucket.

  • Combine Series: booleano. Combina tutte le serie in un unico istogramma.

Tipo: oggetto

Obbligatorio: no

Opzioni di aggregazione

Usato quando èview. histogram Controlla il modo in cui i punti dati vengono aggregati prima del bucketing. L'oggetto include i seguenti campi:

  • binInterval — String. La larghezza del contenitore come durata. Ad esempio, "5m" per contenitori da cinque minuti.

Tipo: oggetto

Obbligatorio: no

etichetta

Utilizzato con gli stili a linee, a barre e a dispersione per etichettare i punti dati direttamente sul grafico. L'oggetto include i seguenti campi:

  • posizione: dove appare l'etichetta rispetto al relativo punto dati. I valori validi sono inside outsidetop,bottom,left, eright.

  • show: booleano. Impostato per visualizzare true le etichette.

Tipo: oggetto

Obbligatorio: no

Contrassegna opzioni

Utilizzato con gli stili di linea e dispersione per configurare i marker disegnati nei punti dati. L'oggetto include i seguenti campi:

  • abilitato: booleano. Impostato per true disegnare marcatori.

  • Tipo di simbolo: stringa. Forma del pennarello. Ad esempio, circle, square o diamond.

  • Dimensione del simbolo: numero. Dimensione dell'indicatore in pixel.

  • BorderWidth: numero. Larghezza del bordo dell'indicatore in pixel.

  • borderColor: un colore esadecimale HTML a sei cifre per il bordo dell'indicatore.

  • fillColor: un colore esadecimale HTML a sei cifre per il riempimento del marker.

  • FillOpacity: numero compreso tra 0 e 1.

Tipo: oggetto

Obbligatorio: no

Campi YAxis e XAxis

Per view i valori che supportano gli assi, è possibile includere yAxis e xAxis oggetti in. plotOptions

Asse Y

Una matrice di uno o due oggetti ad asse. La prima voce configura l'asse sinistro e la seconda voce (se presente) configura l'asse destro. Ogni oggetto dell'asse contiene i seguenti campi:

  • min— Numero. Limite inferiore dell'asse.

  • max— Numero. Limite superiore dell'asse.

  • tipo: scala dell'asse. I valori validi sono linear, logarithmic, datetime e category.

  • titolo— String. Etichetta dell'asse visualizzata accanto all'asse.

  • Mostra unità: booleano. Se mostrare i suffissi delle unità (ad esempio,K) sulle etichette di spunta. M

Tipo: matrice di oggetti

Obbligatorio: no

Asse x

Un oggetto ad asse singolo che configura l'asse x. L'oggetto include i seguenti campi:

  • min— Numero. Limite inferiore dell'asse.

  • max— Numero. Limite superiore dell'asse.

  • tipo: scala dell'asse. I valori validi sono linear, logarithmic, datetime e category.

  • titolo— String. Etichetta dell'asse visualizzata accanto all'asse.

  • etichetta: stringa. Seleziona il formato dell'etichetta.

Tipo: oggetto

Obbligatorio: no

annotations

Per view i valori che supportano le annotazioni, puoi aggiungere linee di riferimento o bande ombreggiate al grafico. L'annotationsoggetto può contenere i seguenti array:

verticale

Annotazioni sull'asse del tempo. Ogni voce è un oggetto di annotazione o un array di due oggetti di annotazione per definire una banda (regione ombreggiata tra due valori). Ogni oggetto di annotazione contiene i seguenti campi:

  • tipo: il tipo di annotazione. Utilizza static.

  • etichetta: String. Il testo visualizzato accanto all'annotazione.

  • valore: numero, stringa di ISO-8601 data e ora o categoria. La posizione sull'asse temporale in cui viene visualizzata l'annotazione.

  • color: un colore esadecimale HTML a sei cifre utilizzato per la riga di annotazione e per qualsiasi ombreggiatura di riempimento.

  • riempimento: come usare l'ombreggiatura di riempimento. I valori validi sono before (ombreggiatura prima dell'annotazione), after (ombreggiatura dopo l'annotazione) e between (utilizzata per le annotazioni a bande per ombreggiare tra i due valori).

Tipo: Array

Obbligatorio: no

orizzontale

Annotazioni sull'asse dei valori. Ogni voce è un oggetto di annotazione o una matrice di due oggetti di annotazione per definire una banda. Ogni oggetto di annotazione contiene i seguenti campi:

  • tipo: il tipo di annotazione. Utilizza static.

  • etichetta: String. Il testo visualizzato accanto all'annotazione.

  • valore: numero. Il valore sull'asse dei valori in cui appare l'annotazione.

  • color: un colore esadecimale HTML a sei cifre utilizzato per la riga di annotazione e per qualsiasi ombreggiatura di riempimento.

  • riempimento: come usare l'ombreggiatura di riempimento. I valori validi sono above (ombreggiatura sopra l'annotazione), below (ombreggiatura sotto l'annotazione) e between (usato per le annotazioni a banda per ombreggiare tra i due valori).

Tipo: Array

Obbligatorio: no

Esempio: grafico a linee ProMQL

L'esempio seguente visualizza un grafico a linee che traccia una query ProMQL rispetto AWS alle metriche vendute in. us-east-1

{ "type": "chart", "x": 0, "y": 0, "width": 12, "height": 6, "properties": { "view": "line", "title": "EC2 CPU by instance", "region": "us-east-1", "data": { "queries": [ { "id": "a", "type": "cloudwatch-metrics", "language": "PromQL", "query": "sum by (InstanceId) (rate(CPUUtilization[5m]))" } ] }, "plotOptions": { "legend": { "position": "bottom", "show": true } } } }

Esempio: grafico che combina una query ProMQL e una query SQL

L'esempio seguente mostra un grafico a linee che traccia due query sulla stessa metrica, una scritta in ProMQL e una scritta in Metrics Insights SQL. CloudWatch

{ "type": "chart", "x": 0, "y": 6, "width": 12, "height": 6, "properties": { "view": "line", "title": "EC2 CPU utilization (PromQL and SQL)", "region": "us-east-1", "data": { "queries": [ { "id": "promql_cpu", "type": "cloudwatch-metrics", "language": "PromQL", "query": "sum by (InstanceId) (rate(CPUUtilization[5m]))", "label": "PromQL" }, { "id": "sql_cpu", "type": "cloudwatch-metrics", "language": "SQL", "query": "SELECT AVG(CPUUtilization) FROM SCHEMA(\"AWS/EC2\", InstanceId) GROUP BY InstanceId", "label": "SQL" } ] }, "plotOptions": { "legend": { "position": "right", "show": true } } } }