Membuat dan mengelola dasbor menurut API

Konsol

Untuk mengetahui informasi tentang cara menggunakan konsol Google Cloud untuk membuat filter dan variabel yang disematkan, lihat dokumen berikut:

• Membuat dan menyematkan filter
• Membuat variabel

API

Untuk menentukan filter dan variabel yang disematkan, gunakan struktur data dashboardFilters.

• Untuk membuat variabel, tetapkan nilai kolom templateVariable ke nama variabel. Hapus kolom ini atau tetapkan nilai ke string kosong jika Anda ingin membuat filter yang disematkan.
• Untuk membuat filter yang disematkan atau variabel berbasis label, Anda harus menentukan kolom labelKey. Hapus kolom ini jika Anda menginginkan variabel khusus nilai.

• Tetapkan nilai default untuk filter atau variabel. Konfigurasi kolom ini menentukan apakah pengguna dapat memilih tepat satu opsi dari menu nilai, atau apakah mereka dapat memilih beberapa nilai.

  • Untuk menetapkan satu nilai default dan membatasi pengguna agar memilih tepat satu opsi di menu nilai, tetapkan kolom valueType sebagai STRING dan tetapkan juga kolom stringValue:

  "valueType": "STRING",
  "stringValue": "my-default-value",
  

  • Untuk menetapkan setidaknya satu nilai default dan mengizinkan pengguna memilih beberapa opsi di menu nilai, tetapkan kolom valueType sebagai STRING_ARRAY dan tetapkan juga kolom stringArrayValue. Dalam contoh berikut, ada tiga nilai default.

  "valueType": "STRING_ARRAY",
  "stringArrayValue": {
    "values": [ "a", "b", "c" ]
  },
  

• Opsional: Untuk menentukan daftar semua nilai yang mungkin untuk variabel hanya nilai, tetapkan kolom stringArray atau kolom timeSeriesQuery. Jika Anda menentukan kueri, kueri tersebut harus berupa kueri analisis.

Misalnya, pertimbangkan objek dashboardFilters berikut:

{
  "dashboardFilters": [
      {
        "labelKey": "zone"
        "stringValue": "us-central1-c",
        "valueType": "STRING",
        "filterType": "RESOURCE_LABEL"
      },
      {
        "labelKey": "instance_id",
        "stringValue": "3133577226154888113",
        "valueType": "STRING",
        "filterType": "RESOURCE_LABEL",
        "templateVariable": "my_label_based_variable"
      },
      {
        "filterType": "VALUE_ONLY",
        "templateVariable": "my_value_only_variable",
        timeSeriesQuery: {
          opsAnalyticsQuery: {
            sql: "
              SELECT log_name
              FROM `MY_TABLE`
              GROUP BY log_name
            ",
          }
        }
      }
    ],
  "displayName": "Illustrate Variables",
  ...
}

JSON sebelumnya menentukan satu filter yang disematkan dan dua variabel:

• Filter yang disematkan memiliki kunci label zone, yang ditampilkan di toolbar. Kolom valueType dan stringValue menentukan nilai default tunggal. Untuk mengetahui informasi selengkapnya, lihat halaman referensi API untuk struktur data dashboardFilters.

• Variabel berbasis label memiliki nama my_label_based_variable, dan kunci labelnya adalah instance_id. Nilai default untuk variabel ini ditetapkan ke ID instance tertentu. Anda juga dapat mengonfigurasi nilai default menggunakan array. Di toolbar, filter ditampilkan dengan nama my_label_based_variable.

• Variabel khusus nilai diberi nama my_value_only_variable. Entri ini tidak menentukan nilai default, sehingga operator wildcard, (*), diterapkan secara otomatis. Selain itu, variabel ini menggunakan kueri SQL untuk membuat daftar kemungkinan nilai untuk variabel.

Perhatikan bahwa objek dashboardFilters tidak mencantumkan widget tempat variabel diterapkan. Sebagai gantinya, Anda memperbarui kueri widget agar bergantung pada variabel.

Konsol

Misalnya, kueri berikut menggunakan ekspresi reguler untuk membandingkan nilai kolom jsonPayload.message dengan nilai string yang menyertakan nilai variabel berbasis label:

jsonPayload.message=~"Connected to instance: ${my_label_based_variable.value}"

Sebagai contoh lain, pertimbangkan variabel khusus nilai, value_only_severity_variable, dan asumsikan bahwa dalam menu nilai, tiga nilai dipilih: ERROR, INFO, dan NOTICE. Selanjutnya, Anda menambahkan kode berikut ke widget panel log di panel kueri:

severity =~ "${value_only_severity_variable}"

Berikut adalah ilustrasi formulir yang dirender:

severity =~ "^(ERROR|INFO|NOTICE)$"

API

Misalnya, JSON berikut menggambarkan cara memperbarui kueri widget panel log dengan variabel berbasis label:

"logsPanel": {
  "filter": "${my_label_based_variable}",
  "resourceNames": [
    "projects/1234512345"
  ]
},

Misalnya, kueri berikut menggunakan ekspresi reguler untuk membandingkan nilai kolom jsonPayload.message dengan nilai string yang menyertakan nilai variabel berbasis label:

"logsPanel": {
  "filter": "resource.type=\"gce_instance\"\n
             resource.labels.project_id=~\"${my_label_based_variable.value}\"\n",
  "resourceNames": [
    "projects/012345"
  ]
}

Sebagai contoh lain, pertimbangkan variabel khusus nilai, value_only_severity_variable, dan asumsikan bahwa tiga nilai dipilih dalam menu: ERROR, INFO, dan NOTICE. Selanjutnya, Anda menambahkan kode berikut ke widget panel log di panel kueri:

"logsPanel": {
  "filter": "severity =~ \"${value_only_severity_variable}\"\n",
  ...
}

Berikut ini mengilustrasikan kueri yang dieksekusi oleh widget panel log:

severity =~ "^(ERROR|INFO|NOTICE)$"

Konsol

Misalnya, kueri berikut mengandalkan variabel berbasis label, my_label_based_variable, yang diselesaikan menjadi ekspresi filter:

compute_googleapis_com:instance_cpu_utilization{
    monitored_resource="gce_instance", ${my_label_based_variable} }

Anda juga dapat mengubah kueri untuk menyelesaikan hanya nilai variabel. Contoh berikut menggunakan ekspresi reguler untuk membandingkan nilai kueri berbasis label dengan instance_id:

compute_googleapis_com:instance_cpu_utilization{
    instance_id=~"${my_label_based_variable.value}"
}

Jika Anda memiliki variabel khusus nilai, hapus klausa .value. Misalnya, untuk memfilter menurut zona menggunakan variabel khusus nilai, kueri akan menyertakan sesuatu seperti berikut:

zone=~"${my_value_only_variable}"

API

Misalnya, JSON berikut menggambarkan kueri yang mengandalkan variabel berbasis label, my_label_based_variable, yang diselesaikan menjadi ekspresi filter:

"timeSeriesQuery": {
  "prometheusQuery": "avg_over_time(
    compute_googleapis_com:instance_cpu_utilization{
      monitored_resource=\"gce_instance\",
      ${my_label_based_variable}
      }[${__interval}])",
  "unitOverride": "",
  "outputFullDuration": false
},

Anda juga dapat mengubah kueri untuk menyelesaikan hanya nilai variabel. Contoh berikut menggunakan ekspresi reguler untuk membandingkan nilai kueri berbasis label dengan instance_id:

"timeSeriesQuery": {
  "prometheusQuery": "avg_over_time(
    compute_googleapis_com:instance_cpu_utilization{
    monitored_resource=\"gce_instance\",
    instance_id=~\"${my_label_based_variable.value}\"
    }[${__interval}])",
  "unitOverride": "",
  "outputFullDuration": false
},

Jika Anda memiliki variabel khusus nilai, hapus klausa .value. Misalnya, untuk memfilter menurut zona menggunakan variabel khusus nilai, kueri akan menyertakan sesuatu seperti berikut:

zone=~\"${my_value_only_variable}\"

Konsol

Karena SQL tidak menafsirkan operator karakter pengganti sebagai "nilai apa pun", sebaiknya Anda selalu menggunakan pernyataan IF saat menggunakan variabel dalam kueri SQL. Contoh berikut menggambarkan penggunaan untuk variabel khusus nilai yang jenis datanya adalah string:

WHERE IF(@my_value_only_variable = "*", TRUE, log_name = @my_value_only_variable)

Jika opsi menu untuk variabel memungkinkan pengguna memilih beberapa nilai, Anda harus melakukan transmisi nilai variabel ke jenis data GoogleSQL menggunakan fungsi CAST. Kueri berikut menggambarkan sintaksis ini:

IF(ARRAY_LENGTH(CAST(@my_value_only_variable)) = 0, TRUE,
   severity IN UNNEST(@my_value_only_variable))

Pernyataan IF yang ditampilkan dalam contoh sebelumnya direkomendasikan karena SQL tidak menafsirkan operator wildcard berarti "nilai apa pun". Oleh karena itu, jika Anda menghilangkan pernyataan IF dan jika Anda memilih operator karakter pengganti, maka hasil kueri adalah tabel kosong. Pada contoh kedua, fungsi UNNEST mengonversi larik menjadi tabel.

Untuk menambahkan klausa WHERE yang diformat dengan benar, lakukan langkah-langkah berikut:

1. Edit widget.
2. Di toolbar, pilih Sisipkan filter variabel, lalu pilih variabel yang ingin Anda perbarui klausa WHERE-nya.
3. Dalam dialog yang terbuka, tinjau kode yang dihasilkan, lalu klik Salin dan tutup.

4. Tempel kode yang disalin ke panel Kueri dan lakukan pengeditan yang diperlukan.

   Misalnya, Anda membuat variabel bernama LogName yang menghasilkan daftar nama log dan menampilkan hasilnya dalam tabel dengan satu kolom bernama log_name. Selanjutnya, Anda membuat diagram, memilih Sisipkan filter variabel, lalu memilih variabel LogName. Kode berikut akan dibuat:

   WHERE IF(@LogName = '*', TRUE, LogName = @LogName)
   

   Dalam contoh ini, Anda perlu mengedit kode yang dihasilkan dan mengganti LogName = dengan log_name =, sehingga penggabungan tabel dapat terjadi:

   WHERE IF(@LogName = '*', TRUE, log_name = @LogName)
   

5. Klik Jalankan, lalu Terapkan.

6. Untuk menyimpan dasbor yang telah diubah, di toolbar, klik Simpan.

API

Karena SQL tidak menafsirkan operator karakter pengganti sebagai "nilai apa pun", sebaiknya Anda selalu menggunakan pernyataan IF saat menggunakan variabel dalam kueri SQL. Contoh berikut menggambarkan penggunaan untuk variabel khusus nilai yang jenis datanya adalah string:

WHERE IF(@my_value_only_variable = "*", TRUE, log_name = @my_value_only_variable)

Misalnya, berikut menunjukkan representasi JSON parsial dari diagram yang menampilkan hasil kueri SQL. Untuk mendukung pemfilteran hasil menurut nama log, klausa WHERE ditambahkan yang mereferensikan variabel bernama LogName:

"plotType": "STACKED_BAR",
"targetAxis": "Y1",
"timeSeriesQuery": {
  "opsAnalyticsQuery": {
    "queryExecutionRules": {},
    "queryHandle": "",
    "sql": "SELECT\n timestamp, severity, resource.type, log_name, text_payload, proto_payload, json_payload\n
            FROM\n `my-project.global._Default._Default`\n
            WHERE \n IF (@LogName = \"*\", TRUE, log_name=@LogName)\nLIMIT 10000"
  }
}

Variabel LogName juga mengeluarkan kueri untuk menentukan daftar kemungkinan nama log:

"dashboardFilters": [
  {
    "filterType": "VALUE_ONLY",
    "templateVariable": "LogName",
    "valueType": "STRING",
    "timeSeriesQuery": {
      "opsAnalyticsQuery": {
        "savedQueryId": "",
        "sql": "SELECT log_name FROM `my-project.global._Default._Default` GROUP BY log_name LIMIT 1000",
        "queryHandle": ""
      },
      "unitOverride": "",
      "outputFullDuration": false
    }
  }
],

Jika opsi menu untuk variabel memungkinkan pengguna memilih beberapa nilai, Anda harus melakukan transmisi nilai variabel ke jenis data GoogleSQL menggunakan fungsi CAST. Kueri berikut menggambarkan sintaksis ini:

IF(ARRAY_LENGTH(CAST(@my_value_only_variable)) = 0, TRUE,
   severity IN UNNEST(@my_value_only_variable))

Pernyataan IF yang ditampilkan dalam contoh sebelumnya direkomendasikan karena SQL tidak menafsirkan operator wildcard berarti "nilai apa pun". Oleh karena itu, jika Anda menghilangkan pernyataan IF dan jika Anda memilih operator karakter pengganti, maka hasil kueri adalah tabel kosong. Pada contoh kedua, fungsi UNNEST mengonversi larik menjadi tabel.

Konsol

Misalnya, kueri berikut mengandalkan variabel berbasis label, my_label_based_variable, yang diubah menjadi ekspresi filter:

fetch gce_instance
| metric 'compute.googleapis.com/instance/cpu/utilization'
| every 1m
| ${my_label_based_variable}

Anda juga dapat mengubah kueri untuk menyelesaikan hanya nilai variabel. Contoh berikut menggunakan ekspresi reguler untuk membandingkan nilai kueri berbasis label dengan instance_id:

fetch gce_instance
| metric 'compute.googleapis.com/instance/cpu/utilization'
| filter resource.instance_id=~'${my_label_based_variable.value}'
| group_by 1m, [value_utilization_mean: mean(value.utilization)]
| every 1m

Jika Anda memiliki variabel khusus nilai, hapus klausa .value. Misalnya, untuk memfilter menurut zona menggunakan variabel khusus nilai, kueri akan menyertakan sesuatu seperti berikut:

resource.zone=~'${my_value_only_variable}'

API

Misalnya, JSON berikut menggambarkan kueri yang mengandalkan variabel berbasis label, my_label_based_variable, yang diubah menjadi ekspresi filter:

"timeSeriesQuery": {
  "timeSeriesQueryLanguage": "fetch gce_instance\n
    | metric 'compute.googleapis.com/instance/cpu/utilization'\n
    | group_by 1m, [value_utilization_mean: mean(value.utilization)]\n
    | every 1m\n
    | ${my_label_based_variable}",
  "unitOverride": "",
  "outputFullDuration": false
},

Anda juga dapat mengubah kueri untuk menyelesaikan hanya nilai variabel. Contoh berikut menggunakan ekspresi reguler untuk membandingkan nilai kueri berbasis label dengan instance_id:

"timeSeriesQuery": {
  "timeSeriesQueryLanguage": "fetch gce_instance\n
    | metric 'compute.googleapis.com/instance/cpu/utilization'\n
    | filter resource.instance_id=~'${my_label_based_variable.value}'\n
    | group_by 1m, [value_utilization_mean: mean(value.utilization)]\n
    | every 1m\n",
  "unitOverride": "",
  "outputFullDuration": false
},

Jika Anda memiliki variabel khusus nilai, hapus klausa .value. Misalnya, untuk memfilter menurut zona menggunakan variabel khusus nilai, kueri akan menyertakan sesuatu seperti berikut:

resource.zone=~'${my_value_only_variable}'

Konsol

Jika Anda menggunakan konsol Google Cloud untuk membuat diagram, dan jika Anda menggunakan antarmuka berbasis menu, Anda dapat memperbarui kueri diagram dengan menggunakan kolom Terapkan ke diagram variabel atau dengan mengedit widget dan memilih variabel berbasis label dari menu Filter. Menu Filter mencantumkan semua variabel berbasis label dan semua kunci label.

Untuk memperbarui kueri diagram agar bergantung pada variabel berbasis nilai, lakukan hal berikut:

1. Edit diagram.
2. Di panel kueri, klik Tambahkan filter, lalu pilih kunci label. Misalnya, Anda dapat memilih zona.
3. Di menu Nilai, pilih variabel khusus nilai Anda.
4. Klik Terapkan.
5. Untuk menyimpan dasbor yang telah diubah, di toolbar, klik Simpan.

Misalnya, JSON berikut menggambarkan kueri yang mengandalkan variabel berbasis label, my_label_based_variable, yang diubah menjadi ekspresi filter:

metric.type="compute.googleapis.com/instance/cpu/utilization"
resource.type="gce_instance" ${my_label_based_variable}"

Widget yang menggunakan kueri dalam bentuk filter Monitoring tidak dapat memfilter deret waktu menurut nilai dalam variabel berbasis label; namun, Anda dapat memfilter menurut variabel hanya nilai. Misalnya, kueri berikut menampilkan nilai kolom Filters dari kueri yang memfilter menurut zone, berdasarkan nilai variabel hanya nilai:

metric.type="compute.googleapis.com/instance/cpu/utilization"
resource.type="gce_instance"
resource.label."zone"=monitoring.regex.full_match(${my_value_only_variable})

API

Misalnya, JSON berikut menggambarkan kueri yang mengandalkan variabel berbasis label, my_label_based_variable, yang diubah menjadi ekspresi filter:

"timeSeriesQuery": {
  "timeSeriesFilter": {
    "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\"
               resource.type=\"gce_instance\"
               ${my_label_based_variable} ",
    "aggregation": {
      "alignmentPeriod": "60s",
      "perSeriesAligner": "ALIGN_MEAN",
      "groupByFields": []
    }
  },
  "unitOverride": "",
  "outputFullDuration": false
},

Widget yang menggunakan kueri dalam bentuk filter Monitoring tidak dapat memfilter deret waktu menurut nilai dalam variabel berbasis label; namun, Anda dapat memfilter menurut variabel hanya nilai. Misalnya, kueri berikut menampilkan kolom "filter" dari kueri yang memfilter menurut zone, berdasarkan nilai variabel hanya nilai:

"filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\"
          resource.type=\"gce_instance\"
          resource.labels.\"zone\"=monitoring.regex.full_match(${my_value_only_variable})"

gcloud

Untuk membuat dasbor dalam project, gunakan perintah gcloud monitoring dashboards create.

gcloud monitoring dashboards create --config-from-file=my-dashboard.json --project=PROJECT_ID

Sebelum menjalankan perintah sebelumnya, ganti perintah berikut:

• PROJECT_ID: ID project. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.

Misalnya, jika Anda ingin menduplikasi dasbor, lakukan tindakan berikut:

1. Selesaikan langkah-langkah di Mendapatkan dasbor untuk mendownload definisi dasbor asli.
2. Edit JSON yang ditampilkan untuk menghapus kolom etag dan name, serta mengubah nilai kolom displayName.
3. Jalankan perintah untuk membuat dasbor.

Untuk informasi selengkapnya, lihat referensi gcloud monitoring dashboards create.

Terraform

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi penyedia Terraform.

Untuk membuat dasbor menggunakan Terraform, lakukan tindakan berikut:

1. Instal dan konfigurasi Terraform untuk project Anda. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.

2. Gunakan resource Terraform google_monitoring_dashboard.

   Dalam perintah, tetapkan kolom berikut:

   • dashboard_json: Representasi JSON dasbor, menggunakan format Dashboards.

     Untuk melihat contoh format ini, Anda dapat mencantumkan dasbor menggunakan API Explorer, atau membuka dasbor di konsol Google Cloud , dan melihat representasi JSON.

   • parent: Nama project Anda yang memenuhi syarat sepenuhnya. Misalnya, Anda dapat menyetel kolom ini ke "projects/PROJECT_ID", dengan PROJECT_ID adalah ID project Google Cloud Anda. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.

REST

Untuk membuat dasbor baru, kirim permintaan POST ke endpoint Dashboard.

curl -d @my-dashboard.json -H "Authorization: Bearer $ACCESS_TOKEN" -H 'Content-Type: application/json' -X POST https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards

Sebelum menjalankan perintah sebelumnya, konfigurasi hal berikut:

• ${PROJECT_ID}: Variabel lingkungan yang menyimpan project ID tempat dasbor akan dibuat. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.

gcloud

Untuk menghapus dasbor kustom, gunakan gcloud monitoring dashboards delete, dan tentukan ID yang sepenuhnya memenuhi syarat dari dasbor yang akan dihapus:

gcloud monitoring dashboards delete DASHBOARD_ID --project=PROJECT_ID

Sebelum menjalankan perintah sebelumnya, ganti perintah berikut:

• PROJECT_ID: ID project. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.
• DASHBOARD_ID: ID dasbor.

Untuk informasi selengkapnya, lihat referensi gcloud monitoring dashboards delete.

Terraform

Anda dapat menghapus resource menggunakan Terraform. Untuk mengetahui informasi tentang menghapus resource, lihat perintah Terraform destroy.

REST

Untuk menghapus dasbor kustom, kirim permintaan DELETE ke endpoint Dashboard, yang memenuhi syarat dengan ID dasbor yang akan dihapus.

curl -H "Authorization: Bearer $ACCESS_TOKEN" -X DELETE https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards/${DASHBOARD_ID}

Sebelum menjalankan perintah sebelumnya, konfigurasi hal berikut:

• ${PROJECT_ID}: Variabel lingkungan yang menyimpan project ID tempat dasbor akan dibuat. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.
• ${DASHBOARD_ID}: Variabel lingkungan yang menyimpan ID dasbor.

Jika berhasil, metode ini akan menampilkan respons kosong. Jika tidak, error akan ditampilkan.

gcloud

Untuk mencantumkan semua dasbor kustom project, gunakan perintah gcloud monitoring dashboards list:

gcloud monitoring dashboards list --project=PROJECT_ID

Sebelum menjalankan perintah sebelumnya, ganti perintah berikut:

• PROJECT_ID: ID project. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.

Untuk informasi selengkapnya, lihat referensi gcloud monitoring dashboards list

Terraform

Anda tidak dapat menggunakan Terraform untuk mengirim kueri ke project dengan respons berupa daftar dasbor. Namun, Anda dapat melihat dasbor ini menggunakan konsol Google Cloud .

REST

Untuk mencantumkan semua dasbor kustom project, kirimkan project ID ke endpoint Dashboard.

curl -H "Authorization: Bearer $ACCESS_TOKEN" https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards

Sebelum menjalankan perintah sebelumnya, konfigurasi hal berikut:

• ${PROJECT_ID}: Variabel lingkungan yang menyimpan project ID tempat dasbor akan dibuat. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.

gcloud

Untuk menentukan jumlah resource per halaman, teruskan tanda --page-size dengan perintah. Contoh:

gcloud monitoring dashboards list --page-size=1 --project=PROJECT_ID

Sebelum menjalankan perintah sebelumnya, ganti perintah berikut:

• PROJECT_ID: ID project. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.

Terraform

Anda tidak dapat menggunakan Terraform untuk mengirim kueri ke project dengan respons berupa daftar dasbor yang di-pagination. Namun, Anda dapat melihat dasbor ini menggunakan konsol Google Cloud .

REST

Untuk halaman awal daftar hasil, tentukan parameter kueri pageSize dengan permintaan:

curl -H "Authorization: Bearer $ACCESS_TOKEN" https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards?page_size=1

Sebelum menjalankan perintah sebelumnya, konfigurasi hal berikut:

• ${PROJECT_ID}: Variabel lingkungan yang menyimpan project ID tempat dasbor akan dibuat. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.

Metode ini menampilkan halaman pertama daftar dan nextPageToken. Misalnya:

{
  "dashboards" : [
    {
       "displayName" : "Grid Layout Example",
       "gridLayout" : {
         "widgets" : [
            { ... },
            { ... },
            { ... },
          ]
       }
    }
  ]
},
"nextPageToken": "ChYqFDEyMzkzMzUwNzg0OTE1MDI4MjM3"

Untuk setiap halaman yang tersisa, Anda harus menyertakan nextPageToken yang sesuai dalam permintaan.

gcloud

Untuk mendapatkan dasbor kustom tertentu, gunakan perintah gcloud monitoring dashboards describe dan tentukan ID dasbor:

gcloud monitoring dashboards describe DASHBOARD_ID --format=json --project=PROJECT_ID

Sebelum menjalankan perintah sebelumnya, ganti perintah berikut:

• PROJECT_ID: ID project. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.
• DASHBOARD_ID: ID dasbor.

Perintah ini akan menampilkan dasbor yang diminta:

{
  "columnLayout": {
    "columns": [
      {
        "widgets": [
          {
            "text": {
              "content": "Text Widget 1",
              "format": "RAW"
            }
          },
          {
            "text": {
              "content": "**Text Widget 2**",
              "format": "MARKDOWN"
            }
          },
          {
            "text": {
              "content": "_Text Widget 3_",
              "format": "MARKDOWN"
            }
          }
        ]
      }
    ]
  },
  "displayName": "Column-layout example",
  "etag": "cb3070baf15de7c79d78761baac3a386",
  "name": "projects/730041941835/dashboards/e4cd063e-5414-4e07-9e1e-450d6d3a531d"
}

Untuk informasi selengkapnya, lihat referensi gcloud monitoring dashboards describe.

Terraform

Anda tidak dapat menggunakan Terraform untuk mengirim kueri ke project dengan respons berupa dasbor individual. Namun, Anda dapat melihat dasbor ini menggunakan konsol Google Cloud .

REST

Untuk mendapatkan dasbor kustom tertentu, kirimkan ID dasbor ke endpoint Dashboard.

curl -H "Authorization: Bearer $ACCESS_TOKEN" https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards/${DASHBOARD_ID}

Sebelum menjalankan perintah sebelumnya, konfigurasi hal berikut:

• ${PROJECT_ID}: Variabel lingkungan yang menyimpan project ID tempat dasbor akan dibuat. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.
• ${DASHBOARD_ID}: Variabel lingkungan yang menyimpan ID dasbor.

Dalam ekspresi sebelumnya, ${DASHBOARD_ID} adalah variabel lingkungan yang menyimpan nama lengkap dasbor.

Metode ini menampilkan respons yang mirip dengan contoh berikut:

{
  "columnLayout": {
    "columns": [
      {
        "widgets": [
          {
            "text": {
              "content": "Text Widget 1",
              "format": "RAW"
            }
          },
          {
            "text": {
              "content": "**Text Widget 2**",
              "format": "MARKDOWN"
            }
          },
          {
            "text": {
              "content": "_Text Widget 3_",
              "format": "MARKDOWN"
            }
          }
        ]
      }
    ]
  },
  "displayName": "Column-layout example",
  "etag": "cb3070baf15de7c79d78761baac3a386",
  "name": "projects/730041941835/dashboards/e4cd063e-5414-4e07-9e1e-450d6d3a531d"
}

gcloud

Untuk memperbarui dasbor kustom, gunakan gcloud monitoring dashboards update, tentukan ID dasbor yang akan diperbarui, dan berikan perubahan pada dasbor.

gcloud monitoring dashboards update DASHBOARD_ID --config-from-file=my-updated-dashboard.json --project=PROJECT_ID

Sebelum menjalankan perintah sebelumnya, ganti perintah berikut:

• PROJECT_ID: ID project. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.
• DASHBOARD_ID: ID dasbor.

Untuk informasi selengkapnya, lihat referensi gcloud monitoring dashboards update.

Contoh sebelumnya memperbarui dasbor kustom yang ada menggunakan file my-updated-dashboard.json. Respons, yang mencakup nilai etag baru, adalah salinan listingan dasbor yang diperbarui.

Terraform

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi penyedia Terraform.

Untuk memperbarui dasbor menggunakan Terraform, lakukan langkah-langkah berikut:

1. Instal dan konfigurasi Terraform untuk project Anda. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.

2. Gunakan resource Terraform google_monitoring_dashboard.

   Dalam perintah, tetapkan kolom berikut:

   • dashboard_json: Representasi JSON dasbor, menggunakan format Dashboards.

   • parent: Nama project Anda yang memenuhi syarat sepenuhnya. Misalnya, Anda dapat menyetel kolom ini ke "projects/PROJECT_ID", dengan PROJECT_ID adalah ID project Google Cloud Anda. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.

REST

Untuk memperbarui dasbor kustom, kirim permintaan PATCH ke endpoint Dashboard dan berikan objek Dashboard yang telah direvisi serta nilai etag dari respons dashboards.get terbaru.

curl -d @my-updated-dashboard.json -H "Authorization: Bearer $ACCESS_TOKEN" -H 'Content-Type: application/json' -X PATCH https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards/${DASHBOARD_ID}

Sebelum menjalankan perintah sebelumnya, konfigurasi hal berikut:

• ${PROJECT_ID}: Variabel lingkungan yang menyimpan project ID tempat dasbor akan dibuat. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.
• ${DASHBOARD_ID}: Variabel lingkungan yang menyimpan ID dasbor.

Contoh sebelumnya memperbarui dasbor kustom yang ada menggunakan file my-updated-dashboard.json. Respons, yang mencakup nilai etag baru, adalah salinan listingan dasbor yang diperbarui.