View a markdown version of this page

Struktur Badan Dasbor dan Sintaks - Amazon CloudWatch

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Struktur Badan Dasbor dan Sintaks

Struktur Keseluruhan

A DashboardBody adalah string dalam format JSON. Ini dapat mencakup array antara 0 dan 500 objek widget, serta beberapa parameter lainnya. Dasbor harus menyertakan widgets array, tetapi array itu bisa kosong.

Berikut ini adalah contoh struktur ini dengan satu widget metrik dan satu widget teks, rentang waktu mulai enam jam sebelum waktu saat ini, dan pengaturan periode setiap grafik selalu dipatuhi.

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

Contoh berikutnya menampilkan tiga metrik Lambda per fungsi, dan menggunakan variabel dasbor sehingga pengguna dasbor dapat beralih di antara nama fungsi Lambda yang berbeda dan melihat ketiga metrik untuk setiap fungsi. Ini membantu Anda membuat dasbor fleksibel tunggal yang dapat menampilkan metrik utama untuk sumber daya yang berbeda. Dalam contoh ini fungsi ditemukan oleh kueri pencarian metrik, sehingga dasbor secara otomatis menemukan fungsi Lambda baru ketika mereka dibuat.

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

Contoh berikutnya memiliki dua widget. Yang pertama mencakup dua metrik dan ekspresi matematika yang menjumlahkan totalnya. Widget kedua adalah ekspresi pencarian yang menampilkan CPUUtilization untuk semua instance EC2 di Wilayah.

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

Sisa bagian ini mencakup contoh yang menggambarkan setiap bagian dari DashboardBody sintaks. Untuk contoh selengkapnya yang menunjukkan seluruh sintaks perintah, lihat PutDashboard di Refer CloudWatch ensi API Amazon.

Tingkat atas objek JSON dapat mencakup properti berikut.

widget

Daftar widget di dasbor. Untuk informasi selengkapnya, lihat Struktur Array Widget.

Wajib: Ya

variabel

Array objek variabel dasbor yang digunakan di dasbor. Untuk informasi selengkapnya tentang bidang yang dapat Anda gunakan di setiap objek variabel dasbor, lihatVariabel Struktur Array.

Untuk informasi selengkapnya tentang variabel dasbor, lihat Membuat dasbor fleksibel dengan variabel dasbor.

Jika Anda menyertakan variables array, itu dapat berisi antara 0 dan 25 objek variabel.

Wajib: Tidak

end

Akhir rentang waktu yang akan digunakan untuk setiap widget di dasbor saat dasbor dimuat. Jika Anda menentukan end, maka Anda juga harus menentukan nilai start. Untuk masing-masing nilai ini, tentukan waktu absolut dalam format ISO 8601. Misalnya, 2018-12-17T06:00:00.000Z.

Tipe: String

Wajib: Tidak

start

Awal rentang waktu yang akan digunakan untuk setiap widget di dasbor.

Anda dapat menentukan start tanpa menentukan end untuk menentukan rentang waktu relatif yang berakhir dengan waktu saat ini. Dalam hal ini, nilai start harus dimulai dengan -PT jika Anda menentukan rentang waktu dalam menit atau jam, dan harus dimulai dengan -P jika Anda menentukan rentang waktu dalam hari, minggu, atau bulan. Anda kemudian dapat menggunakan M, H, D, W dan M sebagai singkatan untuk menit, jam, hari, minggu dan bulan. Misalnya, -PT5M menunjukkan 5 menit terakhir, -PT8H menunjukkan 8 jam terakhir, dan -P3M menunjukkan tiga bulan terakhir.

Anda juga dapat menggunakan start bersama dengan end bidang, untuk menentukan rentang waktu absolut. Saat menentukan rentang waktu absolut, gunakan format ISO 8601. Misalnya, 2018-12-17T06:00:00.000Z.

Jika Anda menghilangkanstart, dasbor menunjukkan rentang waktu default saat dimuat.

Tipe: String

Wajib: Tidak

PeriodeVerride

Gunakan bidang ini untuk menentukan periode grafik saat dasbor dimuat. Men auto entukan menyebabkan periode semua grafik di dasbor secara otomatis beradaptasi dengan rentang waktu dasbor. Men inherit entukan memastikan bahwa periode yang ditetapkan untuk setiap grafik selalu dipatuhi.

Nilai yang Valid: otomatis | mewarisi

Tipe: String

Wajib: Tidak

Struktur Array Widget

Setiap widget jenis apa pun dapat memiliki properti berikut.

jenis

Jenis widget.

Nilai yang Val metric id: text | log | alarm | explorer | chart

Tipe: String

Diperlukan: Ya

x

Posisi horizontal widget pada grid dasbor 24 kolom. Defaultnya adalah posisi yang tersedia berikutnya.

Nilai yang Valid: 0—23

Jenis: Integer

Diperlukan: Ya, jika y ditentukan. Kalau tidak, tidak diperlukan.

y

Posisi vertikal widget pada grid dasbor 24 kolom. Defaultnya adalah posisi yang tersedia berikutnya.

Nilai Valid: Setiap bilangan bulat, 0 atau lebih tinggi.

Jenis: Integer

Diperlukan: Ya, jika x ditentukan. Kalau tidak, tidak diperlukan.

Lebar

Lebar widget dalam unit grid (dalam kotak 24 kolom). Defaultnya adalah 6.

Nilai yang Valid: 1—24

Tipe: Integer

Wajib: Tidak

tingginya

Ketinggian widget dalam unit grid. Defaultnya adalah 6.

Nilai yang Valid: 1—1000

Tipe: Integer

Wajib: Tidak

properti

Properti terperinci dari widget, yang berbeda tergantung pada jenis widget. Untuk informasi selengkapnya tentang formatproperties, lihatProperti Objek Widget Metrik,Properti Objek Widget Bagan, atauProperti Objek Widget Teks.

Tipe: Objek

Wajib: Ya

Variabel Struktur Array

Setiap variabel dasbor dalam array dapat memiliki properti berikut.

jenis

Jenis variabel dasbor. CloudWatch mendukung dua jenis, variabel properti dan variabel pola.

Variabel properti mengubah nilai semua instance properti di semua widget di dasbor. Properti dapat berupa salah satu dari berikut ini:

  • Setiap properti JSON dalam definisi widget, sepertiregion.

  • Nama dimensi apa pun untuk metrik, seperti InstanceId atauFunctionName.

Variabel pola mengubah pola ekspresi reguler di seluruh JSON dasbor. Gunakan saat Anda perlu mengubah hanya sebagian dari nilai properti JSON, atau bahkan properti JSON.

Variabel sifat berlaku untuk sebagian besar kasus penggunaan dan tidak begitu sulit untuk disiapkan.

Nilai Valid: property | pattern

Tipe: String

Diperlukan: Ya

Jenis masukan

Menentukan bagaimana pengguna dasbor memasukkan nilai untuk variabel.

  • Tentukan input untuk menggunakan kotak teks yang pengguna dapat memasukkan nilai ke dalamnya.

  • Tentukan select untuk menggunakan kumpulan nilai dropdown yang Anda tentukan, atau daftar dropdown nilai yang ditemukan oleh kueri pencarian metrik.

  • Tentukan radio untuk menggunakan kumpulan tombol radio, dengan nilai yang Anda tentukan atau yang Anda temukan dengan kueri pencarian metrik.

Nilai yang Valid: input | select | radio

Tipe: String

Diperlukan: Ya

values

Jika Anda inputType adalah select atau radio Anda ingin menentukan nilai variabel yang mungkin alih-alih menggunakan pencarian kueri metrik, tentukan nilai-nilai tersebut di sini.

valuesadalah array di mana setiap objek dalam array berisi nilai yang diperlukan dan label opsional. Setiap nilai dapat berupa string, angka, atau Boolean, dan setiap label harus berupa string. Masing-masing nilai dan label ini bisa sebanyak 255 karakter.

Jika Anda menentukan values array itu harus menyertakan setidaknya satu item, dan dapat mencakup sebanyak 500.

Misalnya, berikut ini membuat daftar tiga Wilayah yang mungkin untuk digunakan sebagai nilai untuk variabel.

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

Jenis: Array

Wajib: Ya jika inputType ada select atau radio dan Anda tidak menggunakan kueri pencarian metrik untuk mengisi nilai.

id

Id untuk variabel ini. Itu bisa hingga 32 karakter, dan karakter yang valid adalah 0-9A-Za-z-_

Tipe: String

Diperlukan: Ya

label

Label untuk ditampilkan untuk bidang input. Itu bisa memiliki sebanyak 30 karakter.

Jika Anda menghilangkan bidang ini untuk variabel properti, nama properti ditampilkan sebagai label. Jika Anda menghilangkannya untuk variabel pola, maka pattern_1, pattern_2, ... digunakan untuk label.

Tipe: String

Wajib: Tidak

defaultValue

Nilai default untuk variabel, saat dasbor pertama kali dibuka.

  • Jika inputType yainput, Anda menentukan di defaultValue sini secara manual dan menggunakan sebanyak 255 karakter

  • Jika inputType adalah select atauradio, Anda harus menentukan nilai yang mungkin valid yang Anda tentukan dalam values array atau yang diambil dalam pencarian kueri metrik.

Nilai Valid: Setiap nilai yang valid untuk variabel ini

Jenis: String, Number, atau Boolean, tergantung pada nilai tipe untuk variabel ini

Wajib: Tidak

pencarian

Tentukan bidang ini untuk mengisi kolom select atau radio input Anda dengan menggunakan ekspresi pencarian metrik. Untuk nilai bidang ini, tentukan namespace, nama dimensi, dan nama metrik. Dimensi yang Anda tentukan harus valid untuk metrik tersebut. CloudWatch menemukan semua sumber daya yang menerbitkan metrik dan dimensi itu, dan mengisi daftar dengan mereka.

Misalnya, tentukan "search": "{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\"" untuk mencari instans Amazon EC2 di akun, atau tentukan "search": "{AWS/Lambda,FunctionName} MetricName=\"Duration\"", untuk mengembalikan fungsi Lambda di akun

searchString yang Anda tentukan bisa sebanyak 2048 karakter.

catatan

Jika Anda menggunakan ekspresi pencarian dan Anda juga ingin menentukan nilai default, default yang Anda tentukan digunakan selama default itu adalah salah satu atau sumber daya yang diambil oleh pencarian. defaultValue Saat menggunakan ekspresi pencarian untuk mengisi bidang input Anda, Anda juga dapat menentukan nilai khusus __FIRST untukdefaultValue, agar nilai default menjadi nilai pertama yang dikembalikan dari pencarian. (Nilai khusus mencakup dua garis bawah dan kemudian PERTAMA) Nilai yang dikembalikan oleh pencarian selalu diurutkan berdasarkan abjad.

Tipe: String

Diperlukan: Ya jika inputType ada select atau radio dan Anda tidak menentukanvalues.

PopulateDari

Jika Anda menggunakan search bidang untuk mengisi kolom input Anda dengan menggunakan ekspresi pencarian, tentukan bidang ini dengan nama dimensi yang akan diambil oleh pencarian.

Misalnya, jika search nilai Anda adalah"search": "{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\"", maka Anda dapat menentukan InstanceId untukpopulateFrom.

Tipe: String

Diperlukan: Ya jika inputType ada select atau radio dan Anda tidak menentukanvalues.

terlihat

Ditentukan apakah label dan bidang input terlihat di dasbor. Jika Anda menghilangkan ini, default true digunakan.

Menggunakan false menghemat ruang di dasbor, tetapi mengharuskan pengguna untuk mengubah URL dasbor untuk mengubah nilai variabel.

Tipe: Boolean

Wajib: Tidak

Contoh variabel

Contoh berikut menggunakan variabel properti untuk mengubah Wilayah semua widget, menggunakan bidang input teks. Ketika dasbor pertama kali dibuka, nilai default us-east-1 digunakan untuk variabel.

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

Contoh berikut menggunakan variabel pola untuk mengubah Wilayah semua widget, dalam kasus di mana kadang-kadang Region diatur di tengah string seperti ARN.

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

Contoh berikut menghasilkan variabel fungsi Lambda, dengan tombol radio untuk setiap fungsi. Fungsi ditemukan oleh pencarian kueri metrik.

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

Contoh berikut menampilkan cara menentukan beberapa variabel dalam dasbor, dan menunjukkan beberapa jenis variabel.

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

Properti Objek Widget Teks

Widget jenis text dapat memiliki satu atau dua parameter di properties bagian. Bid markdown ang ini wajib diisi, dan transparent bidang tersebut opsional.

Untuk informasi selengkapnya tentang gaya penurunan harga yang didukung di widget CloudWatch teks, lihat Menggunakan Markdown di Konsol.

penurunan harga

Teks yang akan ditampilkan oleh widget. Gunakan parameter ini hanya untuk widget teks.

Tipe: String

Diperlukan: Ya (ketika widget type adatext).

latar belakang

Menentukan apakah widget teks memiliki latar belakang padat atau transparan. Nilai transparent membuat widget transparan. Nilai solid adalah default.

Tipe: String

Wajib: Tidak

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

Properti Objek Widget Log

Widget jenis log mewakili hasil kueri Log CloudWatch s Insights. Untuk informasi selengkapnya, lihat Menganalisis Data Log dengan CloudWatch Logs Insights.

logWidget dapat menyertakan bidang berikut di bid properties angnya.

accountId

ID akun AWS akun yang berisi log, jika ini adalah kueri lintas akun.

Tipe: String

Wajib: Tidak

region

Wilayah kueri log.

Tipe: String

Diperlukan: Ya

title

Teks judul yang akan ditampilkan oleh widget.

Tipe: String

Wajib: Tidak

kueri

Berisi fungsi query CloudWatch Logs Insights.

Tipe: String

Diperlukan: Ya (ketika widget type adalog).

queryString dimulai dengan nama-nama grup log yang akan ditanyakan. Anda harus menuliskan terlebih dahulu setiap nama grup log dengan. SOURCE Pisahkan beberapa grup log dengan karakter pipa (|).

Tambahkan karakter pipa lain setelah daftar grup log, lalu tentukan sintaks kueri. Pisahkan setiap baris dalam sintaks kueri dengan \n|

Misalnya, baris berikut mewakili kueri dari dua grup log, service_log1 danservice_log2. Kueri menampilkan kenari yang memiliki kesalahan.

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

Menentukan bagaimana hasil kueri ditampilkan. Tentukan table untuk melihat hasil sebagai tabel. Tentukan timeSeries untuk menampilkan metrik ini sebagai grafik garis. Tentukan bar untuk menampilkannya sebagai grafik batang. Tentukan pie untuk menampilkannya sebagai grafik lingkaran.

Jika Anda menghilangkan parameter ini, hasilnya ditampilkan sebagai tabel.

Tipe: String

Diperlukan: Tidak (saat widget type adalog).

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

Properti Objek Widget Metrik

Widget jenis metric dapat memiliki bidang berikut di dalamproperties:

accountId

Menentukan ID AWS akun tempat semua metrik dalam widget ini berasal. Ini berguna untuk dasbor lintas akun yang menyertakan widget dari beberapa akun. Untuk informasi selengkapnya, lihat Cross-Account Cross-Region CloudWatch Konsol.

Jika Anda menghilangkan ini, akun saat ini digunakan sebagai default. Gunakan parameter ini hanya untuk widget metrik.

Anda juga dapat menggunakan accountId bidang dalam setiap metrik dalam array metrics untuk membuat widget tunggal yang mencakup metrik dari beberapa akun.

Tipe: String

Wajib: Tidak

anotasi

Untuk menyertakan alarm atau anotasi dalam widget, tentukan annotations array. Untuk informasi lebih lanjut tentang format, lihatObjek Widget Dasbor: Properti Anotasi. Gunakan parameter ini hanya untuk widget metrik.

Tipe: Objek

Diperlukan: Anotasi alarm diperlukan hanya jika widget type metrics ditentukan metric dan tidak ditentukan. Anotasi horizontal atau vertikal tidak diperlukan.

Live Data

Tentukan true untuk menampilkan data langsung di widget. Data langsung adalah data yang diterbitkan dalam menit terakhir yang belum dikumpulkan sepenuhnya. Untuk informasi selengkapnya, lihat Menggunakan Data Langsung.

Tipe: Boolean

Wajib: Tidak

legenda

Tentukan legend untuk menentukan di mana legenda untuk garis pada grafik ditampilkan. Bid legend ang berisi bidang lain yang disebutposition. Nilai yang mungkin untuk position adalahright,bottom, danhidden.

Misalnya, berikut ini menyebabkan legenda muncul di sebelah kanan dalam grafik.

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

Tipe: Objek

Wajib: Tidak

metrik

Tentukan metrics array untuk menyertakan satu atau lebih metrik (tanpa alarm), kueri Insights Metrics, ekspresi matematika, atau ekspresi pencarian. Satu metrics array dapat mencakup 0-500 metrik dan ekspresi. Gunakan parameter ini hanya untuk widget metrik. Untuk informasi lebih lanjut tentang format metrics, lihat Widget Metrik: Format untuk Setiap Metrik dalam Array.

Satu array metrik dapat menyertakan tidak lebih dari satu kueri Insights Metrics.

Satu expression bidang tidak dapat menyertakan kueri Insights Metrics dan ekspresi matematika. Namun, Anda dapat menggunakan hasil yang dikembalikan dari kueri Insights Metrics dari satu ekspresi sebagai masukan dalam ekspresi matematika dalam ekspresi berbeda dalam array.

Jenis: Array array

Diperlukan: Ya, ketika widget type annotations ditentukan metric dan tidak ditentukan.

periode

Periode default, dalam detik, untuk semua metrik di widget ini. Periode adalah lamanya waktu yang diwakili oleh satu titik data pada grafik. Default ini dapat diganti dalam setiap definisi metrik. Gunakan parameter ini hanya untuk widget metrik. Angka default-nya adalah 300.

Nilai Valid: Setiap kelipatan 60, dengan 60 sebagai minimum.

Tipe: Integer

Wajib: Tidak

region

Wilayah metrik.

Tipe: String

Diperlukan: Ya

garis-garis

Tentukan true untuk menampilkan fitur sparkline di bawah widget angka. Tentukan false untuk menampilkan widget angka dengan sendirinya. Parameter ini diabaikan jika tampilan tidaksingleValue. Gunakan parameter ini hanya untuk widget metrik.

Tipe: Boolean

Wajib: Tidak

menumpukkan

Tentukan true untuk menampilkan grafik sebagai garis bertumpuk, atau false untuk menampilkan sebagai garis terpisah. Parameter ini diabaikan jika view adasingleValue. Gunakan parameter ini hanya untuk widget metrik.

Tipe: Boolean

Wajib: Tidak

stat

Statistik default yang akan ditampilkan untuk setiap metrik dalam array. Default ini dapat diganti dalam definisi setiap metrik individu dalam array. metrics Gunakan parameter ini hanya untuk widget metrik.

Nilai yang Val SampleCount id: Average | Sum | Minimum | Maximum | p??

Jenis: String yang merupakan CloudWatch statistik yang valid.

Wajib: Tidak

tabel

Sertakan table bagian untuk menyertakan perubahan terkait tabel data di widget. Untuk informasi lebih lanjut tentang format, lihatObjek Widget Dasbor: Properti Tabel.

Tipe: Objek

Wajib: Tidak

timezone

Zona waktu yang digunakan untuk menampilkan waktu dalam grafik. Formatnya adalah + atau - diikuti oleh empat digit. Dua digit pertama menunjukkan jumlah jam di depan atau di belakang UTC, dan dua digit terakhir adalah jumlah menit. Misalnya, +0130 menunjukkan waktu 1 jam 30 menit sebelum UTC. Default-nya adalah +0000.

Tipe: String

Wajib: Tidak

title

Judul yang akan ditampilkan untuk grafik atau angka. Gunakan parameter ini hanya untuk widget metrik.

Tipe: String

Wajib: Tidak

lihat

Tentukan timeSeries untuk menampilkan metrik ini sebagai garis atau grafik area bertumpuk. Tentukan singleValue untuk menampilkan metrik ini sebagai grafik angka. Tentukan gauge untuk menampilkan metrik ini sebagai grafik pengukur. Tentukan bar untuk menampilkan metrik ini sebagai grafik batang. Tentukan pie untuk menampilkan metrik ini sebagai grafik lingkaran.

catatan

Jika Anda menentukangauge, Anda harus menetapkan nilai untuk min dan max di sisi kiriyAxis.

Nilai yang Val timeSeries id: singleValue | gauge | bar | pie | table

Tipe: String

Wajib: Tidak

yAxis

Nilai minimum dan maksimum untuk sisi kiri dan kanan grafik Y-axis. Properti ini berlaku untuk semua metrik grafik, kecuali untuk metrik tertentu yang mengganti setelan ini. Untuk informasi selengkapnya, lihat Objek Widget Dasbor: Format Properti yAxis.

Jenis: Objek yAxis

Wajib: Tidak

Contoh: Area bertumpuk dan widget pengukur

{ "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 Metrik: Format untuk Setiap Metrik dalam Array

Setiap item dalam metrics array adalah metrik tunggal atau ekspresi matematika atau ekspresi pencarian. Setiap metrik tunggal dalam metrics array memiliki format berikut:

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

Setiap ekspresi dalam metrics array memiliki format berikut:

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

Menentukan ID AWS akun tempat metrik ini berasal. Ini memungkinkan Anda membuat widget yang berisi metrik dari beberapa akun di dasbor lintas akun. Untuk informasi selengkapnya, lihat Cross-Account Cross-Region CloudWatch Konsol.

Jika Anda menghilangkan ini, akun saat ini digunakan sebagai default. Gunakan parameter ini hanya untuk widget metrik.

Tipe: String

Wajib: Tidak

Namespace

AWS Namespace yang berisi metrik. Jika Anda memiliki beberapa entri dalam metrics array, untuk masing-masing setelah yang pertama Anda dapat menentukan hanya "." untuk menggunakan namespace yang sama dengan metrik sebelumnya dalam array.

Tipe: String

Diperlukan: Ya

MetricName

Nama met CloudWatch rik. Jika Anda memiliki beberapa entri dalam metrics array, untuk masing-masing setelah yang pertama Anda dapat menentukan hanya "." untuk menggunakan nama metrik yang sama dengan metrik sebelumnya dalam array.

Tipe: String

Diperlukan: Ya, untuk satu metrik

ekspresi

Kueri Insights Metrics, ekspresi matematika, atau ekspresi pencarian, jika ini adalah ekspresi, bukan metrik tunggal.

Dalam ekspresi pencarian yang menggunakan tanda kutip ganda untuk kecocokan yang tepat, setiap tanda kutip ganda harus dilepaskan dengan garis miring terbalik.

Untuk informasi selengkapnya tentang sintaks kueri Metrics Insights, lihat komponen kueri dan sintaks Metrics Insights.

Untuk informasi selengkapnya tentang ekspresi matematika atau ekspresi pencarian, lihat Menggunakan Matematika Metrik atau Menggunakan Ekspresi Pencarian dalam Grafik di Panduan CloudWatch Pengguna Amazon.

Tipe: String

Diperlukan: Ya, untuk ekspresi

Contoh ekspresi untuk kueri 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

Nama dimensi untuk lebih menyempurnakan data apa yang ditampilkan. Jika Anda memiliki beberapa entri dalam metrics array, untuk masing-masing setelah yang pertama Anda dapat menentukan hanya "." untuk menggunakan nama dimensi yang sama seperti dalam dimensi yang sesuai yang ditentukan dalam metrik sebelumnya dalam array. Anda dapat menentukan dimensi 0 untuk metrik, atau hingga dimensi sebanyak dukungan metrik.

Tipe: String

Wajib: Tidak

DimensionValue

Nilai yang digunakan untuk dimensi itu untuk metrik. Diperlukan jika ada nama dimensi yang sesuai.

Tipe: String

Wajib: Tidak

id

Id dari seri waktu ini. Id ini dapat digunakan sebagai bagian dari ekspresi matematika. Id harus dimulai dengan huruf kecil.

Tipe: String

Wajib: Tidak

label

Label untuk ditampilkan dalam grafik untuk mewakili deret waktu ini.

Tipe: String

Wajib: Tidak

region

Wilayah metrik. Gunakan parameter ini hanya untuk widget metrik. Jika Anda menghilangkan ini, Wilayah saat ini digunakan sebagai default.

Tipe: String

Wajib: Tidak

Objek Properti Rendering

Menentukan properti rendering yang akan digunakan untuk metrik khusus ini, mengesampingkan nilai yang ditentukan untuk keseluruhan widget. Untuk informasi lebih lanjut tentang format, lihatObjek Widget Dasbor: Format Objek Properti Rendering.

Jenis: Objek Properti Render Metrik

Wajib: Tidak

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

Objek Widget Dasbor: Format Objek Properti Rendering

Setiap metrik dalam metrics array secara opsional dapat memiliki properti rendering kustom yang menggantikan properti rendering default yang ditentukan dalam yAxis parameter widget objek. Bagian ini menjelaskan format untuk properti rendering kustom per metrik tersebut.

warna

Enam digit kode warna hex HTML yang akan digunakan untuk metrik ini.

Tipe: String

Wajib: Tidak

label

Label yang akan ditampilkan untuk metrik ini dalam legenda grafik. Jika ini tidak ditentukan, metrik diberikan label yang dibuat secara otomatis yang membedakannya dari metrik lain di widget.

Tipe: String

Wajib: Tidak

periode

Periode untuk metrik ini, dalam detik. Periode adalah lamanya waktu yang diwakili oleh satu titik data pada grafik.

Nilai Valid: Kelipatan 60, dengan minimal 60.

Tipe: Integer

Wajib: Tidak

stat

Statistik untuk metrik ini, jika harus berbeda dari statistik yang digunakan untuk metrik lain dalam array. Secara default CloudWatch menggunakan Rata-rata jika Anda tidak menentukan statistik pada array atau di tingkat metrik.

Nilai yang Val SampleCount id: Average | Sum | Minimum | Maximum | p??

Jenis: String yang merupakan CloudWatch statistik yang valid.

Wajib: Tidak

terlihat

Atur ini true agar metrik muncul dalam grafik, atau false menyembunyikannya. Defaultnya adalah true.

Tipe: Boolean

Wajib: Tidak

yAxis

Dimana pada grafik untuk menampilkan sumbu y untuk metrik ini. Nilai default-nya left.

Nilai Valid: left | right

Tipe: String

Wajib: Tidak

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

Objek Widget Dasbor: Properti Anotasi

Anotasi termasuk alarm, anotasi horizontal, dan anotasi vertikal. Widget metrik tunggal dapat memiliki hingga satu alarm, atau dapat memiliki satu atau lebih anotasi horizontal atau vertikal. Widget tunggal tidak dapat memiliki alarm dan anotasi horizontal atau vertikal.

Anotasi Alarm

Jika Anda menentukan anotasi alarm, Anda juga tidak dapat menentukan metrics array di widget yang sama.

alarm

Nama Sumber Daya Amazon (ARN) dari alarm.

Jenis: Array string. Mungkin ada 0—1 string dalam array.

Diperlukan: Hanya jika tidak ada metrik yang terdaftar.

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

Anotasi Horizontal

horisontal

Array anotasi horizontal. Anotasi horizontal memiliki beberapa opsi untuk bayangan isi, termasuk bayangan di atas garis anotasi, bayangan di bawah garis anotasi, dan bayangan “pita” yang muncul di antara dua garis anotasi terkait sebagai bagian dari anotasi pita tunggal. Setiap anotasi horizontal dalam array yang merupakan anotasi tunggal, bukan anotasi band, memiliki format berikut:

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

Setiap anotasi horizontal yang merupakan anotasi pita memiliki format sebagai berikut:

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

Nilai metrik dalam grafik tempat garis anotasi horizontal akan muncul. Pada anotasi bayangan pita, dua nilai untuk Nilai menentukan tepi atas dan bawah pita.

Pada grafik dengan anotasi horizontal, grafik diskalakan sehingga semua anotasi horizontal yang terlihat muncul pada grafik.

Tipe: Float

Wajib: Ya

label

Sebuah string yang muncul pada grafik di sebelah anotasi.

Tipe: String

Wajib: Tidak

warna

Enam digit kode warna hex HTML yang akan digunakan untuk anotasi. Warna ini digunakan untuk garis anotasi dan bayangan isian.

Tipe: String

Wajib: Tidak

mengisi

Cara menggunakan fill shadow dengan anotasi. Nilai yang valid adalah above untuk bayangan di atas anotasi, below untuk bayangan di bawah anotasi, dan none untuk tanpa bayangan. Jika fill dihilangkan, tidak ada bayangan.

Pengecualiannya adalah anotasi dengan naungan band. Anotasi ini selalu memiliki bayangan antara dua nilai, dan nilai apa pun untuk diab fill aikan.

Tipe: String

Wajib: Tidak

terlihat

Atur ini true agar anotasi muncul di grafik, atau false disembunyikan. Defaultnya adalah true.

Tipe: Boolean

Wajib: Tidak

yAxis

Jika grafik menyertakan beberapa metrik, tentukan apakah angka dalam Value mengacu pada metrik yang terkait dengan kiri Y-axis atau kanan Y-axis,. Nilai yang valid adalah right dan left.

Tipe: String

Wajib: Tidak

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

Anotasi Vertikal

vertikal

Array anotasi vertikal. Untuk setiap anotasi vertikal, Anda dapat memilih untuk memiliki bayangan isian sebelum anotasi, setelahnya, atau di antara dua garis vertikal yang dihubungkan sebagai anotasi pita tunggal. Setiap anotasi vertikal dalam array yang merupakan anotasi tunggal, bukan anotasi band, memiliki format berikut:

{value, label, color, fill, visible}

Setiap anotasi vertikal yang merupakan anotasi band memiliki format sebagai berikut:

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

Tanggal dan waktu dalam grafik tempat garis anotasi vertikal akan muncul. Pada anotasi bayangan pita, dua nilai untuk Nilai menentukan tepi awal dan akhir pita.

Pada grafik dengan anotasi vertikal, grafik diskalakan sehingga semua anotasi vertikal yang terlihat muncul pada grafik.

Ini didefinisikan sebagai string dalam format ISO 8601. Untuk informasi selengkapnya, lihat ISO 8601.

Tipe: String

Diperlukan: Ya

label

Sebuah string yang muncul pada grafik di sebelah anotasi.

Tipe: String

Wajib: Tidak

warna

Enam digit kode warna hex HTML yang akan digunakan untuk anotasi. Warna ini digunakan untuk garis anotasi dan bayangan isian.

Tipe: String

Wajib: Tidak

mengisi

Cara menggunakan fill shadow dengan anotasi. Nilai yang valid adalah before untuk bayangan sebelum anotasi, after untuk bayangan setelah anotasi, dan none untuk tanpa bayangan. Jika fill dihilangkan, tidak ada bayangan.

Pengecualiannya adalah anotasi dengan naungan band. Anotasi ini selalu memiliki bayangan antara dua nilai, dan nilai apa pun untuk diab fill aikan.

Tipe: String

Wajib: Tidak

terlihat

Atur ini true agar anotasi muncul di grafik, atau false disembunyikan. Defaultnya adalah true.

Tipe: Boolean

Wajib: Tidak

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

Objek Widget Dasbor: Format Properti yAxis

Mendefinisikan pengaturan Y-axis untuk grafik. Pengaturan termasuk maksimum dan minimum, label untuk sumbu, dan apakah sumbu menunjukkan unit. Tetapkan ini di dalam widget objek untuk mempengaruhi semua metrik di widget. Untuk mengganti pengaturan widget untuk metrik tertentu, tetapkan untuk metrik dalam metrics array.

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

Pengaturan opsional untuk kiri Y-axis.

Jenis: Objek yAxis

Wajib: Tidak

kanan

Pengaturan opsional untuk kanan Y-axis.

Jenis: Objek yAxis

Wajib: Tidak

Masing-masing left dan right objek dapat mencakup parameter berikut:

label

Label untuk ini Y-axis

Tipe: String

Wajib: Tidak

min

Nilai minimum untuk ini Y-axis

tipe: Mengambang

Wajib: Tidak

max

Nilai maksimum untuk ini Y-axis

tipe: Mengambang

Wajib: Tidak

Tampilkan Unit

Menentukan apakah unit ditampilkan untuk metrik yang terkait dengan sumbu ini. Bawaannya adalah benar.

Tipe: Boolean

Wajib: Tidak

Objek Widget Dasbor: Properti Tabel

Jika Anda menentukan table untuk widget metrik, Anda dapat menyertakan visualisasi yang terkait dengan visibilitas kolom ringkasan, kolom titik data, dan tata letak tabel. Properti ini hanya berpengaruh jika jenis tampilan widget adalah table dan tidak mengubah jenis tampilan lain jika disertakan. Pro table perti tidak diperlukan untuk menggunakan widget tabel.

tata letak

Gunakan bidang ini untuk mengubah tabel sedemikian rupa sehingga titik data memanjang secara vertikal atau horizontal. Nilai default-nya horizontal.

Nilai Valid: vertical | horizontal

Tipe: String

Wajib: Tidak

Ringkasan lengket

Atur ini true untuk membuat kolom ringkasan yang Anda sertakan dalam tabel lengket, sehingga Anda dapat menjelajahi kolom data sambil selalu memiliki kolom ringkasan di viewport Anda. Nilai default-nya false.

Label widget selalu lengket, tidak peduli pilihan Anda di bidang ini.

Nilai Valid: true | false

Tipe: Boolean

Wajib: Tidak

menunjukkan TimeSeriesData

Setel ini ke false jika Anda ingin hanya kolom label dan ringkasan yang ditampilkan, menyembunyikan kolom data lainnya.

Nilai default-nya true.

Nilai Valid: true | false

Tipe: Boolean

Wajib: Tidak

RingkasanKolom

Kolom ringkasan adalah properti baru yang diperkenalkan dengan widget tabel. Kolom-kolom ini adalah subset spesifik dari ringkasan tabel Anda saat ini. Misalnya, Sum ringkasan adalah jumlah dari semua titik data yang dirender di baris masing-masing. Kolom ringkasan bukanlah konsep yang sama dengan statistik CloudWatch metrik apa pun.

Bawaannya adalah ["MIN", "MAX","SUM", "AVG"]

Nilai yang valid: "MIN" | "MAX" | "SUM" | "AVG"

Jenis: Array

Wajib: Tidak

Misalnya, JSON berikut membuat tabel menampilkan minimum dan maksimum setiap metrik dalam tabel.

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

Properti Objek Widget Metrics Explorer

Widget jenis explorer mewakili widget penjelajah metrik. Untuk informasi selengkapnya, lihat Menggunakan Metrik Explorer untuk Memantau Sumber Daya berdasarkan Tag dan Properti

Anda juga dapat menambahkan widget penjelajah metrik ke dasbor menggunakan CloudFormation. Untuk informasi selengkapnya, lihat AWS::CloudWatch: :Dasbor.

Jenis widget ini dapat memiliki bidang berikut dalam widgetproperties:

AgregatBy

Objek yang menentukan cara menggabungkan metrik dari beberapa sumber daya. Nilai yang valid untuk key bidang dalam objek ini adalah kunci tag dan properti sumber daya. Objek ini berisi bidang berikut.

  • kunci — Tag atau kunci properti sumber daya yang digunakan untuk menggabungkan metrik.

  • func — Fungsi agregasi untuk digunakan. Nilai yang valid adalah AVG MIN | MAX | STDDEV | SUM

Tipe: Objek

Wajib: Tidak

label

Array tag atau properti sumber daya yang digunakan untuk menentukan metrik mana yang ditampilkan di widget.

Jika Anda menentukan kunci yang berbeda, maka hanya sumber daya yang cocok dengan semua key/value pasangan yang ditampilkan. Jika Anda menentukan beberapa nilai untuk satu kunci, sumber daya yang cocok dengan salah satu nilai untuk kunci tersebut akan ditampilkan.

  • key — Tag atau properti sumber daya untuk difilter.

    Untukkey, semua kunci tag valid untuk ditentukan. Properti sumber daya EC2 dan Lambda berikut juga berlaku untuk: 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, dan Timeout

  • value — (Opsional) Nilai tag atau properti resource untuk difilter. Jika ini dihilangkan, metrik yang sesuai dengan semua nilai tag atau properti resource akan ditampilkan.

Tipe: Objek

Wajib: Ya

metrik

Tentukan metrics array untuk menyertakan satu atau lebih metrik. Satu metrics array dapat mencakup 1-100 metrik. Setiap objek dalam array harus berisi bidang berikut.

  • MetricName — Nama metrik.

  • ResourceType — Jenis sumber daya yang menerbitkan metrik, dijelaskan dalam format yang digunakan oleh. AWS CloudFormation Misalnya, AWS::EC2::Instance atau AWS::Lambda::Function.

    Anda harus menggunakan nilai yang sama resourceType untuk semua metrik di widget.

    Untuk daftar lengkap nilai yang valid, lihatNilai ResourceType yang Valid untuk Objek Widget Metric Explorer.

  • stat — Statistik untuk metrik ini, jika harus berbeda dari statistik yang digunakan untuk metrik lain dalam array. Secara default CloudWatch menggunakan Rata-rata jika Anda tidak menentukan statistik pada array atau di tingkat metrik.

    Nilai yang Val SampleCount id: Average | Sum | Minimum | Maximum | p??

Tipe: Array objek

Wajib: Ya

periode

Periode default, dalam detik, untuk semua metrik di widget ini. Periode adalah lamanya waktu yang diwakili oleh satu titik data pada grafik. Angka default-nya adalah 300.

Nilai Valid: Setiap kelipatan 60, dengan 60 sebagai minimum.

Tipe: Integer

Wajib: Tidak

SplitBy

Menentukan cara membagi metrik dari beberapa sumber daya menjadi baris yang berbeda pada grafik, atau ke dalam grafik yang berbeda. Nilai yang valid adalah kunci tag, dan kunci properti sumber daya.

Tipe: String

Wajib: Tidak

title

Judul yang akan ditampilkan untuk widget. Default-nya adalah Explorer.

Tipe: String

Wajib: Tidak

WidgetOptions

Objek yang menentukan bagaimana widget muncul di dasbor. Ini dapat berisi bidang berikut.

  • legenda

    Menentukan di mana legenda untuk setiap grafik ditampilkan. Bid legend ang berisi bidang lain yang disebutposition. Nilai yang mungkin untuk position adalahright,bottom, danhidden.

    Misalnya, berikut ini menyebabkan legenda muncul di sebelah kanan dalam grafik.

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

    Menentukan berapa banyak baris grafik yang ditampilkan per halaman di widget.

  • ditumpuk -

    Tentukan true untuk menampilkan grafik sebagai bagan area bertumpuk, atau false untuk menampilkan sebagai garis terpisah.

  • melihat

    Menentukan bagaimana setiap grafik ditampilkan. Tentukan timeSeries untuk menampilkan metrik ini sebagai grafik garis. Tentukan bar untuk menampilkannya sebagai grafik batang. Tentukan pie untuk menampilkannya sebagai grafik lingkaran. Nilai default-nya timeSeries.

  • widget PerRow

    Menentukan berapa banyak grafik yang ditampilkan di setiap baris widget penjelajah metrik.

Tipe: Objek

Wajib: Tidak

Contoh

Contoh berikut menampilkan tiga metrik untuk setiap instans EC2 akun yang sedang berjalan, dengan grafik di widget dibagi berdasarkan zona ketersediaan. Dalam setiap grafik, metrik digabungkan berdasarkan jenis instance.

{ "widgets": [ { "type": "explorer", "width": 24, "height": 15, "x": 0, "y": 0, "properties": { "metrics": [ { "metricName": "CPUUtilization", "resourceType": "AWS::EC2::Instance", "stat": "Average" }, { "metricName": "NetworkIn", "resourceType": "AWS::EC2::Instance", "stat": "Average" }, { "metricName": "NetworkOut", "resourceType": "AWS::EC2::Instance", "stat": "Average" } ], "aggregateBy": { "key": "InstanceType", "func": "MAX" }, "labels": [ { "key": "State", "value": "running" } ], "widgetOptions": { "legend": { "position": "bottom" }, "view": "timeSeries", "rowsPerPage": 8, "widgetsPerRow": 2 }, "period": 300, "splitBy": "AvailabilityZone", "title": "Running EC2 Instances by AZ" } } ] }

Nilai ResourceType yang Valid untuk Objek Widget Metric Explorer

Nilai yang valid untuk resourceType bidang di metrics bagian widget penjelajah metrik adalah sebagai berikut:

  • 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

Properti Objek Widget Status Alarm

Widget jenis alarm dapat memiliki bidang berikut di dalamnyaproperties.

alarm

Array ARN alarm untuk disertakan dalam widget. Array dapat memiliki 1-100 ARN.

Tipe: Array string

Diperlukan: Ya (ketika widget type adaalarm).

Urutkan oleh

Menentukan cara mengurutkan alarm di widget.

Pilih default untuk mengurutkannya dalam urutan abjad berdasarkan nama alarm.

Pilih stateUpdatedTimestamp untuk mengurutkannya terlebih dahulu berdasarkan status alarm, dengan alarm dalam status ALARM terlebih dahulu, alarm INSUFFICIENT_DATA berikutnya, dan alarm OK terakhir. Dalam setiap grup, alarm diurutkan berdasarkan kapan terakhir mereka mengubah status, dengan perubahan status yang lebih baru terdaftar terlebih dahulu.

Pilih timestamp untuk mengurutkannya berdasarkan waktu ketika alarm terakhir berubah status, tidak peduli status alarm saat ini. Alarm yang berubah status baru-baru ini terdaftar terlebih dahulu.

Jika Anda menghilangkan bidang ini, alarm diurutkan dalam urutan abjad.

Tipe: String

Nilai yang Valid: default | status UpdatedTimestamp | stempel waktu

Wajib: Tidak

negara

Gunakan bidang ini untuk memfilter daftar alarm yang ditampilkan di widget ke hanya alarm yang saat ini berada dalam status yang ditentukan. Anda dapat menentukan satu atau lebih status alarm dalam nilai untuk bidang ini. Alarm menyatakan bahwa Anda dapat menentukan adalahALARM,INSUFFICIENT_DATA, danOK.

Jika Anda menghilangkan bidang ini atau menentukan array kosong, semua alarm yang ditentukan alarms ditampilkan.

Tipe: Array string

Wajib: Tidak

title

Teks judul yang akan ditampilkan oleh widget.

Tipe: String

Wajib: Tidak

Contoh berikut adalah widget status alarm yang menampilkan empat alarm yang ditentukan berdasarkan nama, tidak peduli statusnya saat ini:

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

Widget contoh berikut menentukan empat alarm yang sama, tetapi widget hanya menampilkan alarm yang saat ini dalam status ALARM atau 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" } }

Properti Objek Widget Bagan

Widget jenis chart adalah widget bagan multi-sumber data yang mendukung kueri PromQL terhadap metrik. CloudWatch Gunakan widget bagan untuk memvisualisasikan metrik yang dapat dikueri dengan PromQL, termasuk metrik yang dicerna melalui OpenTelemetry Line Protocol (OTLP) dan metrik yang dijual yang AWS telah diperkaya untuk oTel. Untuk informasi selengkapnya tentang kueri dengan PromQL, lihat. Metrik kueri dengan PromQL

Widget jenis chart dapat memiliki bidang berikut di dalamproperties:

lihat

Visualisasi yang akan digunakan untuk widget.

Nilai yang Val line id: bar pie | number | solidgauge | column | legend | histogram | heatmap | scatter

Tipe: String

Diperlukan: Ya

title

Judul yang akan ditampilkan untuk widget.

Tipe: String

Wajib: Tidak

deskripsi

Deskripsi opsional untuk widget.

Tipe: String

Wajib: Tidak

region

Wil AWS ayah yang akan digunakan untuk semua kueri di widget. Setiap query dalam data.queries array dapat mengganti ini dengan bidangnya sendiriregion.

Tipe: String

Wajib: Tidak

data

Kueri untuk plot di widget. Ob data jek berisi queries array, di mana setiap entri mendefinisikan satu query. Untuk informasi lebih lanjut tentang format, lihatWidget Bagan: Format untuk Setiap Query dalam Array.

Tipe: Objek

Wajib: Ya

PlotOptions

Opsi visualisasi untuk widget, seperti penempatan legenda, konfigurasi sumbu, dan pengaturan gaya tampilan khusus (misalnya, lebar garis atau batang bertumpuk). Bidang pasti yang tersedia tergantung pada nilaiview. Jika Anda menghilangkanplotOptions, pengaturan default untuk tampilan digunakan. Untuk daftar lengkap bidang, lihatWidget Bagan: Referensi PlotOptions.

Tipe: Objek

Wajib: Tidak

Widget Bagan: Format untuk Setiap Query dalam Array

Setiap entri dalam data.queries array mendefinisikan satu query. Untuk membuat widget bagan yang menanyakan CloudWatch metrik, set cloudwatch-metrics el type language ke, setel ke salah satu PromQL atauSQL, dan berikan ekspresi kueri sebagai string di query bidang. Widget bagan tunggal dapat mencampur kueri yang ditulis dalam bahasa yang berbeda.

id

Pengidentifikasi untuk kueri ini. ID harus unik di dalam widget.

Tipe: String

Diperlukan: Ya

jenis

Jenis kueri. Untuk PromQL, gunakan. cloudwatch-metrics

Nilai Valid: cloudwatch-metrics

Tipe: String

Diperlukan: Ya

language

Bahasa query untuk query ini. Tentukan PromQL untuk menulis kueri di Prometheus Query Language, atau SQL untuk menulis kueri di CloudWatch Metrics Insights SQL.

Nilai Valid: PromQL | SQL

Tipe: String

Diperlukan: Ya

kueri

Ekspresi query untuk mengevaluasi, sebagai string. Sintaks tergantung pada language bidang.

Untuk PromQL, berikan ekspresi Bahasa Kueri Prometheus. Misalnya, sum by (InstanceId) (rate(CPUUtilization[5m])). Untuk informasi tentang sintaks PromQL dan label yang tersedia pada metrik yang AWS dijual, lihat. Kueri dijual AWS metrik dengan PromQL

Untuk SQL, berikan kueri SQL Insights CloudWatch Metrics. Misalnya, SELECT AVG(CPUUtilization) FROM SCHEMA("AWS/EC2", InstanceId) GROUP BY InstanceId. Untuk informasi tentang sintaks kueri Metrics Insights, lihat komponen kueri dan sintaks Metrics Insights.

Tipe: String

Diperlukan: Ya

label

Label yang akan ditampilkan dalam legenda untuk seri kueri ini. Tentukan nilai khusus __verbose__ untuk menyertakan semua label metrik di setiap nama seri.

Tipe: String

Wajib: Tidak

region

Wil AWS ayah untuk mengevaluasi kueri ini. Jika dihilangkan, widget region digunakan.

Tipe: String

Wajib: Tidak

accountId

AWS Akun untuk mengevaluasi kueri ini. Gunakan ini untuk kueri lintas akun di dasbor akun pemantauan.

Tipe: String

Wajib: Tidak

langkah

Resolusi kueri, dalam hitungan detik. Ini mengontrol seberapa sering ekspresi PromQL dievaluasi di seluruh rentang waktu widget.

Jenis: Angka

Wajib: Tidak

terlihat

Setel false untuk menyembunyikan seri kueri ini dari bagan sambil tetap menyimpan kueri dalam definisi widget. Defaultnya adalah true.

Tipe: Boolean

Wajib: Tidak

Widget Bagan: Referensi PlotOptions

Ob plotOptions jek mengontrol bagaimana grafik dirender. Ini dapat berisi satu set bidang umum yang dibagikan oleh setiapview, ditambah style objek yang bentuknya tergantung pada yang dipilihview. Beberapa tampilan juga menerima sumbu (yAxis,xAxis) dan annotations objek.

Tabel berikut merangkum bidang mana yang view didukung masing-masing.

melihat

gaya sub-objek

yAksis/xAxis

Dukungan anotasi

line

LineStyle

Ya

Ya (vertikal dan horizontal)

bar

BarStyle

Ya

Ya (vertikal dan horizontal)

column

BarStyle

Ya

Tidak

pie

PieStyle

Tidak

Tidak

number

NumberStyle

Tidak

Tidak

solidgauge

GaugeStyle

Tidak

Ya (horizontal)

scatter

ScatterStyle

Ya

Ya (vertikal dan horizontal)

histogram

BarStyle + HistogramStyle

Ya

Tidak

heatmap

HeatmapStyle

Ya

Tidak

Bidang PlotOptions umum

Bidang berikut valid plotOptions untuk setiapview.

legenda

Mengkonfigurasi legenda. Objek berisi kolom-kolom berikut:

  • posisi— Di mana legenda muncul di widget. Nilai yang valid adalah bottom dan right.

  • tampilkan— Boolean. Setel false untuk menyembunyikan legenda.

Tipe: Objek

Wajib: Tidak

View-specific bidang gaya

Bentuk style objek tergantung pada nilaiview.

Opsi garis

Digunakan view kapanline. Mengkonfigurasi rendering baris. Objek berisi kolom-kolom berikut:

  • lebar— Nomor. Lebar garis dalam piksel.

  • pola- Pola goresan garis. Nilai yang valid adalah solid, dashed, dan dotted.

  • spline— Boolean. Jikatrue, menggambar kurva yang dihaluskan melalui titik data.

  • diisi— Boolean. Jikatrue, mengisi area di bawah garis.

  • ditumpuk— Boolean. Jikatrue, tumpukan area yang terisi di seluruh seri. Gunakan dengan filled: true untuk bagan area bertumpuk.

  • warna- Warna hex HTML enam digit.

Tipe: Objek

Wajib: Tidak

BarPilihan

Digunakan view kapanbar,column, atauhistogram. Mengkonfigurasi rendering bar. Objek berisi kolom-kolom berikut:

  • ditumpuk— Boolean. Jikatrue, bar dari seri yang berbeda ditumpuk.

  • orientasi- Arah bar. Nilai yang valid adalah vertical dan horizontal.

Tipe: Objek

Wajib: Tidak

Opsi Pie

Digunakan view kapanpie. Objek berisi kolom-kolom berikut:

  • InnerSize- String. Persentase seperti"50%". Setel ke "0%" untuk pai padat, atau nilai bukan nol untuk bagan donat.

Tipe: Objek

Wajib: Tidak

Nomor Pilihan

Digunakan view kapannumber. Objek berisi kolom-kolom berikut:

  • sparkline— Boolean. Jikatrue, menampilkan garis kilau di bawah angka.

  • memotong— Boolean. Jikatrue, memotong angka besar (misalnya, menampilkan alih- 1.2K alih1234).

Tipe: Objek

Wajib: Tidak

Opsi pengukur

Digunakan view kapansolidgauge. Objek berisi kolom-kolom berikut:

  • min— Nomor. Nilai minimum pengukur.

  • maks— Jumlah. Nilai maksimum pengukur.

Tipe: Objek

Wajib: Tidak

Pilihan warna

Digunakan view kapanheatmap. Mengkonfigurasi gradien warna. Objek berisi kolom-kolom berikut:

  • ColorPreset- String. Nama skala warna bawaan.

  • MinColor— Warna hex HTML enam digit yang digunakan di ujung bawah gradien kustom.

  • MidColor— Warna hex HTML enam digit yang digunakan di titik tengah gradien kustom.

  • MaxColor- Warna hex HTML enam digit yang digunakan di ujung atas gradien kustom.

Tipe: Objek

Wajib: Tidak

HistogramOpsi

Digunakan ketika view adahistogram, selain itubarOptions. Objek berisi kolom-kolom berikut:

  • BucketCount— Nomor. Jumlah bucket untuk membagi data.

  • BucketSize— Nomor, atau string "auto" untuk mengukur bucket secara otomatis.

  • CombineSeries— Boolean. Menggabungkan semua seri menjadi satu histogram.

Tipe: Objek

Wajib: Tidak

Opsi agregasi

Digunakan view kapanhistogram. Mengontrol bagaimana titik data dikumpulkan sebelum bucketing. Objek berisi kolom-kolom berikut:

  • binInterval— String. Lebar bin sebagai durasi. Misalnya, "5m" untuk tempat sampah lima menit.

Tipe: Objek

Wajib: Tidak

label

Digunakan dengan gaya garis, batang, dan pencar untuk memberi label titik data langsung pada grafik. Objek berisi kolom-kolom berikut:

  • posisi— Di mana label muncul relatif terhadap titik datanya. Nilai yang valid adalahinside,outside,top,bottom,left, danright.

  • tampilkan— Boolean. Setel true untuk menampilkan label.

Tipe: Objek

Wajib: Tidak

MarkOptions

Digunakan dengan gaya garis dan pencar untuk mengkonfigurasi penanda yang digambar pada titik data. Objek berisi kolom-kolom berikut:

  • diaktifkan— Boolean. Atur true untuk menggambar spidol.

  • SymbolType— String. Bentuk penanda. Sebagai contoh, circle, square, atau diamond.

  • Ukuran Simbol— Nomor. Ukuran penanda dalam piksel.

  • BorderWidth- Nomor. Lebar batas penanda dalam piksel.

  • BorderColor- Warna hex HTML enam digit untuk batas penanda.

  • FillColor- Warna hex HTML enam digit untuk isian penanda.

  • FilloPacity— Angka antara 0 dan 1.

Tipe: Objek

Wajib: Tidak

Bidang yAxis dan xAxis

Untuk view nilai yang mendukung sumbu, Anda dapat menyertakan yAxis dan xAxis objek di dalamnyaplotOptions.

yAxis

Array dari satu atau dua objek sumbu. Entri pertama mengonfigurasi sumbu kiri, dan entri kedua (jika ada) mengonfigurasi sumbu kanan. Setiap objek sumbu berisi bidang berikut:

  • min— Nomor. Batas bawah sumbu.

  • maks— Jumlah. Batas atas sumbu.

  • jenis— Skala sumbu. Nilai yang valid adalah linear, logarithmic, datetime, dan category.

  • judul— String. Label sumbu ditampilkan di samping sumbu.

  • ShowUnits- Boolean. Apakah akan menampilkan sufiks unit (misalnya,K,M) pada label centang.

Tipe: Array objek

Wajib: Tidak

XAxis

Objek sumbu tunggal yang mengkonfigurasi sumbu x. Objek berisi kolom-kolom berikut:

  • min— Nomor. Batas bawah sumbu.

  • maks— Jumlah. Batas atas sumbu.

  • jenis— Skala sumbu. Nilai yang valid adalah linear, logarithmic, datetime, dan category.

  • judul— String. Label sumbu ditampilkan di samping sumbu.

  • label- String. Centang format label.

Tipe: Objek

Wajib: Tidak

anotasi

Untuk view nilai yang mendukung anotasi, Anda dapat menambahkan garis referensi atau pita berbayang ke bagan. Ob annotations jek dapat berisi array berikut:

vertikal

Anotasi pada sumbu waktu. Setiap entri adalah objek anotasi, atau array dua objek anotasi untuk menentukan pita (wilayah berbayang antara dua nilai). Setiap objek anotasi berisi bidang berikut:

  • jenis- Jenis anotasi. Gunakan static.

  • label- String. Teks ditampilkan di sebelah anotasi.

  • nilai— Nomor, ISO-8601 string stempel waktu, atau kategori. Lokasi pada sumbu waktu tempat anotasi muncul.

  • warna— Warna hex HTML enam digit yang digunakan untuk garis anotasi dan bayangan isian apa pun.

  • mengisi- Cara menggunakan bayangan isi. Nilai yang valid adalah before (bayangan sebelum anotasi), after (bayangan setelah anotasi), dan between (digunakan untuk anotasi pita untuk menaungi antara dua nilai).

Jenis: Array

Wajib: Tidak

horisontal

Anotasi pada sumbu nilai. Setiap entri adalah objek anotasi, atau array dari dua objek anotasi untuk menentukan pita. Setiap objek anotasi berisi bidang berikut:

  • jenis- Jenis anotasi. Gunakan static.

  • label- String. Teks ditampilkan di sebelah anotasi.

  • nilai— Nomor. Nilai pada sumbu nilai tempat anotasi muncul.

  • warna— Warna hex HTML enam digit yang digunakan untuk garis anotasi dan bayangan isian apa pun.

  • mengisi- Cara menggunakan bayangan isi. Nilai yang valid adalah above (bayangan di atas anotasi), below (bayangan di bawah anotasi), dan between (digunakan untuk anotasi pita untuk menaungi antara dua nilai).

Jenis: Array

Wajib: Tidak

Contoh: Bagan garis PromQL

Contoh berikut merender bagan garis yang memplot kueri PromQL terhadap metrik yang dijual di AWS . 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 } } } }

Contoh: Bagan yang menggabungkan kueri PromQL dan kueri SQL

Contoh berikut menunjukkan bagan garis yang memplot dua kueri terhadap metrik yang sama, satu ditulis dalam PromQL dan satu ditulis dalam CloudWatch Metrics Insights SQL.

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