Menyiapkan Cloud Logging untuk Python

Anda dapat menulis log ke Cloud Logging dari aplikasi Python dengan menggunakan pengendali logging Python standar, atau dengan menggunakan library klien Cloud Logging API untuk Python secara langsung. Saat menggunakan pengendali logging Python standar, Anda harus memasang pengendali Cloud Logging ke pengendali root Python. Dokumen ini mengilustrasikan pendekatan tersebut.

Sebelum memulai

  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. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

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

  4. Enable the Cloud Logging API.

    Enable the API

    5.

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

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

  7. Enable the Cloud Logging API.

    Enable the API

    8.
  8. Siapkan lingkungan Anda untuk pengembangan Python.

    Buka panduan penyiapan Python

Menginstal library

Untuk menginstal library Cloud Logging untuk Python, lihat Menginstal library klien untuk Python. Library ini memungkinkan Anda memasang pengendali Cloud Logging ke pengendali root Python standar. Anda juga dapat menggunakan library ini untuk mengirim permintaan API ke Cloud Logging.

Untuk informasi selengkapnya tentang penginstalan, lihat dokumentasi untuk library Cloud Logging untuk Python. Anda juga dapat melaporkan masalah menggunakan issue tracker.

Menulis log dengan pengendali logging Python standar

Untuk mengirim semua entri log yang ditulis dengan pengendali root Python standar ke Cloud Logging, lakukan tindakan berikut:

  1. Pasang pengendali Cloud Logging ke logger root Python dengan memanggil metode setup_logging:

    # Imports the Cloud Logging client library
import google.cloud.logging

# Instantiates a client
client = google.cloud.logging.Client()

# Retrieves a Cloud Logging handler based on the environment
# you're running in and integrates the handler with the
# Python logging module. By default this captures all logs
# at INFO level and higher
client.setup_logging()

    Untuk mengetahui informasi tentang cara mengonfigurasi pengendali logging, lihat Integrasi dengan Library Standar logging.

    Untuk mengetahui informasi tentang parameter ke fungsi setup_logging, buka Klien Cloud Logging dan telusuri setup_logging. Misalnya, halaman ini menjelaskan cara mengonfigurasi level logging.

  2. Tulis data log menggunakan logger root Python:

    # Imports Python standard library logging
import logging

# The data to log
text = "Hello, world!"

# Emits the data using the standard logging module
logging.warning(text)

    Secara default, setiap log dengan level keparahan minimal INFO yang ditulis oleh aplikasi Anda akan dikirim ke Cloud Logging.

    Jika pesan dicatat ke Logging dari App Engine atau Google Kubernetes Engine, pengendali akan mengirimkannya ke jenis resource masing-masing lingkungan tersebut. Jika tidak, log akan tercantum di bagian log python dalam jenis resource Global.

Menulis log dengan library klien Cloud Logging

Untuk informasi tentang cara menggunakan library klien Cloud Logging untuk Python secara langsung, lihat Library Klien Cloud Logging.

Menjalankan di Google Cloud

Agar aplikasi dapat menulis log menggunakan library Cloud Logging untuk Python, akun layanan untuk resource pokok harus memiliki peran IAM Logs Writer (roles/logging.logWriter). Sebagian besar lingkungan Google Cloud secara otomatis mengonfigurasi akun layanan default agar memiliki peran ini.

App Engine

Cloud Logging otomatis diaktifkan untuk App Engine, dan akun layanan default aplikasi Anda memiliki izin IAM secara default untuk menulis entri log.

Untuk informasi selengkapnya, lihat Menulis dan melihat log.

Google Kubernetes Engine (GKE)

GKE secara otomatis memberikan peran IAM Logs Writer (roles/logging.logWriter) ke akun layanan default. Jika Anda menggunakan Workload Identity Federation untuk GKE dengan akun layanan default ini untuk mengizinkan workload mengakses Google Cloud API tertentu, konfigurasi tambahan tidak diperlukan. Namun, jika Anda menggunakan Workload Identity Federation untuk GKE dengan akun layanan IAM kustom, pastikan akun layanan kustom tersebut memiliki peran Logs Writer (roles/logging.logWriter).

Jika diperlukan, Anda juga dapat menggunakan perintah berikut untuk menambahkan cakupan akses logging.write saat membuat cluster:

gcloud container clusters create example-cluster-name \
    --scopes https://www.googleapis.com/auth/logging.write

Compute Engine

Saat menggunakan instance VM Compute Engine, tambahkan cakupan akses cloud-platform ke setiap instance. Saat membuat instance baru melalui konsol Google Cloud, Anda dapat melakukannya di bagian Akses identitas dan API pada panel Buat Instance. Gunakan akun layanan default Compute Engine atau akun layanan lain pilihan Anda, lalu pilih Allow full access to all Cloud APIs di bagian Identity and API access. Akun layanan mana pun yang Anda pilih, pastikan akun tersebut telah diberi peran Logs Writer di bagian IAM & Admin di konsol Google Cloud.

Menjalankan secara lokal dan di tempat lain

Untuk menggunakan library Cloud Logging untuk Python di luar Google Cloud, termasuk menjalankan library di workstation Anda sendiri, di komputer pusat data, atau di instance VM dari penyedia cloud lain, Anda harus menyediakan ID project Google Cloud dan kredensial akun layanan yang sesuai langsung ke library Cloud Logging untuk Python.

Untuk akun layanan yang ada, lakukan langkah berikut:

  1. Berikan peran IAM Logs Writer (roles/logging.logWriter) kepada akun layanan. Untuk informasi selengkapnya tentang peran IAM, lihat Kontrol akses.

  2. Siapkan Kredensial Default Aplikasi.

Jika Anda tidak memiliki akun layanan, buat akun layanan. Untuk mengetahui informasi tentang proses ini, lihat Membuat akun layanan.

Untuk informasi umum tentang metode yang dapat Anda gunakan untuk melakukan autentikasi, lihat Istilah: akun layanan.

Melihat log

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.

Di Logs Explorer, Anda harus menentukan satu atau beberapa resource, tetapi pemilihan resource mungkin tidak jelas. Berikut beberapa tips untuk membantu Anda memulai:

  • Jika Anda men-deploy aplikasi ke App Engine atau menggunakan library khusus App Engine, tetapkan resource Anda ke Aplikasi GAE.

  • Jika Anda men-deploy aplikasi di Compute Engine, tetapkan resource ke Instance VM GCE.

  • Jika Anda men-deploy aplikasi di Google Kubernetes Engine, konfigurasi logging cluster akan menentukan jenis resource entri log. Untuk diskusi mendetail tentang solusi Google Cloud Observability Lama dan Google Cloud Observability Kubernetes Monitoring, serta pengaruh opsi tersebut terhadap jenis resource, lihat Bermigrasi ke Google Cloud Observability Kubernetes Monitoring.

  • Jika aplikasi Anda menggunakan Cloud Logging API secara langsung, resource akan bergantung pada API dan konfigurasi Anda. Misalnya, dalam aplikasi, Anda dapat menentukan resource atau menggunakan resource default.

  • Jika Anda tidak melihat log apa pun di Logs Explorer, untuk melihat semua entri log, beralihlah ke mode kueri lanjutan dan gunakan kueri kosong.

    1. Untuk beralih ke mode kueri lanjutan, klik menu (▾) di bagian atas Logs Explorer, lalu pilih Konversikan ke filter lanjutan.
    2. Hapus konten yang muncul di kotak filter.
    3. Klik Kirim Filter.

    Anda dapat memeriksa setiap entri untuk mengidentifikasi resource Anda.

Untuk informasi tambahan, lihat Menggunakan Logs Explorer.