Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Struktur dan Sintaks Tubuh Dasbor
Daftar Isi
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 satu dasbor fleksibel yang dapat menampilkan metrik utama untuk sumber daya yang berbeda. Dalam contoh ini, fungsi ditemukan oleh kueri penelusuran metrik, sehingga dasbor secara otomatis menemukan fungsi Lambda baru saat 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 instans 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 lainnya yang menunjukkan seluruh sintaks perintah, lihat PutDashboarddi Referensi Amazon CloudWatch API.
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 dashboard yang digunakan di dashboard. Untuk informasi selengkapnya tentang bidang yang dapat Anda gunakan di setiap objek variabel dasbor, lihatStruktur Array Variabel.
Untuk informasi selengkapnya tentang variabel dasbor, lihat Membuat dasbor fleksibel dengan variabel dasbor.
Jika Anda menyertakan
variablesarray, itu dapat berisi antara 0 dan 25 objek variabel.Wajib: Tidak
- end
-
Akhir rentang waktu yang digunakan untuk setiap widget di dasbor saat dasbor dimuat. Jika Anda menentukan
end, maka Anda juga harus menentukan nilaistart. 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 digunakan untuk setiap widget di dasbor.
Anda dapat menentukan
starttanpa menentukanenduntuk menentukan rentang waktu relatif yang berakhir dengan waktu saat ini. Dalam hal ini, nilaistartharus dimulai dengan-PTjika Anda menentukan rentang waktu dalam menit atau jam, dan harus dimulai dengan-Pjika 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,-PT5Mmenunjukkan 5 menit terakhir,-PT8Hmenunjukkan 8 jam terakhir, dan-P3Mmenunjukkan tiga bulan terakhir.Anda juga dapat menggunakan
startbersama denganendbidang, untuk menentukan rentang waktu absolut. Saat menentukan rentang waktu absolut, gunakan format ISO 8601. Misalnya,2018-12-17T06:00:00.000Z.Jika Anda menghilangkan
start, dasbor menunjukkan rentang waktu default saat dimuat.Tipe: String
Wajib: Tidak
- Periodoverride
-
Gunakan bidang ini untuk menentukan periode grafik saat dasbor dimuat. Menentukan
automenyebabkan periode semua grafik di dasbor secara otomatis beradaptasi dengan rentang waktu dasbor. Menentukaninheritmemastikan bahwa periode yang ditetapkan untuk setiap grafik selalu dipatuhi.Nilai yang Valid: auto | mewarisi
Tipe: String
Wajib: Tidak
Struktur Array Widget
Setiap widget jenis apa pun dapat memiliki properti berikut.
- jenis
-
Jenis widget.
Nilai yang Valid:
metrictextlog| |alarm|explorer|chartTipe: String
Diperlukan: Ya
- x
-
Posisi horizontal widget pada kisi dasbor 24 kolom. Defaultnya adalah posisi berikutnya yang tersedia.
Nilai yang Valid: 0—23
Jenis: Integer
Diperlukan: Ya, jika
yditentukan. Kalau tidak tidak diperlukan. - y
-
Posisi vertikal widget pada kisi dasbor 24 kolom. Defaultnya adalah posisi berikutnya yang tersedia.
Nilai Valid: Setiap bilangan bulat, 0 atau lebih tinggi.
Jenis: Integer
Diperlukan: Ya, jika
xditentukan. Kalau tidak tidak diperlukan. - lebar
-
Lebar widget dalam unit grid (dalam kisi 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 rinci widget, yang berbeda tergantung pada jenis widget. Untuk informasi selengkapnya tentang format
properties, lihatProperti Objek Widget Metrik,Properti Objek Chart Widget, atauProperti dari Objek Widget Teks.Tipe: Objek
Wajib: Ya
Struktur Array Variabel
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 yang berikut:
Setiap properti JSON dalam definisi widget, seperti
region.Nama dimensi apa pun untuk metrik, seperti
InstanceIdatauFunctionName.
Variabel pola mengubah pola ekspresi reguler di dasbor JSON. Gunakan ketika 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|patternTipe: String
Diperlukan: Ya
- inputType
-
Menentukan bagaimana pengguna dasbor memasukkan nilai untuk variabel.
Tentukan
inputuntuk menggunakan kotak teks yang pengguna dapat memasukkan nilai ke dalamnya.Tentukan
selectuntuk menggunakan kumpulan nilai tarik-turun yang Anda tentukan, atau daftar tarik-turun nilai yang ditemukan oleh kueri penelusuran metrik.Tentukan
radiountuk menggunakan satu set tombol radio, dengan nilai yang Anda tentukan atau yang Anda temukan dengan kueri penelusuran metrik.
Nilai yang Valid:
input|select|radioTipe: String
Diperlukan: Ya
- values
-
Jika Anda
inputTypeselectatauradiodan 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
valuesarray itu harus menyertakan setidaknya satu item, dan dapat mencakup sebanyak 500.Misalnya, berikut ini membuat daftar tiga kemungkinan Wilayah 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
inputTypeadaselectatauradiodan Anda tidak menggunakan kueri penelusuran metrik untuk mengisi nilai. - id
-
Id untuk variabel ini. Bisa sampai 32 karakter, dan karakter yang valid
0-9A-Za-z-_Tipe: String
Diperlukan: Ya
- label
-
Label untuk ditampilkan untuk bidang input. Itu dapat memiliki sebanyak 30 karakter.
Jika Anda menghilangkan bidang ini untuk variabel properti, nama properti ditampilkan sebagai label. Jika Anda menghilangkannya untuk variabel pola, maka
digunakan untuk label.pattern_1,pattern_2, ...Tipe: String
Wajib: Tidak
- defaultValue
-
Nilai default untuk variabel, ketika dashboard pertama kali dibuka.
Jika
inputTypeyainput, Anda menentukan didefaultValuesini secara manual dan menggunakan sebanyak 255 karakterJika
inputTypeadaselectatauradio, Anda harus menentukan kemungkinan nilai valid yang Anda tentukan dalamvalueslarik atau yang diambil dalam pencarian kueri metrik.
Nilai Valid: Nilai apa pun yang valid untuk variabel ini
Type: String, Number, atau Boolean, tergantung pada nilai tipe untuk variabel ini
Wajib: Tidak
- pencarian
-
Tentukan bidang ini untuk mengisi kolom Anda
selectatauradioinput dengan menggunakan ekspresi pencarian metrik. Untuk nilai bidang ini, tentukan namespace, nama dimensi, dan nama metrik. Dimensi yang Anda tentukan harus valid untuk metrik itu. CloudWatch menemukan semua sumber daya yang mempublikasikan 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 akunsearchString 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.
defaultValueSaat menggunakan ekspresi pencarian untuk mengisi kolom input Anda, Anda juga dapat menentukan nilai khusus__FIRSTuntukdefaultValue, 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 menurut abjad.Tipe: String
Wajib: Ya jika
inputTypeadaselectatauradiodan Anda tidak menentukanvalues. - PopulateDari
-
Jika Anda menggunakan
searchbidang untuk mengisi kolom input Anda dengan menggunakan ekspresi pencarian, tentukan bidang ini dengan nama dimensi yang akan diambil pencarian.Misalnya, jika
searchnilai Anda"search": "{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\"", maka Anda dapat menentukanInstanceIduntukpopulateFrom.Tipe: String
Wajib: Ya jika
inputTypeadaselectatauradiodan Anda tidak menentukanvalues. - terlihat
-
Ditentukan apakah label input dan bidang terlihat di dasbor. Jika Anda menghilangkan ini, default dari
truedigunakan.Menggunakan
falsemenyimpan beberapa 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 dashboard 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 di 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 dari Objek Widget Teks
Widget tipe text dapat memiliki satu atau dua parameter di properties bagian tersebut. markdownBidang diperlukan, dan transparent bidangnya opsional.
Untuk informasi selengkapnya tentang gaya penurunan harga yang didukung dalam widget CloudWatch teks, lihat Menggunakan Penurunan Harga di Konsol.
- penurunan harga
-
Teks yang akan ditampilkan oleh widget. Gunakan parameter ini hanya untuk widget teks.
Tipe: String
Wajib: Ya (saat widget
typetext). - latar belakang
-
Menentukan apakah widget teks memiliki latar belakang yang solid atau transparan. Nilai
transparentmembuat widget transparan. Nilainyasolidadalah default.Tipe: String
Wajib: Tidak
{ "widgets":[ { "type":"text", "x":0, "y":7, "width":3, "height":3, "properties":{ "markdown":"Hello world", "background": "transparent" } } ] }
Properti dari Objek Log Widget
Jenis widget log mewakili hasil kueri Wawasan CloudWatch Log. Untuk informasi selengkapnya, lihat Menganalisis Data Log dengan Wawasan CloudWatch Log.
logWidget dapat menyertakan bidang-bidang berikut di properties bidangnya.
- 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
Wajib: Ya (saat widget
typelog).queryString dimulai dengan nama-nama grup log yang akan ditanyakan. Anda harus pra-pend setiap nama grup log dengan.SOURCEPisahkan beberapa grup log dengan karakter pipa (|).Tambahkan karakter pipa lain setelah daftar grup log, dan kemudian tentukan sintaks kueri. Pisahkan setiap baris dalam sintaks kueri dengan
\n|Misalnya, baris berikut mewakili kueri dari dua grup log,
service_log1danservice_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 query ditampilkan. Tentukan
tableuntuk melihat hasil sebagai tabel. TentukantimeSeriesuntuk menampilkan metrik ini sebagai grafik garis. Tentukanbaruntuk menampilkannya sebagai grafik batang. Tentukanpieuntuk menampilkannya sebagai grafik lingkaran.Jika Anda menghilangkan parameter ini, hasilnya ditampilkan sebagai tabel.
Tipe: String
Wajib: Tidak (saat widget
typelog).
{ "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 tipe metric dapat memiliki bidang berikut di dalamproperties:
- accountId
-
Menentukan ID AWS akun di mana semua metrik dalam widget ini akan 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
accountIdbidang dalam setiap metrik dalam arraymetricsuntuk membuat widget tunggal yang mencakup metrik dari beberapa akun.Tipe: String
Wajib: Tidak
- anotasi
-
Untuk menyertakan alarm atau anotasi di widget, tentukan
annotationsarray. Untuk informasi selengkapnya tentang format, lihatObjek Widget Dasbor: Properti Anotasi. Gunakan parameter ini hanya untuk widget metrik.Tipe: Objek
Diperlukan: Anotasi alarm diperlukan hanya ketika widget
typemetricdan tidakmetricsditentukan. Anotasi horizontal atau vertikal tidak diperlukan. - LiveData
-
Tentukan
trueuntuk 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
legenduntuk menentukan di mana legenda untuk garis pada grafik ditampilkan.legendBidang berisi bidang lain yang disebutposition. Nilai yang mungkin untukpositionadalahright,bottom, danhidden.Misalnya, berikut ini menyebabkan legenda muncul di sebelah kanan dalam grafik.
"legend": { "position": "right" }Tipe: Objek
Wajib: Tidak
- metrik
-
Tentukan
metricslarik untuk menyertakan satu atau beberapa metrik (tanpa alarm), kueri Wawasan Metrik, ekspresi matematika, atau ekspresi penelusuran. Satumetricsarray dapat mencakup 0-500 metrik dan ekspresi. Gunakan parameter ini hanya untuk widget metrik. Untuk informasi lebih lanjut tentang formatmetrics, lihat Metric Widget: Format untuk Setiap Metrik dalam Array.Satu larik metrik dapat menyertakan tidak lebih dari satu kueri Wawasan Metrik.
Satu
expressionbidang tidak dapat menyertakan kueri Wawasan Metrik dan ekspresi matematika, tetapi Anda dapat menggunakan hasil yang dikembalikan dari kueri Wawasan Metrik dari satu ekspresi sebagai masukan dalam ekspresi matematika dalam ekspresi berbeda dalam larik.Jenis: Array array
Wajib: Ya, ketika widget
typeannotationsadalahmetricdan tidak ditentukan. - periode
-
Periode default, dalam hitungan 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 yang Valid: Setiap kelipatan 60, dengan 60 sebagai minimum.
Tipe: Integer
Wajib: Tidak
- region
-
Wilayah metrik.
Tipe: String
Diperlukan: Ya
- sparkline
-
Tentukan
trueuntuk menampilkan fitur sparkline di bawah widget angka. Tentukanfalseuntuk menampilkan widget angka dengan sendirinya. Parameter ini diabaikan jika tampilan tidaksingleValue. Gunakan parameter ini hanya untuk widget metrik.Tipe: Boolean
Wajib: Tidak
- menumpukkan
-
Tentukan
trueuntuk menampilkan grafik sebagai garis bertumpuk, ataufalseuntuk ditampilkan sebagai garis terpisah. Parameter ini diabaikan jikaviewadasingleValue. 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 masing-masing metrik individu dalam array.
metricsGunakan parameter ini hanya untuk widget metrik.Nilai yang Valid:
SampleCountAverageSum| |Minimum|Maximum|p??Type: String yang merupakan CloudWatch statistik yang valid.
Wajib: Tidak
- tabel
-
Sertakan
tablebagian untuk menyertakan perubahan terkait tabel data di widget. Untuk informasi selengkapnya 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,
+0130menunjukkan waktu 1 jam dan 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
timeSeriesuntuk menampilkan metrik ini sebagai garis atau grafik area bertumpuk. TentukansingleValueuntuk menampilkan metrik ini sebagai grafik angka. Tentukangaugeuntuk menampilkan metrik ini sebagai grafik pengukur. Tentukanbaruntuk menampilkan metrik ini sebagai grafik batang. Tentukanpieuntuk menampilkan metrik ini sebagai grafik lingkaran.catatan
Jika Anda menentukan
gauge, Anda harus menetapkan nilai untukmindanmaxdi sisi kiriyAxis.Nilai yang Valid:
timeSeriessingleValuegauge| |bar|pie|tableTipe: 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 menggantikan 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, } } } }
Metric Widget: 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 dari mana 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
metricsarray, 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 CloudWatch metrik. Jika Anda memiliki beberapa entri dalam
metricsarray, 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 Metrics Insights, ekspresi matematika, atau ekspresi penelusuran, jika ini adalah ekspresi, bukan metrik tunggal.
Dalam ekspresi pencarian menggunakan tanda kutip ganda untuk pencocokan persis, setiap tanda kutip ganda harus diloloskan dengan garis miring terbalik.
Untuk informasi selengkapnya tentang sintaks kueri Metrics Insights, lihat komponen dan sintaks kueri Wawasan Metrik.
Untuk informasi selengkapnya tentang ekspresi matematika atau ekspresi penelusuran, lihat Menggunakan Matematika Metrik atau Menggunakan Ekspresi Penelusuran dalam Grafik di Panduan CloudWatch Pengguna Amazon.
Tipe: String
Wajib: Ya, untuk ekspresi
Contoh ekspresi untuk kueri Wawasan Metrik:
[ { "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
metricsarray, untuk masing-masing setelah yang pertama Anda dapat menentukan hanya"."untuk menggunakan nama dimensi yang sama seperti pada dimensi yang sesuai yang ditentukan dalam metrik sebelumnya dalam array. Anda dapat menentukan 0 dimensi 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
- Rendering Properti Objek
-
Menentukan properti rendering yang akan digunakan untuk metrik khusus ini, mengesampingkan nilai-nilai yang ditentukan untuk widget keseluruhan. Untuk informasi selengkapnya 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 theDiskReadBytesmetric 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 EC2CPUUtilizationfor each instance in the Region. [ { "expression": "SEARCH('{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\"', 'Average', 300)", "id": "e1" } ],
Topik
Objek Widget Dasbor: Format Objek Properti Rendering
Setiap metrik dalam metrics array opsional dapat memiliki properti rendering kustom yang mengesampingkan properti rendering default yang ditentukan dalam yAxis parameter objek. widget Bagian ini menjelaskan format untuk properti rendering kustom per metrik tersebut.
- warna
-
Kode warna hex HTML enam digit 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 autogenerated yang membedakannya dari metrik lain di widget.
Tipe: String
Wajib: Tidak
- periode
-
Periode untuk metrik ini, dalam hitungan detik. Periode adalah lamanya waktu yang diwakili oleh satu titik data pada grafik.
Nilai yang Valid: Kelipatan 60, dengan minimal 60.
Tipe: Integer
Wajib: Tidak
- stat
-
Statistik untuk metrik ini, jika ingin berbeda dari statistik yang digunakan untuk metrik lain dalam array. Secara default CloudWatch menggunakan Rata-rata jika Anda tidak menentukan statistik pada array atau pada tingkat metrik.
Nilai yang Valid:
SampleCountAverageSum| |Minimum|Maximum|p??Type: String yang merupakan CloudWatch statistik yang valid.
Wajib: Tidak
- terlihat
-
Setel ini
trueagar metrik muncul di grafik, ataufalsedisembunyikan. Defaultnya adalahtrue.Tipe: Boolean
Wajib: Tidak
- yAxis
-
Dimana pada grafik untuk menampilkan sumbu y untuk metrik ini. Nilai default-nya
left.Nilai Valid:
left|rightTipe: 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 meliputi 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.
Wajib: Hanya jika tidak ada metrik yang terdaftar.
"annotations": { "alarms": [ "arn1" ] }
Anotasi Horisontal
- horisontal
-
Sebuah array anotasi horisontal. Anotasi horizontal memiliki beberapa opsi untuk bayangan pengisian, termasuk bayangan di atas garis anotasi, bayangan di bawah garis anotasi, dan bayangan “pita” yang muncul di antara dua garis anotasi tertaut 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 band memiliki format 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
-
String yang muncul pada grafik di sebelah anotasi.
Tipe: String
Wajib: Tidak
- warna
-
Kode warna hex HTML enam digit yang akan digunakan untuk anotasi. Warna ini digunakan untuk garis anotasi dan bayangan isian.
Tipe: String
Wajib: Tidak
- mengisi
-
Cara menggunakan fill shading dengan anotasi. Nilai yang valid adalah
aboveuntuk bayangan di atas anotasi,belowuntuk bayangan di bawah anotasi, dannonetanpa bayangan. Jikafilldihilangkan, tidak ada naungan.Pengecualian adalah anotasi dengan bayangan pita. Anotasi ini selalu memiliki bayangan antara dua nilai, dan nilai apa pun untuk diabaikan
fill.Tipe: String
Wajib: Tidak
- terlihat
-
Setel ini
trueagar anotasi muncul di grafik, ataufalsedisembunyikan. Defaultnya adalahtrue.Tipe: Boolean
Wajib: Tidak
- yAxis
-
Jika grafik menyertakan beberapa metrik, tentukan apakah angka dalam
Valuemengacu pada metrik yang terkait dengan kiri Y-axis atau kanan Y-axis,. Nilai yang valid adalahrightdanleft.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
-
Sebuah array anotasi vertikal. Untuk setiap anotasi vertikal, Anda dapat memilih untuk memiliki bayangan isian sebelum anotasi, setelahnya, atau di antara dua garis vertikal yang ditautkan 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 berikut:
[ {value,label,color,visible}, {value,label} ]
- nilai
-
Tanggal dan waktu dalam grafik di mana garis anotasi vertikal akan muncul. Pada anotasi shading band, dua nilai untuk Value menentukan tepi awal dan akhir band.
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
-
String yang muncul pada grafik di sebelah anotasi.
Tipe: String
Wajib: Tidak
- warna
-
Kode warna hex HTML enam digit yang akan digunakan untuk anotasi. Warna ini digunakan untuk garis anotasi dan bayangan isian.
Tipe: String
Wajib: Tidak
- mengisi
-
Cara menggunakan fill shading dengan anotasi. Nilai yang valid adalah
beforeuntuk bayangan sebelum anotasi,afteruntuk bayangan setelah anotasi, dannonetanpa bayangan. Jikafilldihilangkan, tidak ada naungan.Pengecualian adalah anotasi dengan bayangan pita. Anotasi ini selalu memiliki bayangan antara dua nilai, dan nilai apa pun untuk diabaikan
fill.Tipe: String
Wajib: Tidak
- terlihat
-
Setel ini
trueagar anotasi muncul di grafik, ataufalsedisembunyikan. Defaultnya adalahtrue.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 untuk Y-axis grafik. Pengaturan termasuk maksimum dan minimum, label untuk sumbu, dan apakah sumbu menunjukkan unit. Atur ini di dalam widget objek untuk memengaruhi semua metrik di widget. Untuk mengganti pengaturan widget untuk metrik tertentu, atur untuk metrik dalam metrics larik.
{ 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
- ShowUnits
-
Menentukan apakah satuan ditampilkan untuk metrik yang terkait dengan sumbu ini. Bawaannya adalah benar.
Tipe: Boolean
Wajib: Tidak
Objek Widget Dasbor: Properti Tabel
Jika Anda menentukan table widget metrik, Anda dapat menyertakan visualisasi yang terkait dengan visibilitas kolom ringkasan, kolom titik data, dan tata letak tabel. Properti ini hanya berpengaruh ketika jenis tampilan widget table dan tidak mengubah jenis tampilan lain jika disertakan. tableProperti ini 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|horizontalTipe: String
Wajib: Tidak
- StickySummary
-
Setel ini
trueuntuk 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-nyafalse.Label widget selalu lengket, tidak peduli pilihan Anda di bidang ini.
Nilai Valid:
true|falseTipe: Boolean
Wajib: Tidak
- menunjukkan TimeSeriesData
-
Setel ini ke
falsejika Anda hanya ingin label dan kolom ringkasan yang akan ditampilkan, sembunyikan kolom data lainnya.Nilai default-nya
true.Nilai Valid:
true|falseTipe: Boolean
Wajib: Tidak
- SummaryColumns
-
Kolom ringkasan adalah properti baru yang diperkenalkan dengan widget tabel. Kolom-kolom ini adalah subset spesifik dari ringkasan tabel Anda saat ini. Misalnya,
Sumringkasan adalah jumlah dari semua titik data yang dirender di baris masing-masing. Kolom ringkasan bukanlah konsep yang sama dengan statistik CloudWatch metrik mana pun.Bawaannya adalah
[“MIN“, "MAX","SUM", "AVG"]Nilai yang valid:
"MIN"|"MAX"|"SUM"|"AVG"Jenis: Array
Wajib: Tidak
Misalnya, JSON berikut membuat tabel yang menampilkan minimum dan maksimum setiap metrik dalam tabel.
"table": { "summaryColumns": ["MIN", "MAX"], "layout": "vertical", "stickySummary": true, "showTimeSeriesData": false, },
Properti Objek Widget Penjelajah Metrik
Widget tipe explorer mewakili widget penjelajah metrik. Untuk informasi selengkapnya, lihat Menggunakan Penjelajah Metrik untuk Memantau Sumber Daya berdasarkan Tag dan Properti Mereka
Anda juga dapat menambahkan widget penjelajah metrik ke dasbor menggunakan. CloudFormation Untuk informasi selengkapnya, lihat AWS::CloudWatch: :Dashboard.
Jenis widget ini dapat memiliki bidang berikut dalam widgetproperties:
- AgregateBy
-
Objek yang menentukan cara menggabungkan metrik dari berbagai sumber daya. Nilai yang valid untuk
keybidang dalam objek ini adalah kunci tag dan properti sumber daya. Objek ini berisi bidang-bidang berikut.key — Tag atau kunci properti sumber daya yang akan digunakan untuk menggabungkan metrik.
func — Fungsi agregasi yang digunakan. Nilai yang valid adalah
AVGMIN|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, maka sumber daya yang cocok dengan salah satu nilai untuk kunci tersebut akan ditampilkan.
key — Tag atau properti sumber daya untuk memfilter.
Untuk
key, semua kunci tag valid untuk ditentukan. Properti sumber daya EC2 dan Lambda berikut juga berlaku untuk:keyEC2:
Architecture,Hypervisor,CoreCount,ImageId,InstanceId,InstanceLifecycle,InstanceType,InstanceFamily,InstanceSize,Affinity,AvailabilityZone,Tenancy,Platform,RootDeviceTypeSecurityGroups,State,SubnetId,VirtualizationType, andVpcIdLambda:
FunctionName,Runtime,Language,MemorySize,Version,SecurityGroupIds,SubnetIds,SubnetIdCount,VpcId, danTimeout
value — (Opsional) Nilai tag atau properti sumber daya untuk difilter. Jika ini dihilangkan, metrik yang sesuai dengan semua nilai tag atau properti sumber daya akan ditampilkan.
Tipe: Objek
Wajib: Ya
- metrik
-
Tentukan
metricsarray untuk menyertakan satu atau beberapa metrik. Satumetricsarray dapat mencakup 1-100 metrik. Setiap objek dalam array harus berisi bidang-bidang berikut.MetricName — Nama metrik.
ResourceType — Jenis sumber daya yang menerbitkan metrik, dijelaskan dalam format yang digunakan oleh. AWS CloudFormation Misalnya,
AWS::EC2::InstanceatauAWS::Lambda::Function.Anda harus menggunakan nilai yang sama
resourceTypeuntuk semua metrik di widget.Untuk daftar lengkap nilai yang valid, lihatNilai ResourceType yang Valid untuk Objek Widget Penjelajah Metrik.
-
stat — Statistik untuk metrik ini, jika ingin berbeda dari statistik yang digunakan untuk metrik lain dalam array. Secara default CloudWatch menggunakan Rata-rata jika Anda tidak menentukan statistik pada array atau pada tingkat metrik.
Nilai yang Valid:
SampleCountAverageSum| |Minimum|Maximum|p??
Tipe: Array objek
Wajib: Ya
- periode
-
Periode default, dalam hitungan 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 yang Valid: Setiap kelipatan 60, dengan 60 sebagai minimum.
Tipe: Integer
Wajib: Tidak
- SplitBy
-
Menentukan cara membagi metrik dari beberapa sumber ke garis 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 dashboard. Hal ini dapat berisi bidang-bidang berikut.
legenda —
Menentukan di mana legenda untuk setiap grafik ditampilkan.
legendBidang berisi bidang lain yang disebutposition. Nilai yang mungkin untukpositionadalahright,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
trueuntuk menampilkan grafik sebagai bagan area bertumpuk, ataufalseuntuk ditampilkan sebagai garis terpisah.melihat -
Menentukan bagaimana setiap grafik ditampilkan. Tentukan
timeSeriesuntuk menampilkan metrik ini sebagai grafik garis. Tentukanbaruntuk menampilkannya sebagai grafik batang. Tentukanpieuntuk menampilkannya sebagai grafik lingkaran. Nilai default-nyatimeSeries.widget PerRow -
Menentukan berapa banyak grafik yang ditampilkan di setiap baris widget metrik explorer.
Tipe: Objek
Wajib: Tidak
Contoh
Contoh berikut menampilkan tiga metrik untuk setiap instans EC2 yang menjalankan akun, dengan grafik di widget dibagi berdasarkan zona ketersediaan. Dalam setiap grafik, metrik dikumpulkan 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 Penjelajah Metrik
Nilai yang valid untuk resourceType bidang di metrics bagian widget penjelajah metrik adalah sebagai berikut:
AWS::AmazonMQ::BrokerAWS::ApiGateway::RestApiAWS::AppStream::FleetAWS::AppSync::GraphQLApiAWS::CloudFront::DistributionAWS::CodeBuild::ProjectAWS::Datasync::AgentAWS::Datasync::TaskAWS::DMS::ReplicationInstanceAWS::DynamoDB::TableAWS::EC2::CapacityReservationAWS::EC2::InstanceAWS::EC2::NatGatewayAWS::EC2::TransitGatewayAWS::EC2::VolumeAWS::EC2::VPNConnectionAWS::ECS::ClusterAWS::EFS::FileSystemAWS::ElastiCache::CacheClusterAWS::ElastiCache::ReplicationGroupAWS::ElasticBeanstalk::EnvironmentAWS::ElasticLoadBalancing::LoadBalancerAWS::ElasticLoadBalancingV2::LoadBalancer/ApplicationELBAWS::ElasticLoadBalancingV2::LoadBalancer/GatewayELBAWS::ElasticLoadBalancingV2::LoadBalancer/NetworkELBAWS::ElasticLoadBalancingV2::TargetGroupAWS::EMR::ClusterAWS::Events::RuleAWS::FSx::FileSystemAWS::GameLift::FleetAWS::GlobalAccelerator::AcceleratorAWS::IoT::TopicRuleAWS::IoT1Click::DeviceAWS::IoTAnalytics::ChannelAWS::IoTAnalytics::DatasetAWS::IoTAnalytics::DatastoreAWS::IoTAnalytics::PipelineAWS::Kafka::ClusterAWS::Kinesis::StreamAWS::KinesisAnalytics::ApplicationAWS::KinesisFirehose::DeliveryStreamAWS::KinesisVideo::StreamAWS::KMS::KeyAWS::Lambda::FunctionAWS::Logs::LogGroupAWS::MediaPackage::ChannelAWS::MediaStore::ContainerAWS::OpsWorks::InstanceAWS::OpsWorks::LayerAWS::OpsWorks::StackAWS::QLDB::LedgerAWS::RDS::DBInstanceAWS::Redshift::ClusterAWS::RoboMaker::SimulationJobAWS::Route53::HealthCheckAWS::Route53Resolver::ResolverEndpointAWS::S3::BucketAWS::SageMaker::EndpointAWS::ServiceCatalog::CloudFormationProductAWS::SES::ConfigurationSetAWS::SNS::TopicAWS::SQS::QueueAWS::StepFunctions::ActivityAWS::StepFunctions::StateMachineAWS::StorageGateway::GatewayAWS::Synthetics::CanaryAWS::Transfer::ServerAWS::WorkMail::OrganizationAWS::WorkSpaces::Workspace
Properti Objek Widget Status Alarm
Widget tipe alarm dapat memiliki bidang berikut di dalamnyaproperties.
- alarm
-
Array ARN alarm untuk disertakan dalam widget. Array dapat memiliki 1-100 ARN.
Tipe: Array string
Wajib: Ya (saat widget
typealarm). - SortBy
-
Menentukan cara mengurutkan alarm di widget.
Pilih
defaultuntuk mengurutkannya dalam urutan abjad berdasarkan nama alarm.Pilih
stateUpdatedTimestampuntuk 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 saat terakhir berubah status, dengan perubahan status yang lebih baru terdaftar terlebih dahulu.Pilih
timestampuntuk mengurutkannya pada saat alarm terakhir berubah status, tidak peduli status alarm saat ini. Alarm yang mengubah keadaan baru-baru ini terdaftar terlebih dahulu.Jika Anda menghilangkan bidang ini, alarm diurutkan dalam urutan abjad.
Tipe: String
Nilai Valid: default | state UpdatedTimestamp | stempel waktu
Wajib: Tidak
- negara
-
Gunakan bidang ini untuk memfilter daftar alarm yang ditampilkan di widget hanya untuk alarm yang saat ini berada di status tertentu. Anda dapat menentukan satu atau beberapa status alarm dalam nilai untuk bidang ini. Alarm menyatakan bahwa Anda dapat menentukan adalah
ALARM,INSUFFICIENT_DATA, danOK.Jika Anda menghilangkan bidang ini atau menentukan array kosong, semua alarm yang ditentukan akan ditampilkan.
alarmsTipe: 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 oleh nama, tidak peduli keadaan mereka 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" } }
Contoh widget berikut menentukan empat alarm yang sama, tetapi widget hanya menampilkan alarm yang saat ini dalam keadaan 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 Chart Widget
Widget tipe chart adalah widget bagan multi-data-sumber 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 vended yang telah diperkaya untuk OTel. AWS Untuk informasi selengkapnya tentang kueri dengan PromQL, lihat. Metrik kueri dengan PromQL
Widget tipe chart dapat memiliki bidang berikut di dalamproperties:
- lihat
-
Visualisasi yang digunakan untuk widget.
Nilai yang Valid:
linebarpie|number|solidgauge|column|legend|histogram|heatmap|scatterTipe: String
Diperlukan: Ya
- title
-
Judul yang akan ditampilkan untuk widget.
Tipe: String
Wajib: Tidak
- deskripsi
-
Deskripsi opsional untuk widget.
Tipe: String
Wajib: Tidak
- region
-
AWS Wilayah yang akan digunakan untuk semua kueri di widget. Setiap kueri dalam
data.queriesarray dapat mengganti ini denganregionbidangnya sendiri.Tipe: String
Wajib: Tidak
- data
-
Kueri untuk plot di widget.
dataObjek berisiqueriesarray, di mana setiap entri mendefinisikan satu query. Untuk informasi selengkapnya tentang format, lihatChart Widget: Format untuk Setiap Query dalam Array.Tipe: Objek
Wajib: Ya
- PlotOptions
-
Opsi visualisasi untuk widget, seperti penempatan legenda, konfigurasi sumbu, dan pengaturan gaya khusus tampilan (misalnya, lebar garis atau bilah bertumpuk). Bidang persis yang tersedia tergantung pada nilai
view. Jika Anda menghilangkanplotOptions, pengaturan default untuk tampilan digunakan. Untuk daftar lengkap bidang, lihatWidget Bagan: Referensi PlotOptions.Tipe: Objek
Wajib: Tidak
Chart Widget: Format untuk Setiap Query dalam Array
Setiap entri dalam data.queries array mendefinisikan satu query. Untuk membuat widget bagan yang menanyakan CloudWatch metrik, atur type kecloudwatch-metrics, atur language ke salah satu PromQL atauSQL, dan berikan ekspresi kueri sebagai string di query bidang. Widget bagan tunggal dapat mencampur kueri yang ditulis dalam berbagai bahasa.
- id
-
Pengidentifikasi untuk kueri ini. ID harus unik di dalam widget.
Tipe: String
Diperlukan: Ya
- jenis
-
Jenis query. Untuk PromQL, gunakan.
cloudwatch-metricsNilai Valid:
cloudwatch-metricsTipe: String
Diperlukan: Ya
- language
-
Bahasa query untuk query ini. Tentukan
PromQLuntuk menulis kueri dalam Bahasa Kueri Prometheus,SQLatau untuk menulis kueri di Metrics Insights SQL. CloudWatchNilai Valid:
PromQL|SQLTipe: String
Diperlukan: Ya
- kueri
-
Ekspresi query untuk mengevaluasi, sebagai string. Sintaks tergantung pada
languagebidang.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 AWS vended, lihat. Pertanyaan terjual AWS metrik dengan PromQLUntuk SQL, berikan kueri SQL Wawasan CloudWatch Metrik. Misalnya,
SELECT AVG(CPUUtilization) FROM SCHEMA("AWS/EC2", InstanceId) GROUP BY InstanceId. Untuk informasi tentang sintaks kueri Wawasan Metrik, lihat komponen dan sintaks kueri Wawasan Metrik.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
-
AWS Wilayah untuk mengevaluasi kueri ini di. Jika dihilangkan, widget
regiondigunakan.Tipe: String
Wajib: Tidak
- accountId
-
AWS Akun untuk mengevaluasi kueri ini di. 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
falseuntuk menyembunyikan seri kueri ini dari bagan sambil tetap menyimpan kueri dalam definisi widget. Defaultnya adalahtrue.Tipe: Boolean
Wajib: Tidak
Widget Bagan: Referensi PlotOptions
plotOptionsObjek mengontrol bagaimana bagan 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 masing-masing view mendukung.
melihat |
gaya sub-objek |
yAxis/xAxis |
Dukungan anotasi |
|---|---|---|---|
|
LineStyle |
Ya |
Ya (vertikal dan horizontal) |
|
BarStyle |
Ya |
Ya (vertikal dan horizontal) |
|
BarStyle |
Ya |
Tidak |
|
PieStyle |
Tidak |
Tidak |
|
NumberStyle |
Tidak |
Tidak |
|
GaugeStyle |
Tidak |
Ya (horisontal) |
|
ScatterStyle |
Ya |
Ya (vertikal dan horizontal) |
|
BarStyle + HistogramStyle |
Ya |
Tidak |
|
HeatmapStyle |
Ya |
Tidak |
Bidang PlotOptions umum
Bidang berikut berlaku plotOptions untuk setiap bidangview.
- legenda
-
Mengkonfigurasi legenda. Objek berisi kolom-kolom berikut:
posisi- Dimana legenda muncul di widget. Nilai yang valid adalah
bottomdanright.tunjukkan— Boolean. Setel
falseuntuk menyembunyikan legenda.
Tipe: Objek
Wajib: Tidak
View-specific bidang gaya
Bentuk style objek tergantung pada nilaiview.
- LineOptions
-
Digunakan kapan
viewline. Mengkonfigurasi rendering baris. Objek berisi kolom-kolom berikut:lebar- Jumlah. Lebar garis dalam piksel.
pola— Pola garis stroke. Nilai yang valid adalah
solid,dashed, dandotted.spline— Boolean. Jika
true, gambar kurva yang dihaluskan melalui titik data.diisi— Boolean. Jika
true, isi area di bawah garis.ditumpuk— Boolean. Jika
true, tumpuk area yang terisi di seluruh seri. Gunakan denganfilled: trueuntuk bagan area bertumpuk.warna- Warna hex HTML enam digit.
Tipe: Objek
Wajib: Tidak
- BarOptions
-
Digunakan kapan
viewbar,column, atauhistogram. Mengkonfigurasi rendering bar. Objek berisi kolom-kolom berikut:ditumpuk— Boolean. Jika
true, bar dari seri yang berbeda ditumpuk.orientasi- Arah batang. Nilai yang valid adalah
verticaldanhorizontal.
Tipe: Objek
Wajib: Tidak
- PieOptions
-
Digunakan kapan
viewpie. Objek berisi kolom-kolom berikut:InnerSize- String. Persentase seperti
"50%". Setel ke"0%"pai padat, atau nilai bukan nol untuk bagan donat.
Tipe: Objek
Wajib: Tidak
- NumberOptions
-
Digunakan kapan
viewnumber. Objek berisi kolom-kolom berikut:sparkline— Boolean. Jika
true, menampilkan sparkline di bawah angka.memotong— Boolean. Jika
true, memotong angka besar (misalnya, menampilkan1.2Kbukan).1234
Tipe: Objek
Wajib: Tidak
- GaugeOptions
-
Digunakan kapan
viewsolidgauge. Objek berisi kolom-kolom berikut:min— Jumlah. Nilai minimum pengukur.
max- Jumlah. Nilai maksimum pengukur.
Tipe: Objek
Wajib: Tidak
- ColorOptions
-
Digunakan kapan
viewheatmap. 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 pada titik tengah gradien kustom.
MaxColor- Warna hex HTML enam digit yang digunakan di ujung atas gradien kustom.
Tipe: Objek
Wajib: Tidak
- HistogramOptions
-
Digunakan kapan
viewhistogram, selainbarOptions. Objek berisi kolom-kolom berikut:BucketCount- Nomor. Jumlah ember untuk membagi data menjadi.
BucketSize- Nomor, atau string
"auto"untuk ukuran ember secara otomatis.CombineSeries- Boolean. Menggabungkan semua seri menjadi satu histogram.
Tipe: Objek
Wajib: Tidak
- AgregationOptions
-
Digunakan kapan
viewhistogram. 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 bagan. Objek berisi kolom-kolom berikut:
posisi- Dimana label muncul relatif terhadap titik datanya. Nilai yang valid adalah
inside,outside,top,bottom,left, danright.tunjukkan— Boolean. Setel
trueuntuk 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
trueuntuk menggambar spidol.SymbolType- String. Bentuk penanda. Sebagai contoh,
circle,square, ataudiamond.SymbolSize- Nomor. Ukuran penanda dalam piksel.
BorderWidth- Nomor. Lebar batas penanda dalam piksel.
BorderColor- Warna hex HTML enam digit untuk perbatasan penanda.
FillColor- Warna hex HTML enam digit untuk mengisi 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 masukplotOptions.
- yAxis
-
Sebuah array dari satu atau dua objek sumbu. Entri pertama mengkonfigurasi sumbu kiri, dan entri kedua (jika ada) mengkonfigurasi sumbu kanan. Setiap objek sumbu berisi bidang-bidang berikut:
min— Jumlah. Batas bawah sumbu.
max- Jumlah. Batas atas sumbu.
jenis— Skala sumbu. Nilai yang valid adalah
linear,logarithmic,datetime, dancategory.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— Jumlah. Batas bawah sumbu.
max- Jumlah. Batas atas sumbu.
jenis— Skala sumbu. Nilai yang valid adalah
linear,logarithmic,datetime, dancategory.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. annotationsObjek dapat berisi array berikut:
- vertikal
-
Anotasi pada sumbu waktu. Setiap entri adalah objek anotasi, atau array dari dua objek anotasi untuk menentukan pita (wilayah berbayang antara dua nilai). Setiap objek anotasi berisi bidang-bidang berikut:
type- Jenis anotasi. Gunakan
static.label— String. Teks ditampilkan di sebelah anotasi.
nilai- Nomor, string ISO-8601 stempel waktu, atau kategori. Lokasi pada sumbu waktu tempat anotasi muncul.
warna- Warna hex HTML enam digit yang digunakan untuk baris anotasi dan bayangan isian apa pun.
fill— Cara menggunakan fill shading. Nilai yang valid adalah
before(bayangan sebelum anotasi),after(bayangan setelah anotasi), danbetween(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 mendefinisikan sebuah band. Setiap objek anotasi berisi bidang-bidang berikut:
type- Jenis anotasi. Gunakan
static.label— String. Teks ditampilkan di sebelah anotasi.
nilai— Angka. Nilai pada sumbu nilai tempat anotasi muncul.
warna- Warna hex HTML enam digit yang digunakan untuk baris anotasi dan bayangan isian apa pun.
fill— Cara menggunakan fill shading. Nilai yang valid adalah
above(bayangan di atas anotasi),below(bayangan di bawah anotasi), danbetween(digunakan untuk anotasi pita untuk menaungi antara dua nilai).
Jenis: Array
Wajib: Tidak
Contoh: grafik garis PromQL
Contoh berikut membuat bagan garis yang memplot kueri promQL terhadap AWS metrik yang dijual di. 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 } } } }