Melengkapi aplikasi PHP untuk Error Reporting

Mengaktifkan library

Anda dapat mengirim laporan error ke Error Reporting dari aplikasi PHP dengan menggunakan library Error Reporting untuk PHP. Gunakan library Error Reporting untuk PHP guna membuat grup error untuk kasus berikut:

• Bucket log Anda memiliki kunci enkripsi yang dikelola pelanggan (CMEK).
• Bucket log Anda tidak berada di region global.
• Anda ingin melaporkan peristiwa error kustom.

Error Reporting terintegrasi dengan beberapa layanan Google Cloud, seperti App Engine, Compute Engine, dan Google Kubernetes Engine. Error Reporting menampilkan error yang dicatat ke Cloud Logging oleh aplikasi yang berjalan di layanan tersebut. Untuk mengetahui informasi selengkapnya, buka Menjalankan di Google Cloud di halaman ini.

Anda juga dapat mengirim data error ke Error Reporting menggunakan Logging. Untuk mengetahui informasi tentang persyaratan pemformatan data, baca Memformat pesan error di Logging.

Sebelum memulai

1. Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.

2. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

   Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

   Buka pemilih project

3. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

4. Aktifkan Error Reporting API .

   Mengaktifkan API

5. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

   Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

   Buka pemilih project

6. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

7. Aktifkan Error Reporting API .

   Mengaktifkan API

Menginstal library klien

Library Error Reporting untuk PHP memungkinkan Anda memantau dan melihat error yang dilaporkan oleh aplikasi PHP yang berjalan hampir di mana saja.

Untuk informasi lebih lanjut tentang penginstalan, baca dokumentasi untuk library Error Reporting untuk PHP. Anda juga dapat melaporkan masalah menggunakan issue tracker.

Mengonfigurasi library klien

Anda dapat menyesuaikan perilaku library Error Reporting untuk PHP. Lihat konfigurasi library untuk daftar opsi konfigurasi yang memungkinkan.

Menjalankan aplikasi di Google Cloud

Untuk membuat grup error menggunakan projects.events.report, akun layanan Anda memerlukan peran Penulis Error Reporting (roles/errorreporting.writer).

Beberapa layanan Google Cloud secara otomatis memberikan peran Error Reporting Writer (roles/errorreporting.writer) ke akun layanan yang sesuai. Namun, Anda harus memberikan peran ini ke akun layanan yang sesuai untuk beberapa layanan.

Lingkungan fleksibel App Engine

App Engine memberikan peran Penulis Pelaporan Error (roles/errorreporting.writer) ke akun layanan default Anda secara otomatis.

Library Error Reporting untuk PHP dapat digunakan tanpa perlu memberikan kredensial secara eksplisit.

Untuk mengaktifkan Error Reporting di lingkungan fleksibel App Engine, ikuti langkah-langkah berikut:

1. Instal library yang diperlukan dengan perintah berikut:

   $ composer require google/cloud-error-reporting

2. Tambahkan baris berikut ke bagian runtime_config di app.yaml:

enable_stackdriver_integration: true

Selanjutnya, library akan otomatis mengumpulkan semua error dan pengecualian yang tidak tertangkap ke Error Reporting. Jika Anda menggunakan Framework Web yang menginstal pengendali Exception-nya sendiri, lihat bagian Integrasi Framework untuk mengetahui informasi selengkapnya.

Google Kubernetes Engine

Untuk menggunakan Error Reporting dengan Google Kubernetes Engine, lakukan hal berikut:

1. Pastikan akun layanan yang akan digunakan oleh penampung Anda telah diberi peran Penulis Pelaporan Error (roles/errorreporting.writer).

   Anda dapat menggunakan akun layanan default Compute Engine atau akun layanan kustom.

   Untuk mengetahui informasi tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

2. Buat cluster Anda dan beri cluster cakupan akses cloud-platform.

   Misalnya, perintah create berikut menentukan cakupan akses cloud-platform dan akun layanan:

   gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
   

Catatan: Setelah membuat cluster, Anda tidak dapat mengubah akun layanannya.

Compute Engine

Untuk menggunakan Error Reporting dengan instance VM Compute Engine, lakukan hal berikut:

1. Pastikan akun layanan yang akan digunakan oleh instance VM Anda telah diberi peran Penulis Error Reporting (roles/errorreporting.writer).

   Anda dapat menggunakan akun layanan default Compute Engine atau akun layanan kustom.

   Untuk mengetahui informasi tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

2. Di panel navigasi Konsol Google Cloud, pilih Compute Engine, lalu pilih VM instances:

   Buka instance VM

3. Pilih instance VM yang Anda inginkan untuk menerima cakupan akses cloud-platform.

4. Klik Hentikan, lalu klik Edit.

5. Di bagian Identity and API access, pilih akun layanan yang memiliki peran Error Reporting Writer (roles/errorreporting.writer).

6. Di bagian Access scope, pilih Allow full access to all Cloud APIs, lalu simpan perubahan.

7. Klik Mulai/Lanjutkan.

Contoh

1. Instal library cloud dengan perintah berikut:

$ composer require google/cloud-error-reporting

2. Tambahkan baris berikut ke php.ini, dengan WORKSPACE adalah jalur absolut ke direktori utama ruang kerja Anda:

auto_prepend_file='/WORKSPACE/vendor/google/cloud-error-reporting/src/prepend.php'

File ini di awal akan menginstal pengendali pengecualian dan pengendali error yang otomatis mengirim error ke Error Reporting.

Jika Anda menggunakan lingkungan fleksibel App Engine, lihat lingkungan fleksibel App Engine di halaman ini.

Menjalankan aplikasi di lingkungan pengembangan lokal

Agar dapat menggunakan library Error Reporting untuk PHP di lingkungan pengembangan lokal, seperti menjalankan library di workstation sendiri, Anda harus menyediakan library Error Reporting untuk PHP dengan kredensial default aplikasi lokal. Untuk mengetahui informasi selengkapnya, lihat Mengautentikasi ke Error Reporting.

Untuk menggunakan contoh PHP di halaman ini dari lingkungan pengembangan lokal, instal dan lakukan inisialisasi gcloud CLI, lalu siapkan Kredensial Default Aplikasi dengan kredensial pengguna Anda.

1. Menginstal Google Cloud CLI.

2. Untuk initialize gcloud CLI, jalankan perintah berikut:

   gcloud init

3. Buat kredensial autentikasi lokal untuk Akun Google Anda:

   gcloud auth application-default login

   Catatan: Jika gcloud CLI menampilkan peringatan bahwa akun Anda tidak memiliki izin serviceusage.services.use, beberapa perintah gcloud CLI dan library klien mungkin tidak berfungsi. Minta administrator untuk memberi Anda peran IAM Consumer Service Usage (roles/serviceusage.serviceUsageConsumer), lalu jalankan perintah berikut:

   gcloud auth application-default set-quota-project PROJECT_ID

Untuk informasi selengkapnya, lihat Siapkan autentikasi untuk lingkungan pengembangan lokal.

Metode projects.events.report juga mendukung kunci API. Jika ingin menggunakan kunci API untuk autentikasi, Anda tidak perlu menyiapkan file Kredensial Default Aplikasi lokal. Untuk informasi selengkapnya, lihat Membuat kunci API dalam dokumentasi autentikasi Google Cloud.

Melihat laporan error

Di panel navigasi konsol Google Cloud, pilih Error Reporting, lalu pilih project Google Cloud Anda:

Buka Error Reporting

Untuk informasi selengkapnya, lihat Melihat Error.

Integrasi Framework

Beberapa framework web mengganti pengendali pengecualian. Berikut adalah contoh untuk mengaktifkan Error Reporting dengan Laravel dan Symfony. Untuk framework lain, Anda dapat menggunakan Google\Cloud\ErrorReporting\Bootstrap::exceptionHandler sebagai pengendali pengecualian.

Laravel

Edit fungsi report dalam file app/Exceptions/Handler.php sebagai berikut:

public function report(Exception $exception)
{
    if (isset($_SERVER['GAE_SERVICE'])) {
        // Ensure Stackdriver is initialized and handle the exception
        Bootstrap::init();
        Bootstrap::exceptionHandler($exception);
    } else {
        parent::report($exception);
    }
}

Anda juga perlu menambahkan pernyataan use satu baris di awal file:

use Google\Cloud\ErrorReporting\Bootstrap;

Simfoni

Buat file baru src/AppBundle/EventSubscriber/ExceptionSubscriber.php dengan konten berikut:

// src/AppBundle/EventSubscriber/ExceptionSubscriber.php
namespace AppBundle\EventSubscriber;

use Google\Cloud\ErrorReporting\Bootstrap;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\ExceptionEvent;
use Symfony\Component\HttpKernel\KernelEvents;

class ExceptionSubscriber implements EventSubscriberInterface
{
    public static function getSubscribedEvents()
    {
        // return the subscribed events, their methods and priorities
        return [KernelEvents::EXCEPTION => [
            ['logException', 0]
        ]];
    }

    public function logException(ExceptionEvent $event)
    {
        $exception = $event->getThrowable();
        Bootstrap::exceptionHandler($exception);
    }
}