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 membuat pilihan dari menu filter menggunakan opsi yang disertakan dengan entri log. 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

  • Untuk mendapatkan izin yang diperlukan guna membaca data log untuk membuat kueri, menggunakan kueri tersimpan pribadi, atau mencantumkan dan mendapatkan kueri bersama, minta administrator untuk memberi Anda peran IAM Logs Viewer (roles/logging.viewer) di project Anda.

    Peran bawaan ini berisi izin yang diperlukan untuk membaca data log guna membuat kueri, menggunakan kueri tersimpan pribadi, atau mencantumkan dan mendapatkan kueri bersama. Untuk melihat izin yang benar-benar diperlukan, luaskan bagian Izin yang diperlukan:

    Izin yang diperlukan

    Izin berikut diperlukan untuk membaca data log guna membuat kueri, menggunakan kueri tersimpan pribadi, atau untuk mencantumkan dan mendapatkan kueri bersama:

    • Menggunakan kueri tersimpan pribadi: logging.queries.usePrivate
    • Mencantumkan dan mendapatkan kueri yang dibagikan:
      • logging.queries.listShared
      • logging.queries.getShared

  • Untuk mendapatkan izin yang diperlukan guna membuat, memperbarui, dan menghapus kueri bersama, minta administrator untuk memberi Anda peran IAM Logging Admin (roles/logging.admin) di project Anda.

    Peran bawaan ini berisi izin yang diperlukan untuk membuat, memperbarui, dan menghapus kueri bersama. Untuk melihat izin yang benar-benar diperlukan, luaskan bagian Izin yang diperlukan:

    Izin yang diperlukan

    Izin berikut diperlukan untuk membuat, memperbarui, dan menghapus kueri bersama:

    • logging.queries.share
    • logging.queries.updateShared
    • logging.queries.deleteShared

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

Membuat 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 project Google Cloud atau resource Google Cloud lainnya yang lognya ingin Anda lihat.

  3. Gunakan panel Kueri untuk membuat kueri.

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

    • Telusuri 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 Library 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 panel Kueri.

Anda dapat menelusuri kata dan frasa, dan istilah penelusuran Anda dapat menyertakan 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 petik 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, gabungkan frasa dalam tanda petik terbalik.

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

  • Untuk melakukan penelusuran substring yang tidak peka huruf besar/kecil, gabungkan 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 Show query.

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

Operator Boolean

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

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 membuat aturan bertingkat. Tanda kurung apa pun dalam ekspresi penelusuran akan diuraikan sebagai istilah penelusuran.
  • Anda harus menggunakan huruf kapital untuk operator Boolean. and, or, dan not dalam 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, saat kedua operator dicampur, 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 dengan OR dan AND dalam urutan tersebut.

Operator NOT melakukan negasi dari 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 resource, nama log, tingkat keparahan log, dan korelasi 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 beberapa label resource yang akan 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 logis OR akan digunakan.
  • Keparahan: Memungkinkan Anda menentukan keparahan. Anda dapat memilih beberapa tingkat keparahan secara bersamaan untuk ditambahkan dan diterapkan ke kueri Anda. Saat memilih beberapa tingkat keparahan, operator logika OR akan digunakan.
  • Korelasikan menurut: Memungkinkan Anda mengelompokkan dan melihat entri log dalam format "induk-turunan". Untuk mengetahui informasi selengkapnya, lihat Mengaitkan entri log.

Untuk menggunakan menu filter, lakukan tindakan berikut:

  1. Luaskan Menu di menu filter mana pun 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 Show query.

  4. Setelah meninjau kueri, klik Run query. 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 VM ID. Nama resource membantu Anda mengidentifikasi ID resource yang benar, tempat Anda dapat 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 waktu berakhir kustom, atau memusatkan rentang waktu di sekitar stempel waktu tertentu menggunakan pemilih rentang waktu. Misalnya, jika Anda ingin melihat data selama seminggu terakhir, pilih 1 minggu terakhir dari pemilih rentang waktu.

Anda juga dapat menetapkan 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, kueri tersebut akan 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 Kueri, aktifkan Show query.

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

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

  3. Setelah meninjau kueri, klik Jalankan kueri.

    Log yang cocok dengan kueri Anda akan tercantum di bagian panel Query results. Panel Histogram dan Kolom log juga disesuaikan sesuai dengan ekspresi kueri.

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

Menggunakan kueri terbaru

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

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

  • Streaming: Untuk menjalankan kueri dan memutar streaming hasilnya, pilih opsi ini.
  • Run: 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 juga dapat memilih kueri secara langsung untuk mendapatkan opsi ini.

    Untuk menyimpan kueri, lakukan hal berikut:

    1. Klik Simpan. Dialog Save query 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 ditampilkan.
      • Pemangkasan kolom ringkasan (Opsional): Aktifkan Pemangkasan 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 Library 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 menjadi milik 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.
    • Pemangkasan kolom ringkasan (Opsional): Aktifkan Pemangkasan kolom ringkasan dan pilih jumlah karakter yang akan dipangkas dan apakah pemangkasan terjadi di awal atau akhir kolom.
    • Bagikan ke project: Secara opsional, aktifkan Bagikan ke project untuk membagikan kueri Anda kepada anggota project Google Cloud lainnya.

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

Untuk menjalankan kueri tersimpan, klik Run. Untuk menjalankan kueri dan memutar hasilnya, klik Streaming.

Untuk mengubah kueri tersimpan, pilih More options, lalu pilih Edit. Anda juga dapat memilih kueri, melakukan perubahan, lalu menyimpan kueri yang diubah.

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

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

API

Untuk menyimpan kueri menggunakan Logging API, gunakan metode savedQueries.create. Untuk 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 dalam project Google Cloud dengan mengklik tombol Library 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 project Google Cloud atau resource Google Cloud lainnya yang lognya ingin Anda lihat.

  3. Klik tombol Koleksi kueri, lalu klik Tersimpan.

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

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

API

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

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

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

Menggunakan kueri yang disarankan

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

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

  • Streaming: Untuk menjalankan kueri dan memutar streaming hasilnya, pilih opsi ini.
  • Run: 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 tindakan berikut:

    • Pilih baris kueri.

    • Klik Lainnya dan pilih Lihat. Dialog Query details 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 di dialog Save query.

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

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

    • Untuk menjalankan kueri sekarang dan memutar 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 tidak melihat kueri yang disarankan.
  • Terkadang, menjalankan kueri yang disarankan tidak menampilkan log.

Memilih kueri dari library

Logging menyediakan library kueri berdasarkan kasus penggunaan umum dan produk 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 project Google Cloud atau resource Google Cloud lainnya yang log-nya ingin Anda lihat.

  3. Klik tombol Query library. Anda akan melihat kategori kueri yang tersedia dan subkumpulan kueri berdasarkan produk Google Cloud. 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 tindakan 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 di dialog Save query.

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

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

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

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

Langkah selanjutnya