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 ringkasan metrik berbasis log, lihat Ringkasan metrik berbasis log.

Sebelum memulai

Untuk menggunakan metrik berbasis log, Anda harus memiliki project Google Cloud dengan penagihan yang diaktifkan:
Pastikan peran Identity and Access Management Anda menyertakan izin yang diperlukan untuk membuat dan melihat metrik berbasis log, dan untuk membuat kebijakan pemberitahuan. Untuk mengetahui detailnya, lihat Izin untuk metrik berbasis log.

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 lebih dari 20.000 karakter.

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

Konsol

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

Pada panel navigasi Google Cloud Console, pilih Logging, lalu pilih Log-based Metrics:
Buka Metrik Berbasis Log
Klik Buat Metrik. Panel Buat metrik log akan muncul.
Tetapkan Jenis metrik: Pilih Penghitung.
Tetapkan kolom berikut di bagian Detail:
- Log metric name: Pilih nama yang unik di antara metrik berbasis log di project Google Cloud Anda. Beberapa pembatasan penamaan berlaku; lihat Pemecahan masalah untuk detailnya.
- Deskripsi: Masukkan deskripsi untuk metrik.
- Units: Biarkan kosong atau masukkan angka 1.
Tentukan filter metrik di bagian Pilihan filter.
1. Gunakan Pilih cakupan log untuk memilih apakah filter Anda menargetkan semua log project Google Cloud atau hanya log di bucket 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.
(Opsional) Tambahkan label di bagian Label. Untuk mengetahui petunjuk tentang cara membuat label, lihat Membuat label.
Klik Buat metrik untuk membuat metrik.

gcloud

Anda dapat membuat metrik berbasis log tanpa label khusus 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 dengan 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"

Untuk membuat metrik berbasis log dengan 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 mengetahui petunjuk tentang cara membuat label, lihat Membuat label.

API

Untuk membuat metrik penghitung, gunakan metode projects.metrics.create dari Logging API. Anda dapat mencoba metode ini di APIs Explorer. Siapkan argumen ke metode sebagai berikut:

Tetapkan kolom parent ke project atau bucket tempat metrik akan dibuat:
- Untuk metrik berbasis log dengan cakupan project, tentukan project:
```
projects/PROJECT_ID
```
- Untuk metrik berbasis log dengan cakupan bucket, tentukan bucket:
```
projects/PROJECT_ID/locations/LOCATION/bucket/BUCKET_ID
```

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 dalam 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 mengetahui detail selengkapnya, lihat jenis LogMetric.

Latensi metrik baru

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

Memeriksa metrik berbasis log

Untuk menampilkan daftar metrik berbasis log yang ditentukan pengguna dalam project Google Cloud Anda atau untuk memeriksa metrik tertentu dalam project Google Cloud Anda, lakukan hal berikut:

Konsol

Pada panel navigasi Google Cloud Console, pilih Logging, lalu pilih Log-based Metrics:
Buka Metrik Berbasis Log
Di panel Metrik yang ditentukan pengguna, Anda akan melihat metrik berbasis log yang ditetapkan pengguna dalam project Google Cloud saat ini:
Untuk melihat data dalam metrik berbasis log, klik Menu pada baris metrik, lalu pilih View in Metrics Explorer.

gcloud

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

gcloud logging metrics list

Untuk menampilkan metrik berbasis log yang ditentukan pengguna dalam project Google Cloud Anda, 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 menampilkan daftar metrik berbasis log yang ditetapkan pengguna dalam project Google Cloud, gunakan metode API projects.metrics.list. Isi parameter ke metode sebagai berikut:

parent: Nama resource project Google Cloud: projects/PROJECT_ID.
pageSize: Jumlah hasil maksimum.
pageToken: Mendapatkan halaman hasil berikutnya. Untuk informasi tentang penggunaan 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 tersebut 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 tersebut. Anda dapat menambahkan label baru ke metrik dan mengubah ekspresi reguler yang digunakan untuk mengekstrak nilai 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 hal berikut:

Konsol

Pada panel navigasi Google Cloud Console, pilih Logging, lalu pilih Log-based Metrics:
Buka Metrik Berbasis Log
Klik Edit metric di Menu untuk metrik berbasis log yang ingin Anda ubah.
Ubah item yang diizinkan dalam metrik.
Klik Perbarui metrik.

gcloud

Gunakan Google Cloud CLI untuk mengubah deskripsi, kueri filter, dan bucket metrik penghitung. 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 yang dikumpulkan sebelum perubahan tidak lagi mencerminkan konfigurasi saat ini. Data metrik yang dikumpulkan untuk bucket sebelumnya tidak dihapus.

Untuk memperbarui metrik distribusi atau kolom metrik penghitung lainnya, kecuali METRIC_NAME, buat file yang berisi revisi spesifikasi LogMetric dalam format JSON atau YAML. Kemudian, perbarui metrik dengan memanggil perintah update dengan kolom --config-from-file, dengan 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 tindakan berikut:

Konsol

Pada panel navigasi Google Cloud Console, pilih Logging, lalu pilih Log-based Metrics:
Buka Metrik Berbasis Log
Pilih metrik yang ingin Anda hapus, lalu klik Hapus.

Atau, klik Delete metric di menu pada 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

For more details, use the following command:

gcloud logging metrics delete --help

API

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

Selain itu, di halaman Log-based metric di Konsol Google Cloud, panel User-defined metrics pada antarmuka metrik berbasis log menyediakan lebih banyak fitur untuk membantu Anda mengelola metrik yang ditentukan pengguna di project Google Cloud Anda. Lihat Panel metrik buatan pengguna untuk mengetahui detailnya.