PHP Academy · Pelajaran

Mencatat Ralat dan Amalan Terbaik

Catat ralat ke fail dan ikuti corak pengendalian ralat untuk persekitaran produksi.

Pelajaran 4 daripada 413 langkah

Mencatat Ralat dan Amalan Terbaik ialah pelajaran PHP Academy percuma di CoddyKit. Ini ialah pelajaran 4 daripada 4. Anda boleh membaca keseluruhan pelajaran di bawah secara percuma — kemudian berlatih secara praktikal dalam pelayar menggunakan penyunting kod terbina dalam dan tutor kecerdasan buatan 24/7. Pelajaran ini merupakan sebahagian daripada laluan pembelajaran PHP Academy, dan kemajuan anda disegerakkan merentas web serta aplikasi CoddyKit. Kursus PHP Academy merangkumi sejumlah 4 pelajaran.

Mengapa Pengelogan Penting

Dalam pengeluaran, anda tidak boleh memaparkan ralat kepada pengguna tetapi anda masih perlu mengetahui apabila sesuatu tidak berjalan dengan betul. Pengelogan merekodkan butiran ralat ke fail atau perkhidmatan supaya anda boleh menyiasatnya kemudian.

error_log()

Fungsi pengelogan paling mudah — menulis mesej ke catatan ralat PHP:

<?php
error_log('User login failed for: ' . $email);
error_log('DB query took: ' . $duration . 'ms');

// Send to email (not recommended for high traffic)
error_log('Critical: server out of memory', 1, 'admin@example.com');

Pengelogan Berstruktur

Catat data berstruktur sebagai JSON untuk penghuraian dan pertanyaan yang lebih mudah:

<?php
function logEvent(string $level, string $message, array $context = []): void {
    $entry = array_merge([
        'ts'      => date('c'),
        'level'   => $level,
        'message' => $message,
    ], $context);

    error_log(json_encode($entry));
}

logEvent('ERROR', 'Payment failed', [
    'order_id' => 123,
    'amount'   => 99.99,
    'user_id'  => 45,
]);

Tahap Pengelogan (PSR-3)

PSR-3 mentakrifkan tahap pengelogan standard:

kecemasan — sistem tidak boleh digunakan
makluman — tindakan mesti diambil
kritikal — keadaan kritikal
ralat — ralat masa jalan
amaran — kejadian luar biasa yang bukan ralat
notis — peristiwa biasa tetapi penting
maklumat — mesej bermaklumat
nyahpepijat — maklumat penyahpepijatan terperinci

Pencatat Monolog

Monolog ialah pustaka pengelogan PHP standard yang serasi dengan PSR-3:

<?php
use Monolog\Logger;
use Monolog\Handler\StreamHandler;

$log = new Logger('app');
$log->pushHandler(new StreamHandler('/var/log/app.log', Logger::DEBUG));

$log->info('User logged in', ['user_id' => 42]);
$log->error('Payment failed', ['order' => 99, 'reason' => 'card_declined']);
$log->warning('Slow query', ['duration_ms' => 3200]);

Pengendalian Pengecualian dalam Pengeluaran

Pengendali pengecualian untuk persekitaran pengeluaran yang mencatat ralat dan mengembalikan respons selamat:

<?php
set_exception_handler(function(\Throwable $e) {
    $id = uniqid('err_');
    error_log(json_encode([
        'error_id' => $id,
        'class'    => get_class($e),
        'message'  => $e->getMessage(),
        'file'     => $e->getFile(),
        'line'     => $e->getLine(),
        'trace'    => $e->getTraceAsString(),
    ]));
    http_response_code(500);
    echo json_encode(['error' => 'Server error', 'id' => $id]);
    exit(1);
});

Putaran Catatan

Fail catatan berkembang tanpa had — putarkannya dengan logrotate pada Linux atau pengendali berasaskan masa dalam Monolog:

<?php
use Monolog\Handler\RotatingFileHandler;

$handler = new RotatingFileHandler(
    '/var/log/app.log',
    30,              // keep 30 days
    Logger::DEBUG
);

// Creates dated files: app-2024-05-27.log
$log = new Logger('app');
$log->pushHandler($handler);

Pengelogan dengan Konteks Lengkap

Sertakan konteks permintaan dalam setiap entri catatan untuk penyahpepijatan yang lebih mudah:

<?php
function getRequestContext(): array {
    return [
        'url'     => $_SERVER['REQUEST_URI'] ?? '',
        'method'  => $_SERVER['REQUEST_METHOD'] ?? '',
        'ip'      => $_SERVER['REMOTE_ADDR'] ?? '',
        'user_id' => $_SESSION['user_id'] ?? null,
    ];
}

// Add to every log call:
$log->error('Order failed', array_merge(
    getRequestContext(),
    ['order_id' => $orderId]
));

Mengelakkan Data Sensitif dalam Catatan

Jangan sekali-kali catat maklumat sensitif:

Kata laluan dan token
Nombor kad kredit
Data peribadi (pematuhan GDPR)
Jejak tindanan pengecualian penuh dalam respons yang dipaparkan kepada pengguna

<?php
// Bad:
error_log('Login attempt: ' . $email . ' / ' . $password);

// Good:
error_log('Login failed for user: ' . substr($email, 0, 3) . '***');

Sentry dan Penjejakan Ralat Luaran

Dalam pengeluaran, gunakan perkhidmatan penjejakan ralat seperti Sentry untuk memusatkan ralat dan memberikan makluman:

<?php
// After composer require sentry/sdk
\Sentry\init(['dsn' => getenv('SENTRY_DSN')]);

// Automatic capture of unhandled exceptions
// Manual capture:
try {
    processOrder();
} catch (\Throwable $e) {
    \Sentry\captureException($e);
    throw $e;
}

Prasyarat Berasaskan Penegasan

Gunakan penegasan untuk menangkap ralat pengaturcaraan dalam pembangunan:

<?php
// assert() throws AssertionError when false (dev mode)
assert(is_int($userId), 'userId must be an integer');
assert($amount > 0, 'amount must be positive');

// Or throw explicitly:
if (!is_int($userId)) {
    throw new \InvalidArgumentException('userId must be int');
}

Semakan Pantas

Menurut PSR-3, tahap pengelogan manakah yang menunjukkan situasi yang memerlukan perhatian segera?

Jawab dalam pelajaran interaktif

Imbas Kembali: Pengelogan Ralat

Amalan terbaik pengelogan:

Gunakan pengelogan JSON berstruktur dengan cap masa, tahap, mesej dan konteks
Ikuti tahap pengelogan PSR-3
Gunakan Monolog dalam aplikasi pengeluaran
Putarkan catatan untuk mengelakkan cakera penuh
Jangan sekali-kali catat kata laluan atau data sensitif
Gunakan Sentry atau alat serupa untuk penjejakan ralat masa nyata

Percuma untuk bermula

Pelajari PHP dengan tutor kecerdasan buatan — percuma

Tulis dan jalankan kod sebenar dalam pelayar anda, dapatkan bantuan segera daripada tutor kecerdasan buatan yang tersedia 24/7, dan sambung semula dari tempat anda berhenti di web atau dalam aplikasi.

Kursus: 49
Pelajaran: 195

Mula belajar secara percuma Lihat kursus penuh

Soalan Lazim

Adakah pelajaran “Mencatat Ralat dan Amalan Terbaik” percuma?

Ya — teks penuh “Mencatat Ralat dan Amalan Terbaik” boleh dibaca secara percuma di web ini. Untuk berlatih secara interaktif menggunakan penyunting kod terbina dalam dan tutor kecerdasan buatan 24/7, serta membuka kunci baki kursus PHP Academy, tingkat taraf kepada CoddyKit PRO. Kursus PHP Academy merangkumi sejumlah 4 pelajaran.

Apakah yang akan saya pelajari dalam “Mencatat Ralat dan Amalan Terbaik”?

Catat ralat ke fail dan ikuti corak pengendalian ralat untuk persekitaran produksi. Anda berlatih PHP Academy menggunakan kod praktikal yang dijalankan terus dalam pelayar, manakala tutor kecerdasan buatan 24/7 menjawab soalan anda semasa anda mengikuti pelajaran.

Adakah saya memerlukan pengalaman untuk memulakan PHP Academy?

Tiada pengalaman terdahulu diperlukan. Pembelajaran PHP Academy di CoddyKit disusun untuk pelajar daripada peringkat pemula hingga lanjutan, jadi anda boleh bermula di sini atau dari awal dan belajar mengikut kadar anda sendiri. Ini ialah pelajaran 4 daripada 4.

Berapa lamakah pelajaran “Mencatat Ralat dan Amalan Terbaik” diambil?

Kebanyakan pelajaran CoddyKit mengambil masa kira-kira 5–10 minit. Setiap pelajaran ringkas dan interaktif, jadi anda boleh membuat kemajuan secara berterusan dan menyambung tepat dari tempat anda berhenti di web atau aplikasi.

Bolehkah saya menulis dan menjalankan kod dalam pelajaran PHP Academy ini?

Ya. Setiap pelajaran PHP Academy menyertakan penyunting kod terbina dalam, jadi anda boleh menulis dan menjalankan kod sebenar terus dalam pelayar serta menerima maklum balas kecerdasan buatan serta-merta — tanpa memerlukan persediaan setempat.

Semua pelajaran dalam kursus ini

← Kembali ke PHP Academy