Mengonfigurasi metrik penghitung

Dokumen ini menjelaskan cara membuat metrik berbasis log jenis penghitung menggunakan konsol Google Cloud , Logging API, dan Google Cloud CLI.

Metrik penghitung menghitung jumlah entri log yang cocok dengan filter tertentu. Misalnya, Anda dapat membuat metrik berbasis log yang menghitung jumlah entri log yang berisi pesan error tertentu. Metrik berbasis log dapat diterapkan dalam satu project Google Cloud atau dalam bucket log.

Untuk mengetahui ringkasan metrik berbasis log, lihat Ringkasan metrik berbasis log.

Sebelum memulai

  1. Untuk menggunakan metrik berbasis log, Anda harus memiliki Google Cloud project dengan penagihan diaktifkan:

    1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

    2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

      Go to project selector

    3. Make sure that billing is enabled for your Google Cloud project.

    4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

      Go to project selector

    5. Make sure that billing is enabled for your Google Cloud project.

    6. Pastikan peran Identity and Access Management Anda menyertakan izin yang diperlukan untuk membuat dan melihat metrik berbasis log, serta membuat kebijakan pemberitahuan. Untuk mengetahui detailnya, lihat Izin untuk metrik berbasis log.

      7. Membuat metrik berbasis log jenis penghitung

      Metrik ini menghitung entri log yang diidentifikasi oleh filter yang Anda berikan. Anda dapat menggunakan ekspresi reguler dalam filter, dan sebaiknya sertakan jenis resource. Panjang filter tidak boleh melebihi 20.000 karakter.

      Jangan masukkan informasi sensitif dalam filter. Filter diperlakukan sebagai data layanan.

      Konsol

      Ikuti langkah-langkah berikut untuk membuat metrik penghitung di konsolGoogle Cloud dalam project Google Cloud Anda:

      1. Di Google Cloud konsol, buka halaman Metrik Berbasis Log:

        Buka Metrik Berbasis Log

        Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Logging.

      2. Klik Create metric. Panel Create logs metric akan muncul.

      3. Tetapkan Jenis metrik: Pilih Penghitung.

      4. Tetapkan kolom berikut di bagian Detail:

        • Nama metrik log: Pilih nama yang unik di antara metrik berbasis log di project Google Cloud Anda. Beberapa pembatasan penamaan berlaku; lihat Pemecahan masalah untuk mengetahui detailnya.
        • Deskripsi: Masukkan deskripsi untuk metrik.
        • Units: Biarkan kosong atau masukkan angka 1.

      5. Tentukan filter metrik di bagian Filter selection.

        1. Gunakan menu Select project or log bucket untuk memilih apakah metrik menghitung entri log di project Google Cloud Anda atau hanya entri log tersebut di bucket log tertentu.

        2. Buat filter yang hanya mengumpulkan entri log yang ingin Anda hitung dalam metrik menggunakan bahasa kueri logging. Anda juga dapat menggunakan ekspresi reguler untuk membuat filter metrik.

        3. Untuk melihat entri log yang cocok dengan filter Anda, klik Pratinjau log.

      6. (Opsional) Tambahkan label di bagian Labels. Untuk petunjuk mengenai cara membuat label, lihat Membuat label.

      7. Klik Create metric untuk membuat metrik.

      gcloud

      Anda dapat membuat metrik berbasis log tanpa label kustom menggunakan perintah berikut:

      gcloud logging metrics create METRIC_NAME \
  --description="METRIC_DESCRIPTION" \
  --log-filter="FILTER" \
  [--bucket-name="BUCKET_NAME"]

      Misalnya, perintah berikut akan membuat metrik berbasis log cakupan project yang disebut error_count.

      gcloud logging metrics create error_count \
     --description "Errors in syslog." \
     --log-filter "resource.type=gce_instance AND log_id(\"syslog\") AND severity>=ERROR"

      Sebagai gantinya, untuk membuat metrik berbasis log cakupan bucket, berikan flag --bucket_name:

      gcloud logging metrics create error_count \
    --description "Errors in syslog." \
    --log-filter "resource.type=gce_instance AND log_id(\"syslog\") AND severity>=ERROR" \
    --bucket-name projects/my-project/locations/global/buckets/my-test-bucket

      Untuk petunjuk tentang cara membuat label, lihat Mengonfigurasi label pada metrik berbasis log.

      API

      Untuk membuat metrik penghitung, gunakan metode projects.metrics.create dari Logging API. Jika Anda menggunakan panel API Explorer di halaman referensi, siapkan argumen sebagai berikut:

      1. Tetapkan kolom parent ke project atau bucket tempat metrik akan dibuat:

        • Untuk metrik berbasis log cakupan project, tentukan project:
        projects/PROJECT_ID
        • Untuk metrik berbasis log dengan cakupan bucket, tentukan bucket:
        projects/PROJECT_ID/locations/LOCATION/bucket/BUCKET_ID

      2. Tetapkan isi permintaan ke objek LogMetric. Berikut adalah contoh objek untuk metrik penghitung:

        {
  name:        "my-metric"
  description: "This is my metric."
  filter:      "resource.type=gce_instance AND log_id(\"syslog\")",
  metricDescriptor: {
      labels: [
        {
          key: "my-label",
          valueType: STRING,
          description: "This is my label.",
        }
      ]
  },
  labelExtractors: {
    "my-label":
      "REGEXP_EXTRACT(jsonPayload.someField, \"before ([0-9]+) after\")",
    ...
  },
}

      Catatan:

      • Pilih nama metrik yang unik di antara metrik berbasis log di project Anda. Beberapa batasan penamaan berlaku; lihat Pemecahan masalah untuk mengetahui detailnya.

      • Untuk metrik penghitung, kolom LogMetric valueExtractor dan bucketOptions tidak memiliki tujuan dan dihilangkan.

      • Jika metrik tidak memiliki label, Anda dapat menghapus kolom metricDescriptor dan labelExtractors. Jika metrik Anda memiliki label, lihat label metrik berbasis log untuk mengetahui pengantar label dan detail tentang cara membuatnya di API.

      Untuk detail selengkapnya, lihat jenis LogMetric.

      Latensi metrik baru

      Metrik baru Anda akan langsung muncul di daftar metrik Logs Explorer dan di menu Pemantauan yang relevan. Data biasanya tersedia dalam waktu kurang dari satu menit.

      Memeriksa metrik berbasis log

      Untuk mencantumkan metrik berbasis log yang ditentukan pengguna di project Google Cloud atau untuk memeriksa metrik tertentu di project Google Cloud , lakukan tindakan berikut:

      Konsol

      1. Di Google Cloud konsol, buka halaman Metrik Berbasis Log:

        Buka Metrik Berbasis Log

        Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Logging.

      2. Di panel Metrik yang ditentukan pengguna, Anda akan melihat metrik berbasis log yang ditentukan pengguna di project Google Cloud saat ini:

      3. Untuk melihat data dalam metrik berbasis log, klik Menu di baris metrik, lalu pilih Lihat di Metrics Explorer.

      gcloud

      Untuk mencantumkan metrik berbasis log yang ditentukan pengguna di project Google Cloud , gunakan perintah berikut:

      gcloud logging metrics list

      Untuk menampilkan metrik berbasis log yang ditentukan pengguna dalam project Google Cloud , gunakan perintah berikut:

      gcloud logging metrics describe METRIC_NAME

      Untuk mendapatkan bantuan, gunakan perintah berikut:

      gcloud logging metrics --help

      Anda tidak dapat membaca data deret waktu metrik dari Google Cloud CLI.

      API

      Mencantumkan metrik

      Untuk mencantumkan metrik berbasis log yang ditentukan pengguna dalam project Google Cloud , gunakan metode API projects.metrics.list. Isi parameter ke metode sebagai berikut:

      • parent: Nama resource Google Cloud project: projects/PROJECT_ID.
      • pageSize: Jumlah hasil maksimum.
      • pageToken: Mendapatkan halaman hasil berikutnya. Untuk informasi cara menggunakan token halaman, lihat projects.metrics.list.

      Mengambil definisi metrik

      Untuk mengambil satu metrik berbasis log yang ditentukan pengguna, gunakan metode API projects.metrics.get. Isi parameter ke metode sebagai berikut:

      • metricName: Nama resource metrik:

        projects/PROJECT_ID/metrics/METRIC_ID

      Membaca data metrik

      Untuk membaca data deret waktu dalam metrik berbasis log, gunakan projects.timeseries.list di Cloud Monitoring API. Untuk mengetahui detail tentang data deret waktu, lihat Membaca deret waktu.

      Untuk membaca satu metrik berbasis log yang ditentukan pengguna, isi parameter metode dengan jenis dan ID metrik ini:

      logging.googleapis.com/user/METRIC_ID

      Memperbarui metrik berbasis log

      Anda dapat mengedit metrik berbasis log yang ditentukan pengguna untuk mengubah deskripsi, filter, dan nama kolom yang dirujuk dalam metrik. Anda dapat menambahkan label baru ke metrik dan mengubah ekspresi reguler yang digunakan untuk mengekstrak nilai untuk metrik dan labelnya. Jika menggunakan metrik cakupan bucket, Anda juga dapat memperbarui bucket metrik.

      Anda tidak dapat mengubah nama atau jenis metrik berbasis log yang ditentukan pengguna atau labelnya, dan Anda tidak dapat menghapus label yang ada dalam metrik berbasis log.

      Untuk mengedit metrik berbasis log, lakukan tindakan berikut:

      Konsol

      1. Di Google Cloud konsol, buka halaman Metrik Berbasis Log:

        Buka Metrik Berbasis Log

        Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Logging.

      2. Klik Edit metric di Menu untuk metrik berbasis log yang ingin Anda ubah.

      3. Mengubah item yang diizinkan dalam metrik.

      4. Klik Perbarui metrik.

      gcloud

      Gunakan Google Cloud CLI untuk mengubah deskripsi metrik penghitung, kueri filter, dan bucket. Anda dapat memperbarui salah satu atau semua kolom sekaligus.

      gcloud logging update METRIC_NAME \
  --description="METRIC_DESCRIPTION" \
  --log-filter="FILTER" \
  --bucket-name=BUCKET_NAME

      Jika Anda mengubah bucket yang terkait dengan metrik cakupan bucket, data metrik apa pun yang dikumpulkan sebelum perubahan tidak lagi mencerminkan konfigurasi saat ini. Data metrik yang dikumpulkan untuk bucket sebelumnya tidak akan dihapus.

      Untuk memperbarui metrik distribusi atau kolom metrik penghitung lainnya, kecuali METRIC_NAME, buat file yang berisi spesifikasi revisi LogMetric dalam format JSON atau YAML. Kemudian, perbarui metrik dengan memanggil perintah update dengan kolom --config-from-file, yang mengganti FILENAME dengan nama file JSON atau YAML Anda:

      gcloud logging update METRIC_NAME --config-from-file FILENAME

      Untuk detail selengkapnya, gunakan perintah berikut:

      gcloud logging metrics update --help

      API

      Untuk mengedit metrik berbasis log, gunakan metode projects.metrics.update di API. Tetapkan kolom sebagai berikut:

      • metricName: Nama resource lengkap metrik:

        projects/PROJECT_ID/metrics/METRIC_ID

        Contoh:

        projects/my-gcp-project/metrics/my-error-metric

      • Dalam isi permintaan, sertakan objek LogMetric yang sama persis dengan metrik yang ada, kecuali untuk perubahan dan penambahan yang ingin Anda buat.

      Menghapus metrik berbasis log

      Untuk menghapus metrik berbasis log yang ditentukan pengguna, lakukan hal berikut:

      Konsol

      1. Di Google Cloud konsol, buka halaman Metrik Berbasis Log:

        Buka Metrik Berbasis Log

        Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Logging.

      2. Pilih metrik yang ingin dihapus, lalu klik Hapus.

        Atau, klik Hapus metrik di menu metrik berbasis log yang ingin Anda hapus.

      gcloud

      Gunakan perintah berikut untuk menghapus metrik berbasis log yang ditentukan pengguna dalam project Google Cloud saat ini:

      gcloud logging metrics delete METRIC_NAME

      Untuk detail selengkapnya, gunakan perintah berikut:

      gcloud logging metrics delete --help

      API

      Untuk menghapus metrik berbasis log yang ditentukan pengguna, gunakan metode projects.metrics.delete di API.

      Selain itu, di halaman Metrik berbasis log Google Cloud konsol, panel Metrik yang ditentukan pengguna di antarmuka metrik berbasis log menyediakan lebih banyak fitur untuk membantu Anda mengelola metrik yang ditentukan pengguna di projectGoogle Cloud . Lihat Metrik yang ditentukan pengguna untuk mengetahui detailnya.