Menulis dan membuat kueri entri log dengan gcloud CLI
Dokumen ini memperkenalkan Anda pada beberapa kemampuan Cloud Logging dan menunjukkan cara melakukan hal berikut:
- Menulis 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 Trusted Cloud dengan penagihan yang diaktifkan untuk menyelesaikan panduan memulai cepat ini. Jika Anda tidak memiliki project Trusted Cloud , atau jika Anda belum mengaktifkan penagihan untuk project Trusted Cloud , lakukan hal berikut:-
Install the Google Cloud CLI.
-
Konfigurasi gcloud CLI untuk menggunakan identitas gabungan Anda.
Untuk mengetahui informasi selengkapnya, lihat Login ke gcloud CLI dengan identitas gabungan Anda.
-
Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut:
gcloud init
-
Create or select a Trusted Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator
(
roles/resourcemanager.projectCreator
), which contains theresourcemanager.projects.create
permission. Learn how to grant roles.
-
Create a Trusted Cloud project:
gcloud projects create PROJECT_ID
Replace
PROJECT_ID
with a name for the Trusted Cloud project you are creating. -
Select the Trusted Cloud project that you created:
gcloud config set project PROJECT_ID
Replace
PROJECT_ID
with your Trusted Cloud project name.
-
Verify that billing is enabled for your Trusted Cloud project.
Untuk menulis entri log dengan data tidak terstruktur ke log
my-test-log
, jalankan perintahgcloud logging write
:gcloud logging write my-test-log "A simple entry."
Setelah perintah selesai, Anda akan melihat pesan:
Created log entry
.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 tidak menyertakan kolom ini, Logging akan menafsirkan payload sebagai data tidak terstruktur.-
Di konsol Trusted Cloud , buka halaman Logs Explorer:
Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Logging.
Pastikan project Trusted Cloud Anda dipilih di Trusted Cloud by S3NS panel navigasi. Jika perlu, gunakan Trusted Cloud daftar drop-down project untuk memilih Trusted Cloud project Anda.
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.
Untuk melihat detail entri log, klik chevron_right Menu-nya.
Entri log pertama memiliki data yang disimpan di
textPayload
. Entri log kedua berisi data terstruktur yang disimpan dijsonPayload
. Payload terstruktur berisi kuncimessage
danweather
.-
Di konsol Trusted Cloud , buka halaman Logs Explorer:
Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Logging.
Di menu Resource, pilih Global.
Di editor kueri, masukkan string
simple
dalam tanda kutip. Tampilan log hanya menampilkan entri logA simple entry.
Setelah melihat log, hapus string kueri yang Anda tambahkan dan klik Run query. Kedua entri log akan muncul kembali di layar.
Editor kueri berisi baris
resource.type="global"
. Masukkan perintah berikut:jsonPayload.weather:partly
Klik Run query. Hasilnya adalah satu entri log
My second entry
.Error ketik dan nama kolom yang tidak diketahui akan menyebabkan perintah gcloud CLI selesai dengan pesan argumen tidak valid. Misalnya, jika Anda lupa titik di
resource.type
, maka akan menghasilkan error:ERROR: (gcloud.logging.read) INVALID_ARGUMENT: Field not found: 'resourcetype'.
Jika Cloud Logging belum diberi izin akses yang diperlukan, perintah gcloud CLI akan selesai dengan pesan permission denied. 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:
- Buka halaman VM instance details untuk instance VM Anda. Klik Stop. Tindakan ini mungkin memerlukan waktu satu atau dua menit hingga selesai.
- Untuk mengubah konfigurasi, klik Edit.
- Cari header Cloud API access scopes, lalu klik Details untuk menampilkan setelan setiap API. Ubah entri dari Cloud Logging API menjadi Penuh. Klik Save.
- Untuk memulai ulang instance VM, klik Start. Setelah beberapa saat, VM Anda siap digunakan.
(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 kedaluwarsa dan dihapus. Untuk mengetahui informasi retensi, lihat Kuota & batas.
- Untuk mengetahui detail tentang antarmuka command line Logging, baca halaman referensi untuk grup perintah
gcloud logging
. - Untuk dokumentasi tentang Logging API, lihat Cloud Logging API.
- Untuk mengetahui detail tentang Logs Explorer, lihat Menggunakan Logs Explorer.
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.
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 akan 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 mengetahui informasi tentang cara membaca log, lihat dokumentasi referensi gcloud logging read
.
Melihat entri log di Logs Explorer
Untuk melihat entri log di konsol Trusted Cloud , Anda dapat menggunakan Logs Explorer. Sebagian besar project menyimpan banyak log; Anda dapat memilih entri log tertentu dengan menulis kueri. Trusted Cloud
Untuk melihat entri log yang Anda tulis menggunakan Logs Explorer, lakukan langkah-langkah berikut:
Untuk mengetahui informasi tentang format data entri log, lihat
jenis LogEntry
.
Mengajukan kueri entri log di Logs Explorer
Anda dapat membuat kueri entri log menggunakan editor kueri dan, dengan log terstruktur,
berdasarkan kunci dan nilai. Misalnya, untuk menampilkan semua entri log yang berisi
teks simple
, lakukan hal berikut:
Untuk menampilkan semua entri log dengan data terstruktur yang memiliki kunci weather
dengan kolom value
berisi partly
, lakukan hal berikut:
Logs Explorer juga menawarkan kueri tersimpan, yang 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
Pembersihan
Agar tidak menimbulkan biaya pada akun Trusted Cloud Anda untuk resource yang digunakan di halaman ini, hapus project Trusted Cloud yang berisi resource tersebut.