Membuat log log akses Apigee

Halaman ini berlaku untuk Apigee, tetapi tidak untuk Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Pratinjau

Produk atau fitur ini tunduk pada "Persyaratan Penawaran Pra-GA" di bagian Persyaratan Layanan Umum di Persyaratan Khusus Layanan. Produk dan fitur pra-GA tersedia "sebagaimana adanya" dan mungkin memiliki dukungan terbatas. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.

Pelanggan Apigee dan Pelanggan Bayar sesuai penggunaan dapat mengaktifkan log akses masuk Cloud Logging untuk setiap instance Apigee di organisasi mereka. Setelah diaktifkan, fitur ini dapat Anda gunakan untuk melihat log yang dihasilkan oleh gateway masuk dalam infrastruktur Apigee, seperti Load Balancer Aplikasi eksternal atau gateway Anthos, untuk membantu memecahkan masalah panggilan API Apigee.

Penting untuk diperhatikan bahwa jika fitur ini diaktifkan untuk satu atau beberapa instance Apigee, Anda akan ditagih untuk log yang dikirimkan ke project Anda. Untuk mengetahui informasi lebih lanjut tentang biaya logging Google Cloud, lihat harga Cloud Logging.

Topik ini menjelaskan bagaimana pelanggan Apigee dapat mengaktifkan dan menggunakan log akses masuk Cloud Logging untuk instance Apigee di organisasi mereka.

Sebelum memulai

Untuk mengaktifkan fitur ini, Anda harus memiliki peran dan izin berikut:

• Peran: Admin Organisasi Apigee (roles/apigee.admin)
• Izin:
  • apigee.instances.create
  • apigee.instances.update

Memeriksa peran

1. Di konsol Google Cloud, buka halaman IAM.

   Buka IAM
2. Pilih project.

3. Di kolom Akun utama, cari baris yang berisi alamat email Anda.

   Jika alamat email Anda tidak ada di kolom tersebut, berarti Anda tidak memiliki peran apa pun.

4. Di kolom Peran untuk baris yang berisi alamat email Anda, periksa apakah daftar peran berisi peran yang diperlukan.

Memberikan peran

1. Di konsol Google Cloud, buka halaman IAM.

   Buka IAM
2. Pilih project.
3. Klik Berikan akses.
4. Di kolom Akun utama baru, masukkan alamat email Anda.
5. Di daftar Pilih peran, pilih peran.
6. Untuk memberikan peran tambahan, klik Tambahkan peran lain, lalu tambahkan setiap peran tambahan.
7. Klik Simpan.

Mengaktifkan logging akses masuk untuk instance Apigee Anda

Anda dapat mengaktifkan logging akses masuk Cloud Logging saat membuat atau mengedit instance Apigee menggunakan UI Apigee di Konsol Cloud atau API.

Untuk mengaktifkan fitur tersebut saat membuat atau mengupdate instance Apigee, ikuti petunjuk dalam Mengelola instance untuk mulai membuat atau mengedit instance.

Apigee di Konsol Cloud

Di bagian Logging di halaman Create an instance atau Edit instance:

1. Klik tombol Enable logging untuk mengaktifkan fitur tersebut.
2. Secara opsional, pilih kode respons HTTP dari kotak response code agar berfungsi sebagai filter untuk log akses.

   Jika Anda ingin menyertakan semua log, apa pun kode respons HTTP, pilih None (all HTTP responses).

   Untuk membuat filter kustom, pilih Custom, lalu masukkan filter dalam format berikut:

   status_code > XX && status code <= YY

   Contoh:

   status_code >= 500 && status_code < 504

3. Setelah memberikan semua informasi yang diperlukan untuk membuat atau mengedit instance Anda, klik Save.

API Apigee

Untuk mengupdate instance yang ada menggunakan Apigee API, gunakan perintah berikut:

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/instances/INSTANCE_NAME?updateMask=access_logging_config.enabled,access_logging_config.filter" \
    -X PATCH -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' -H 'Content-Type: application/json' \
    -d '{
      "name": "INSTANCE_NAME",
      "accessLoggingConfig":
        {
          "enabled": "true",
          "filter": "status_code >= 0 && status_code < 600 "
        }
      }'

Dengan keterangan:

• ORG_NAME adalah nama organisasi Apigee Anda.
• INSTANCE_NAME adalah nama instance Apigee yang ingin Anda edit.

Perhatikan bahwa dalam perintah ini, nilai yang ditentukan untuk properti filter akan menampilkan semua log. Jika ingin memfilter log berdasarkan HTTP atau kode status lainnya, Anda dapat menyesuaikan nilai filter.

Setelah instance berhasil dibuat atau diupdate, log akses masuk untuk instance tersebut akan tersedia di project Anda dalam hitungan menit.

Melihat log akses masuk

Setelah fitur ini diaktifkan, Anda dapat melihat log akses masuk untuk instance di project Anda dalam hitungan menit menggunakan Logs Explorer di Konsol Google Cloud.

Untuk melihat entri log di Logs Explorer:

1. Di konsol Google Cloud, pilih Logging > Logs Explorer.

   Buka Logs Explorer

2. Pastikan project Google Cloud Anda dipilih.
3. Dari tab Query, masukkan nama log ke kolom editor Query menggunakan salah satu metode berikut:
   • Untuk menggunakan kotak pilihan Log name:
     1. Klik kotak pilihan Log name untuk membuka panel Log name.
     2. Masukkan ingress_instance di kotak Select log names.
     3. Klik Apply.
     4. Nama log akan muncul di kolom editor Query.
   • Di kolom editor Query, masukkan nama log secara langsung:

     logName="projects/ORG_NAME/logs/apigee.googleapis.com/ingress_instance"

4. Bangun kueri lainnya di kolom editor Query. Log akan muncul di daftar Query results.
5. Klik entri log untuk mengetahui detail selengkapnya.

Pemecahan masalah dengan log akses masuk

Setelah fitur ini diaktifkan dan log tersedia di Logs Explorer, Anda dapat memanfaatkan sejumlah fitur Cloud Logging untuk membantu pemecahan masalah, termasuk:

• Membangun kueri menggunakan bahasa kueri Cloud Logging

  Anda dapat mengambil dan menganalisis log saat menggunakan Logs Explorer dengan menulis kueri di kolom query-editor dan dengan membuat pilihan dari opsi menu filter yang disertakan dengan entri log. Untuk mempelajari lebih lanjut cara membangun kueri dan menganalisis data di Logs Explorer, lihat Membangun dan menyimpan kueri menggunakan bahasa kueri Cloud Logging.

• Mengaktifkan metrik dan pemberitahuan berbasis log

  Anda dapat menentukan metrik berbasis log sendiri untuk mengambil informasi khusus untuk instance Apigee Anda. Untuk mengetahui informasi selengkapnya, lihat Ringkasan metrik berbasis log.

  Anda dapat membuat kebijakan pemberitahuan berbasis log dari Logs Explorer. Untuk mengetahui informasi selengkapnya dan langkah-langkah mendetail, lihat Membuat kebijakan pemberitahuan berbasis log menggunakan Logs Explorer.

• Memfilter menurut kode status HTTP

  Anda dapat menyaring kueri di Logs Explorer untuk memfilter menurut kode status HTTP, meskipun Anda tidak memilih untuk memfilter log akses masuk menurut kode status HTTP saat mengaktifkan fitur tersebut. Untuk menambahkan filter ini ke kueri Anda, gunakan format berikut:

  status_code > XX && status code <= YY

  Contoh:

  status_code >= 500 && status_code < 504

• Pemfilteran menurut kode status masuk

  Selain memfilter menurut kode status HTTP, Anda dapat membuat kueri untuk memfilter ingress status_code 0. Kode ini sering menunjukkan masalah jaringan atau konektivitas yang mencegah klien menerima respons server.

Untuk mendapatkan penjelasan mendetail tentang semua fungsi yang tersedia di Logs Explorer, lihat Melihat log menggunakan Logs Explorer.

Nonaktifkan fitur

Setelah selesai memecahkan masalah instance Apigee, Anda dapat mengedit instance tersebut untuk menonaktifkan fitur tersebut. Menonaktifkan fitur ini akan menonaktifkan akses ke log ingress_instance dalam project Anda dan akan menghentikan penagihan.

Anda dapat mengedit instance untuk menonaktifkan fitur ini menggunakan UI Apigee di Konsol Cloud atau API.

Apigee di Konsol Cloud

Untuk menonaktifkan fitur ini menggunakan Apigee di Konsol Cloud:

Buka UI Apigee di Konsol Cloud pada browser Anda.

Pilih Pengelolaan > Instance.

Klik instance yang ingin diedit.

Di halaman Detail instance, klik Edit.

Di halaman Edit Instance, klik tombol Enable logging untuk menonaktifkan fitur.

Klik Simpan.

API Apigee

Gunakan perintah berikut untuk menonaktifkan fitur di instance Anda:

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/instances/INSTANCE_NAME?updateMask=access_logging_config.enabled,access_logging_config.filter" \
    -X PATCH -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' -H 'Content-Type: application/json' \
    -d '{
      "name": "INSTANCE_NAME",
      "accessLoggingConfig":
        {
            "enabled": "false"
        }
        }'

Dengan keterangan:

• ORG_NAME adalah nama organisasi Apigee Anda.
• INSTANCE_NAME adalah nama instance Apigee yang ingin Anda edit.