Membuat dan menyimpan kueri menggunakan bahasa kueri Logging

Dokumen ini menjelaskan cara mengambil dan menganalisis log saat Anda menggunakan Logs Explorer dengan menulis kueri di kolom editor kueri dan dengan memilih dari opsi filter yang telah ditentukan sebelumnya. Kueri yang Anda buat ditulis dalam bahasa kueri Logging.

Anda juga dapat menyimpan kueri di halaman Logs Explorer, atau menggunakan metode Logging API savedQueries.create.

Sebelum memulai

Peran Logs Viewer (roles/logging.viewer) memberikan akses untuk melihat log. Misalnya, jika diberi peran ini, Anda dapat menulis dan menjalankan kueri. Anda juga dapat menyimpan kueri sebagai kueri pribadi, dan menjalankan kueri pribadi dan bersama. Namun, peran ini tidak mengizinkan Anda menyimpan atau mengubah kueri bersama. Jika Anda ingin menyimpan atau mengubah kueri bersama, pastikan Anda telah diberi peran Logging Admin (roles/logging.admin), yang memberikan akses penuh ke Cloud Logging.

Lakukan salah satu hal berikut:

  • Untuk mendapatkan izin yang diperlukan guna menulis dan menjalankan kueri, menjalankan dan menyimpan kueri pribadi, serta menjalankan kueri bersama, minta administrator untuk memberi Anda peran IAM Logs Viewer (roles/logging.viewer) di project Anda.

  • Untuk mendapatkan izin yang diperlukan untuk menulis dan menjalankan kueri, menjalankan dan menyimpan kueri pribadi, serta menjalankan, membuat, dan mengelola kueri bersama, minta administrator untuk memberi Anda peran IAM Logging Admin (roles/logging.admin) di project Anda.

Untuk mengetahui informasi selengkapnya tentang izin IAM yang diperlukan, lihat Izin untuk konsol Google Cloud .

Membangun kueri

Untuk membuat kueri menggunakan konsol Google Cloud , lakukan hal berikut:

  1. Di konsol Google Cloud , buka halaman Logs Explorer:

    Buka Logs Explorer

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

  2. Pilih Google Cloud project atau Google Cloud resource lain yang lognya ingin Anda lihat.

  3. Gunakan panel Kueri untuk membuat kueri.

    Panel Query menyediakan beberapa cara untuk membuat dan menjalankan ekspresi kueri:

    • Menelusuri teks di semua kolom log.
    • Pilih opsi dari menu filter.
    • Tulis atau ubah kueri menggunakan editor kueri.
    • Lihat dan jalankan kueri tersimpan, terbaru, dan yang disarankan dari Pustaka kueri.

Menelusuri teks di seluruh kolom log

Untuk menelusuri teks di semua kolom log dan menemukan semua entri log yang cocok, masukkan istilah penelusuran di kolom penelusuran pada panel Kueri.

Anda dapat menelusuri kata dan frasa, dan istilah penelusuran Anda dapat mencakup operator Boolean dan ekspresi reguler:

  • Untuk melakukan penelusuran yang peka huruf besar/kecil, Anda harus menggunakan ekspresi reguler.

  • Untuk melakukan penelusuran yang tidak peka huruf besar/kecil di sepanjang batas token, masukkan istilah penelusuran tanpa tanda petik terbalik atau tanda kutip ganda.

    Misalnya, untuk menelusuri entri log yang berisi kata hello dan kata world, masukkan hello world. Perintah ini, yang dikonversi menjadi SEARCH("hello world"), cocok dengan entri log yang berisi token hello dan world, dalam urutan apa pun. Karena penelusuran tidak peka huruf besar/kecil, penelusuran juga cocok dengan entri log yang berisi token Hello dan World. Penelusuran tidak cocok dengan token worlds.

  • Untuk melakukan penelusuran frasa yang tidak peka huruf besar/kecil di sepanjang batas token, masukkan frasa dalam tanda petik terbalik.

    Misalnya, untuk menelusuri frasa hello world, masukkan `hello world`. Perintah ini, yang dikonversi menjadi SEARCH("`hello world`"), mencocokkan entri log yang berisi token hello world. Penelusuran tidak cocok dengan token hello worlds.

  • Untuk melakukan penelusuran substring yang tidak peka huruf besar/kecil, sertakan teks dalam tanda kutip ganda. Misalnya, "hello world" cocok dengan Hello World dan Hello world. Kueri yang sama juga cocok dengan hello worlds, karena penelusuran tidak dilakukan di sepanjang batas token.

Untuk melihat istilah penelusuran dalam ekspresi kueri, aktifkan Tampilkan kueri.

Setelah Anda memasukkan istilah penelusuran, klik Jalankan kueri atau tekan tombol Enter. Hasil kueri ditampilkan di panel Query results.

Operator Boolean

Entri kolom penelusuran Anda dikonversi menjadi ekspresi Boolean yang menentukan subset dari semua entri log di resource yang Anda pilih. Google Cloud

Kolom penelusuran mendukung penggunaan operator Boolean AND, OR, dan NOT. Saat menggunakan operator Boolean dalam ekspresi penelusuran, perhatikan hal-hal berikut:

  • Anda tidak dapat menggunakan tanda kurung untuk menyusun aturan. Tanda kurung apa pun dalam ekspresi penelusuran diuraikan sebagai istilah penelusuran.
  • Anda harus menggunakan huruf kapital untuk operator Boolean. and, or, dan not huruf kecil diuraikan sebagai istilah penelusuran, bukan sebagai operator.

Jika Anda tidak menyertakan operator apa pun, semua istilah dan frasa penelusuran akan digabungkan dengan AND. Anda dapat menghilangkan operator AND di antara istilah penelusuran.

Operator AND dan OR adalah operator short-circuit. Anda dapat menggabungkan aturan AND dan OR dalam ekspresi yang sama. Misalnya, jika kedua operator digabungkan, ekspresi a AND b OR c AND d akan berubah menjadi ekspresi bahasa kueri Logging berikut:

"a"
"b" OR "c"
"d"

Operator NOT memiliki prioritas tertinggi, diikuti oleh OR dan AND dalam urutan tersebut.

Operator NOT melakukan negasi pada istilah berikutnya. Misalnya, NOT error menampilkan entri log yang tidak berisi error. Anda juga dapat mengganti operator NOT dengan operator - (minus). Misalnya, dua kueri berikut sama:

"response" AND "successful" AND NOT "error"

"response successful" -"error"

Logika ini juga berfungsi dengan frasa, jika operator - (minus) berada di luar tanda petik. Misalnya, dua kueri berikut sama:

-"response successful"

NOT "response successful"

Membuat kueri dengan menu filter

Anda dapat menggunakan menu filter di panel Kueri untuk menambahkan parameter korelasi, tingkat keparahan log, nama log, dan resource ke kolom editor kueri. Opsi ini sesuai dengan kolom LogEntry untuk semua log di Logging.

Opsi di menu Resource dan Log name berasal dari entri log yang disimpan oleh Cloud Logging.

  • Resource: Memungkinkan Anda menentukan resource.type dan resource.labels terkait. Anda dapat memilih satu jenis resource menggunakan menu filter ini, dan nol atau lebih label resource untuk diterapkan ke kueri Anda. Parameter resource digabungkan oleh operator logika AND.
  • Nama log: Memungkinkan Anda menentukan logName. Anda dapat memilih beberapa nama log untuk diterapkan ke kueri Anda. Saat memilih beberapa nama log, operator logika OR digunakan.
  • Keparahan: Memungkinkan Anda menentukan tingkat keparahan. Anda dapat memilih beberapa tingkat keparahan secara bersamaan untuk ditambahkan ke kueri Anda. Saat memilih beberapa tingkat keparahan, operator logika OR digunakan.
  • Korelasikan menurut: Memungkinkan Anda mengelompokkan dan melihat entri log dalam format "induk-turunan". Untuk mengetahui informasi selengkapnya, lihat Korelasikan entri log.

Untuk menggunakan salah satu menu filter, lakukan hal berikut:

  1. Luaskan Menu di salah satu menu filter di panel Kueri.

  2. Pertajam parameter filter.

  3. Klik Terapkan. Anda akan melihat parameter di kolom editor kueri.

    Untuk melihat istilah penelusuran dalam ekspresi kueri, aktifkan Tampilkan kueri.

  4. Setelah Anda meninjau kueri, klik Jalankan kueri. Hasil kueri ditampilkan di panel Query results.

Untuk jenis resource Compute Engine tertentu, seperti gce_instance dan gce_network, Anda akan melihat nama resource dengan ID resource sebagai subteks. Misalnya, untuk jenis resource gce_instance, Anda akan melihat nama VM bersama dengan ID VM. Nama resource membantu Anda mengidentifikasi ID resource yang benar, yang dapat Anda gunakan untuk membuat kueri.

Melihat log menurut rentang waktu

Ada dua cara untuk menampilkan log yang ditulis dalam rentang waktu tertentu:

  1. Gunakan pemilih rentang waktu.
  2. Sertakan ekspresi stempel waktu di kolom editor kueri.

Menggunakan pemilih rentang waktu

Rentang waktu default adalah satu jam, tetapi Anda dapat memilih dari opsi waktu preset, menentukan waktu mulai dan berakhir kustom, atau memusatkan rentang waktu di sekitar stempel waktu tertentu menggunakan pemilih rentang waktu. Misalnya, jika Anda ingin melihat data untuk minggu lalu, pilih 1 minggu terakhir dari pemilih rentang waktu.

Anda juga dapat menyetel preferensi zona waktu menggunakan pemilih rentang waktu.

Menyertakan ekspresi stempel waktu di kolom editor kueri

Untuk menambahkan ekspresi stempel waktu langsung ke kolom editor kueri, gunakan Bahasa kueri logging.

Jika kolom editor kueri berisi ekspresi dengan stempel waktu, pemilih rentang waktu akan dinonaktifkan, dan kueri menggunakan ekspresi stempel waktu sebagai batasan rentang waktunya. Jika kueri tidak menggunakan ekspresi stempel waktu, maka kueri menggunakan pemilih rentang waktu sebagai batasan rentang waktunya.

Menulis kueri lanjutan menggunakan bahasa kueri Logging

Anda dapat menggunakan bahasa kueri Logging untuk membuat kueri yang lebih canggih di kolom editor kueri Logs Explorer:

  1. Jika Anda tidak melihat kolom editor kueri di panel Query, aktifkan Show query.

  2. Masukkan ekspresi kueri Anda langsung ke kolom editor kueri.

    Jika Anda menambahkan istilah penelusuran di kolom penelusuran atau memilih parameter di menu filter, istilah dan parameter tersebut juga akan muncul di kolom editor kueri dan dievaluasi sebagai bagian dari ekspresi kueri Anda.

  3. Setelah Anda meninjau kueri, klik Jalankan kueri.

    Log yang cocok dengan kueri Anda akan tercantum di panel Hasil kueri. Panel Histogram dan Kolom log juga disesuaikan menurut ekspresi kueri.

Untuk contoh kueri umum yang mungkin ingin Anda gunakan, lihat Contoh kueri menggunakan Logs Explorer.

Menggunakan kueri terbaru

Saat Anda menjalankan kueri apa pun, kueri tersebut akan ditambahkan ke Pustaka kueri, yang berisi 10.000 kueri unik terakhir selama periode 30 hari.

Untuk melihat kueri terbaru Anda, pilih tombol Pustaka kueri di toolbar utama. Untuk kueri terbaru, Anda memiliki opsi berikut:

  • Stream: Untuk menjalankan kueri dan mengalirkan hasilnya, pilih opsi ini.
  • Jalankan: Untuk menjalankan kueri, pilih opsi ini.

  • Opsi lainnya: Memungkinkan Anda melihat ekspresi kueri dengan opsi untuk menjalankan kueri atau menyimpannya ke daftar kueri Tersimpan Anda. Anda juga dapat memilih kueri secara langsung untuk mendapatkan opsi ini.

    Untuk menyimpan kueri, lakukan hal berikut:

    1. Klik Simpan. Dialog Simpan kueri akan terbuka.

    2. Lengkapi kolom berikut:

      • Nama (Wajib): Berikan nama untuk kueri Anda. Nama dibatasi hingga 64 karakter.
      • Deskripsi (Opsional): Berikan deskripsi untuk membantu mengidentifikasi tujuan kueri.
      • Sertakan kolom ringkasan (Opsional): Aktifkan Sertakan kolom ringkasan dan masukkan kolom ringkasan yang ingin Anda tampilkan.
      • Pangkas kolom ringkasan (Opsional): Aktifkan Pangkas kolom ringkasan dan pilih jumlah karakter yang akan dipangkas dan apakah pemangkasan terjadi di awal atau akhir kolom.

    3. Klik Simpan kueri. Kueri kini tersedia di Daftar kueri tersimpan Anda.

Anda juga dapat mengurutkan dan memfilter kueri terbaru; filter cocok dengan teks dalam ekspresi kueri Anda.

Menyimpan dan membagikan kueri

Kueri tersimpan memungkinkan Anda menyimpan ekspresi kueri untuk membantu Anda menjelajahi log secara lebih konsisten dan efisien. Logs Explorer memiliki Pustaka kueri, tempat Anda dapat mengakses kueri tersimpan. Anda juga dapat menyimpan kueri menggunakan metode Logging API savedQueries.create.

Anda dapat menyimpan kueri agar bersifat pribadi dan hanya dapat dilihat oleh Anda, atau Anda dapat membagikannya kepada anggota project Google Cloud lainnya. Setelah Anda membagikan kueri, kueri tersebut tidak lagi dimiliki oleh Anda, dan setiap anggota dalam project dengan izin yang diperlukan dapat mengakses kueri tersebut.

Konsol

Untuk menyimpan ekspresi kueri yang telah Anda buat di kolom editor kueri, lakukan hal berikut:

  1. Klik Simpan di panel Kueri. Dialog Save query akan terbuka, dengan ekspresi kueri Anda di kolom editor kueri.

  2. Lengkapi kolom berikut:

    • Nama (Wajib): Berikan nama untuk kueri Anda. Nama dibatasi hingga 64 karakter.
    • Deskripsi (Opsional): Berikan deskripsi untuk membantu mengidentifikasi tujuan kueri.
    • Sertakan kolom ringkasan kustom (Opsional): Aktifkan Sertakan kolom ringkasan dan masukkan kolom ringkasan yang ingin Anda tampilkan.
    • Pangkas kolom ringkasan (Opsional): Aktifkan Pangkas kolom ringkasan dan pilih jumlah karakter yang akan dipangkas dan apakah pemangkasan terjadi di awal atau akhir kolom.
    • Bagikan dengan project: Secara opsional, aktifkan Bagikan dengan project untuk membagikan kueri Anda kepada anggota project Google Cloud lainnya.

  3. Klik Simpan kueri. Kueri tersimpan Anda akan muncul dalam daftar di tab Tersimpan.

Untuk menjalankan kueri tersimpan, klik Jalankan. Untuk menjalankan kueri dan mengalirkan hasilnya, klik Stream.

Untuk mengubah kueri tersimpan, pilih Opsi lainnya, lalu pilih Edit. Anda juga dapat memilih kueri, melakukan perubahan, lalu menyimpan kueri yang telah diubah.

Untuk menghapus kueri tersimpan, pilih Opsi lainnya, lalu pilih Hapus.

Anda juga dapat mengurutkan dan memfilter kueri tersimpan; filter cocok dengan teks dalam ekspresi kueri Anda.

API

Untuk menyimpan kueri menggunakan Logging API, gunakan metode savedQueries.create. Untuk mengetahui informasi selengkapnya tentang metode ini, parameternya, dan data respons, lihat halaman referensi untuk savedQueries.create.

Anda dapat menjalankan metode savedQueries.create menggunakan widget APIs Explorer di halaman referensi metode. Untuk kueri Logs Explorer, Anda harus menentukan kolom loggingQuery. Contoh berikut mengilustrasikan contoh isi permintaan, yang berisi instance SavedQuery:

{
  "parent": "projects/my-project/locations/global"
  "savedQueryId": "compute-query"
  {
    "displayName": "compute-admin-activity-query",
    "description": "Queries for Compute Engine Admin Activity logs.",

    "loggingQuery":
      {
        "filter": resource.type="gce_instance" AND log_id("cloudaudit.googleapis.com/activity"),
      },
    "visibility": "PRIVATE"
  }
}

Untuk membagikan kueri kepada anggota project Google Cloud lainnya, tentukan nilai SHARED di kolom visibility.

Lihat kueri tersimpan

Anda dapat melihat kueri pribadi dan kueri yang dibagikan kepada anggota lain di Google Cloud project dengan mengklik tombol Pustaka kueri:

Konsol

  1. Di konsol Google Cloud , buka halaman Logs Explorer:

    Buka Logs Explorer

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

  2. Pilih Google Cloud project atau Google Cloud resource lain yang lognya ingin Anda lihat.

  3. Klik tombol Pustaka kueri, lalu klik Tersimpan.

Anda dapat mengurutkan tabel berdasarkan header apa pun. Kolom Visibilitas menunjukkan apakah kueri dibagikan atau bersifat pribadi:

  • Dibagikan: Kueri yang dibagikan kepada anggota project Google Cloud lainnya.
  • Pribadi: Kueri yang telah Anda simpan dan hanya dapat dilihat oleh Anda.

API

Anda dapat menggunakan Logging API untuk melihat kueri pribadi dan bersama dengan menggunakan metode savedQueries.list.

Misalnya, isi permintaan berikut mencantumkan semua kueri Logs Explorer bersama dengan ID lokasi wildcard:

{
  "parent": "name": projects/PROJECT_ID/locations/-
  "visibility": "SHARED"
  "filter": "explorer"
}

Menggunakan kueri yang disarankan

Logging menghasilkan saran kueri berdasarkan konteksGoogle Cloud project Anda, seperti Google Cloud produk yang Anda gunakan. Kueri yang disarankan dapat membantu Anda mengidentifikasi masalah dan memberikan insight tentang kondisi keseluruhan sistem Anda. Misalnya, mendeteksi bahwa Anda menggunakan Google Kubernetes Engine, Logging dapat menyarankan kueri yang menemukan semua log error untuk container Anda.

Untuk melihat dan menjalankan kueri yang disarankan, klik tombol Pustaka kueri, lalu klik Disarankan. Di tab Disarankan, Anda memiliki opsi berikut:

  • Stream: Untuk menjalankan kueri dan mengalirkan hasilnya, pilih opsi ini.
  • Jalankan: Untuk menjalankan kueri, pilih opsi ini.

  • Opsi lainnya: Memungkinkan Anda melihat detail ekspresi kueri dengan opsi untuk menjalankan kueri atau menyimpannya. Anda juga dapat memilih kueri secara langsung untuk mendapatkan opsi ini.

    Untuk meninjau detail kueri yang disarankan, lakukan salah satu hal berikut:

    • Pilih baris kueri.

    • Klik Lainnya lalu pilih Lihat. Dialog Detail kueri akan terbuka.

    Dalam dialog Detail kueri, Anda akan melihat kueri dan opsi untuk Jalankan, Streaming, atau Simpan sebagai:

    • Untuk menyimpan kueri, lakukan hal berikut:

      1. Klik Simpan kueri.
      2. Lengkapi kolom dalam dialog Simpan kueri.

      Kueri yang diedit akan muncul di daftar Tersimpan, tempat Anda dapat memilih untuk menjalankan kueri nanti.

    • Untuk menjalankan kueri sekarang, klik Run. Kueri berjalan dan muncul di kolom editor kueri.

    • Untuk menjalankan kueri sekarang dan mengalirkan hasilnya, klik Streaming.

    • Untuk menutup dialog dan kembali ke daftar kueri yang disarankan, klik Tutup.

Perhatikan perilaku yang diharapkan berikut:

  • Pemuatan halaman berturut-turut mungkin tidak menampilkan kueri yang sama dalam urutan yang sama.
  • Anda mungkin melihat nol kueri yang disarankan.
  • Terkadang, menjalankan kueri yang disarankan akan menampilkan nol log.

Memilih kueri dari library

Logging menyediakan library kueri berdasarkan kasus penggunaan dan produk umum. Google Cloud Kueri ini dapat membantu Anda menemukan log secara efisien selama sesi pemecahan masalah yang mendesak dan menjelajahi log untuk lebih memahami data Logging yang tersedia.

Untuk melihat dan menjalankan kueri library, lakukan hal berikut:

  1. Di konsol Google Cloud , buka halaman Logs Explorer:

    Buka Logs Explorer

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

  2. Pilih Google Cloud project atau Google Cloud resource lain yang lognya ingin Anda lihat.

  3. Klik tombol Query library. Anda melihat kategori kueri yang tersedia dan subset kueri berdasarkan Google Cloud produk. Untuk mempersempit pilihan kueri yang Anda lihat, klik salah satu produk.

    Anda juga dapat menggunakan kolom penelusuran untuk menelusuri kueri yang tersedia menurut kategori, deskripsi, atau konten ekspresi kueri.

  4. Untuk meninjau ekspresi kueri, lakukan salah satu hal berikut:

    a. Klik baris kueri.

    b. Klik Lainnya, lalu pilih Lihat.

  5. Dalam dialog Detail kueri, Anda akan melihat kueri dan opsi untuk Jalankan, Streaming, atau Simpan sebagai:

    • Untuk menyimpan kueri, lakukan hal berikut:

      1. Klik Simpan kueri.
      2. Lengkapi kolom dalam dialog Simpan kueri.

      Kueri yang diedit akan muncul di daftar Tersimpan, tempat Anda dapat memilih untuk menjalankan kueri nanti.

    • Untuk menjalankan kueri sekarang, klik Run. Kueri berjalan dan muncul di kolom editor kueri.

    • Untuk menjalankan kueri sekarang dan mengalirkan hasilnya, klik Streaming.

    • Untuk menutup dialog dan kembali ke daftar kueri yang disarankan, klik Tutup.

Langkah berikutnya