Menulis dan membuat kueri entri log dengan gcloud CLI

Dokumen ini memperkenalkan beberapa kemampuan Cloud Logging dan menunjukkan cara melakukan hal berikut:

  • Tulis entri log menggunakan Google Cloud CLI.
  • Mencantumkan entri log menggunakan gcloud CLI.
  • Mencantumkan entri log menggunakan Logging API.
  • Melihat dan membuat kueri entri log menggunakan Logs Explorer.

Sebelum memulai

Anda harus memiliki project Google Cloud dengan penagihan yang diaktifkan untuk menyelesaikan panduan memulai ini. Jika Anda tidak memiliki project Google Cloud, atau jika Anda tidak mengaktifkan penagihan untuk project Google Cloud, lakukan tindakan berikut:

  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. Install the Google Cloud CLI.

  3. To initialize the gcloud CLI, run the following command: 

    gcloud init

  4. Create or select a Google Cloud project.

    • Create a Google Cloud project:

      gcloud projects create PROJECT_ID

      Replace PROJECT_ID with a name for the Google Cloud project you are creating.

    • Select the Google Cloud project that you created:

      gcloud config set project PROJECT_ID

      Replace PROJECT_ID with your Google Cloud project name.

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

  6. Install the Google Cloud CLI.

  7. To initialize the gcloud CLI, run the following command: 

    gcloud init

  8. Create or select a Google Cloud project.

    • Create a Google Cloud project:

      gcloud projects create PROJECT_ID

      Replace PROJECT_ID with a name for the Google Cloud project you are creating.

    • Select the Google Cloud project that you created:

      gcloud config set project PROJECT_ID

      Replace PROJECT_ID with your Google Cloud project name.

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

Menulis entri log menggunakan gcloud CLI

Logging mendukung entri log dengan data terstruktur dan tidak terstruktur. Data terstruktur terdiri dari struktur data JSON; misalnya, {"weather": "partly cloudy"}. Data tidak terstruktur adalah string karakter; misalnya, "A simple entry".

Pada langkah berikutnya, Anda akan menggunakan gcloud CLI untuk menulis entri log dengan data tidak terstruktur dan entri log dengan data terstruktur. Gcloud CLI menyediakan antarmuka command line ke Cloud Logging API.

  1. Tulis entri log dengan data tidak terstruktur ke log my-test-log, jalankan perintah gcloud logging write:

    gcloud logging write my-test-log "A simple entry."

    Setelah perintah selesai, Anda akan melihat pesan: Created log entry.

  2. Tulis entri log dengan data terstruktur ke log my-test-log:

    gcloud logging write --payload-type=json my-test-log '{ "message": "My second entry", "weather": "partly cloudy"}'

    Saat menulis entri log dengan data terstruktur, Anda harus menyertakan --payload-type=json. Jika Anda menghilangkan kolom ini, Logging akan menafsirkan payload sebagai data tidak terstruktur.

Jika log my-test-log tidak ada, Logging akan membuat log saat entri log diterima.

Mencantumkan entri log menggunakan gcloud CLI

Anda dapat mengambil entri log dari Logging dan menampilkannya menggunakan gcloud CLI. Misalnya, untuk mengambil dan menampilkan entri log dengan jenis resource global, jalankan perintah berikut:

gcloud logging read "resource.type=global"

Perintah ini menampilkan hasil yang mirip dengan berikut ini:

---
insertId: jpj9zjf73t1mn
jsonPayload:
  message: My second entry
  weather: partly cloudy
logName: projects/myloggingproject/logs/my-test-log
receiveTimestamp: '2018-11-01T18:39:31.114507977Z'
resource:
  labels:
    project_id: myloggingproject
  type: global
timestamp: '2018-11-01T18:39:31.114507977Z'
---
insertId: vd4m1if7h7u1a
logName: projects/myloggingproject/logs/my-test-log
receiveTimestamp: '2018-11-01T18:39:19.718100792Z'
resource:
  labels:
    project_id: myloggingproject
  type: global
textPayload: A simple entry
timestamp: '2018-11-01T18:39:19.718100792Z'

Untuk informasi tentang cara membaca log, lihat dokumentasi referensi gcloud logging read.

Mencantumkan entri log menggunakan API Explorer

Untuk menjalankan metode Logging API tanpa menulis kode apa pun, lihat Menggunakan API Explorer. Untuk membaca daftar entri log dari Logging, lakukan hal berikut:

  1. Buka halaman referensi API untuk metode API entries.list:

    Buka halaman API entries.list

  2. Konfigurasikan dan jalankan perintah API:

    1. Ganti PROJECT_ID dalam teks berikut:

      "resourceNames": [
"projects/PROJECT_ID"
],
"filter": "resource.type=global",
"orderBy": "timestamp desc"

    2. Salin teks yang telah diperbarui dari langkah sebelumnya, lalu tempelkan ke kolom Isi permintaan di API Explorer.

    3. Klik Jalankan.

    Metode ini menampilkan respons yang mirip dengan berikut ini:

    {
  "entries": [
    {
      "textPayload": "A simple entry",
      "insertId": "vd4m1if7h7u1a",
      "resource": {
        "type": "global",
        "labels": {
          "project_id": "myloggingproject"
        }
      },
      "timestamp": "2018-11-01T18:39:19.718100792Z",
      "logName": "projects/myloggingproject/logs/my-test-log",
      "receiveTimestamp": "2018-11-01T18:39:19.718100792Z"
    },
    {
      "insertId": "jpj9zjf73t1mn",
      "jsonPayload": {
        "message": "My second entry",
        "weather": "partly cloudy"
      },
      "resource": {
        "type": "global",
        "labels": {
          "project_id": "myloggingproject"
        }
      },
      "timestamp": "2018-11-01T18:39:31.114507977Z",
      "logName": "projects/myloggingproject/logs/my-test-log",
      "receiveTimestamp": "2018-11-01T18:39:31.114507977Z"
    }
  ]
}

Melihat entri log di Logs Explorer

Untuk melihat entri log di konsol Google Cloud, Anda dapat menggunakan Logs Explorer. Sebagian besar project Google Cloud menyimpan log dalam jumlah besar; Anda dapat memilih entri log tertentu dengan menulis kueri.

Untuk melihat entri log yang Anda tulis menggunakan Logs Explorer, lakukan langkah 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.

    Pastikan project Google Cloud Anda dipilih di menu navigasi Google Cloud. Jika perlu, gunakan daftar drop-down project Google Cloud untuk memilih project Google Cloud Anda.

  2. Di menu Resource, pilih Global.

    Jika Anda tidak melihat opsi menu Global atau jika Anda tidak melihat entri log, tunggu beberapa menit, lalu muat ulang halaman. Mungkin perlu waktu beberapa menit agar Logging menerima entri log.

  3. Untuk melihat detail entri log, klik Menu.

    Data entri log pertama disimpan di textPayload. Entri log kedua berisi data terstruktur yang disimpan di jsonPayload. Payload terstruktur berisi kunci message dan weather.

Untuk mengetahui informasi tentang format data entri log, lihat jenis LogEntry.

Membuat kueri entri log di Logs Explorer

Anda dapat membuat kueri entri log menggunakan editor kueri dan, dengan log terstruktur, menggunakan kunci dan nilai. Misalnya, untuk menampilkan semua entri log yang berisi simple teks, 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. Di menu Resource, pilih Global.

  3. Di editor kueri, masukkan string simple dalam tanda kutip. Tampilan log hanya menampilkan entri log A simple entry.

  4. Setelah melihat log, hapus string kueri yang Anda tambahkan, lalu klik Jalankan kueri. Kedua entri log akan muncul kembali di layar.

Untuk menampilkan semua entri log dengan data terstruktur yang memiliki kunci weather dengan kolom value berisi partly, lakukan hal berikut:

  1. Editor kueri berisi baris resource.type="global". Masukkan perintah berikut:

    jsonPayload.weather:partly

  2. Klik Run query. Hasilnya adalah satu entri log My second entry.

Logs Explorer juga menawarkan kueri tersimpan, disarankan, dan terbaru. Untuk mengetahui informasi selengkapnya tentang kueri, lihat Membuat kueri di Logs Explorer.

Untuk contoh kueri, lihat Contoh kueri menggunakan Logs Explorer.

Pemecahan masalah

  • Error tipografi dan nama kolom yang tidak diketahui menyebabkan perintah gcloud CLI diselesaikan dengan pesan argumen tidak valid. Misalnya, jika Anda lupa titik di resource.type, error akan terjadi:

     ERROR: (gcloud.logging.read) INVALID_ARGUMENT: Field not found: 'resourcetype'.

  • Jika Cloud Logging belum diberi izin akses yang diperlukan, perintah gcloud CLI akan dilengkapi dengan pesan izin ditolak. Misalnya, jika instance VM Compute Engine dikonfigurasi dengan setelan API default, perintah list akan selesai dengan error izin ditolak:

     ERROR: (gcloud.logging.read) PERMISSION_DENIED: Request had insufficient authentication scopes.

    Untuk memperbaiki kondisi ini, ubah izin instance VM Compute Engine Anda untuk memberikan izin baca Cloud Logging dengan melakukan hal berikut:

    1. Buka halaman VM instance details untuk instance VM Anda. Klik Stop. Tindakan ini mungkin memerlukan waktu satu atau dua menit.
    2. Untuk mengubah konfigurasi, klik Edit.
    3. Telusuri header Cloud API access scopes, lalu klik Details untuk menampilkan setelan setiap API. Ubah entri dari Cloud Logging API menjadi Penuh. Klik Save.
    4. Untuk memulai ulang instance VM, klik Start. Setelah beberapa saat, VM Anda siap digunakan.

  • Jika tidak dapat menyelesaikan perintah Anda, atau memerlukan otorisasi tambahan, API Explorer akan menampilkan pesan atau kode error:

    • Kode respons 200 dan tidak ada entri: Jika pesan nextPageToken ditampilkan, hal ini menunjukkan bahwa API Explorer tidak memiliki waktu untuk menyelesaikan penelusuran. Tambahkan pageToken ke permintaan Anda, tetapkan nilai agar sama dengan yang diberikan dengan kunci nextPageToken, lalu coba lagi perintah.
    • Kode respons 400: Nilai kueri tidak valid. Misalnya, jika Anda salah mengeja global sebagai gloobal, pesannya adalah Unsupported resource type: gloobal.
    • Kode respons 404: Project ID tidak valid. Periksa ejaan ID project Anda.
    • Anda mungkin diminta untuk login ke project Google Cloud dan mengizinkan API Explorer mengakses akun Anda.

Pembersihan

Agar tidak menimbulkan biaya pada akun Google Cloud Anda untuk resource yang digunakan pada halaman ini, hapus project Google Cloud yang berisi resource tersebut.

  1. (Opsional) Untuk menghapus entri log yang Anda buat, jalankan perintah gcloud berikut:

    gcloud logging logs delete my-test-log

    Jika Anda tidak menghapus entri log, entri tersebut akan berakhir masa berlakunya dan dihapus. Untuk informasi retensi, lihat Kuota & batas.

Langkah selanjutnya