Menerapkan Logging pada API PHP untuk Pemantauan

Pendahuluan

Logging adalah proses mencatat aktivitas atau peristiwa yang terjadi dalam sistem. Dalam konteks API, logging sangat penting untuk memantau aktivitas pengguna, melacak kesalahan, dan memastikan API berjalan dengan baik. Dengan logging, Anda dapat menganalisis masalah secara efektif dan meningkatkan performa API berdasarkan data yang dikumpulkan.

Pada artikel ini, kita akan membahas cara menambahkan logging ke API PHP menggunakan library seperti Monolog.

Langkah 1: Menginstal Library Monolog

Monolog adalah salah satu library logging paling populer untuk PHP. Anda dapat menginstalnya menggunakan Composer:

composer require monolog/monolog

Setelah diinstal, Anda dapat mulai menggunakannya untuk mencatat log pada API Anda.

Langkah 2: Konfigurasi Dasar Monolog

Berikut adalah contoh dasar penggunaan Monolog untuk mencatat log ke file:

<?php
require 'vendor/autoload.php';

use Monolog\Logger;
use Monolog\Handler\StreamHandler;

// Membuat logger baru
$log = new Logger('api_logger');

// Menambahkan handler untuk mencatat log ke file
$log->pushHandler(new StreamHandler(__DIR__.'/api.log', Logger::DEBUG));

// Contoh mencatat log
$log->info('API diakses', ['endpoint' => '/get-users']);
$log->error('Kesalahan pada API', ['error' => 'Database tidak tersedia']);
?>

Kode di atas akan mencatat log ke file api.log di direktori proyek Anda. Log tersebut mencakup pesan dan data tambahan seperti endpoint atau informasi kesalahan.

Langkah 3: Mengintegrasikan Logging ke API

Anda dapat mengintegrasikan logging ke dalam logika API untuk mencatat aktivitas seperti permintaan masuk, respons keluar, atau kesalahan. Berikut adalah contoh integrasinya:

<?php
require 'vendor/autoload.php';

use Monolog\Logger;
use Monolog\Handler\StreamHandler;

// Membuat logger
$log = new Logger('api_logger');
$log->pushHandler(new StreamHandler(__DIR__.'/api.log', Logger::DEBUG));

// Contoh API sederhana
try {
    // Mencatat permintaan masuk
    $log->info('Permintaan masuk', ['method' => $_SERVER['REQUEST_METHOD'], 'endpoint' => $_SERVER['REQUEST_URI']]);

    // Logika API (contoh: mengambil data dari database)
    $data = ['id' => 1, 'name' => 'Muji Kuwat'];
    $response = json_encode($data);

    // Mencatat respons keluar
    $log->info('Respons keluar', ['response' => $response]);

    echo $response;
} catch (Exception $e) {
    // Mencatat kesalahan
    $log->error('Kesalahan pada API', ['error' => $e->getMessage()]);
    
    // Mengembalikan respons kesalahan
    http_response_code(500);
    echo json_encode(['error' => 'Terjadi kesalahan pada server']);
}
?>

Dengan integrasi ini, setiap aktivitas penting akan tercatat di file log, sehingga Anda dapat menganalisis log tersebut untuk keperluan debugging atau audit.

Langkah 4: Menggunakan Handler Tambahan

Monolog mendukung berbagai jenis handler, seperti:

• StreamHandler: Untuk mencatat log ke file.
• RotatingFileHandler: Untuk membagi log ke beberapa file berdasarkan ukuran atau tanggal.
• SlackHandler: Untuk mengirim log ke saluran Slack.
• MailHandler: Untuk mengirim log kesalahan kritis melalui email.

Contoh menggunakan RotatingFileHandler untuk membatasi ukuran file log:

<?php
use Monolog\Handler\RotatingFileHandler;

// Menggunakan RotatingFileHandler
$log->pushHandler(new RotatingFileHandler(__DIR__.'/api.log', 7, Logger::INFO));
?>

Dengan handler ini, log akan disimpan dalam file yang terpisah setiap hari atau ketika mencapai batas tertentu.

Langkah 5: Melindungi Data Sensitif

Pastikan Anda tidak mencatat data sensitif seperti kata sandi, token API, atau informasi pribadi lainnya ke dalam log. Anda dapat memfilter data sensitif sebelum mencatatnya:

<?php
$data = ['username' => 'muji', 'password' => 'rahasia'];
$log->info('Login attempt', ['username' => $data['username'], 'password' => '***']);
?>

Kesimpulan

Logging adalah bagian penting dari pengelolaan API. Dengan menerapkan logging yang baik, Anda dapat memantau aktivitas API, menganalisis kesalahan, dan meningkatkan performa sistem secara keseluruhan.

Selanjutnya, kita akan membahas cara menerapkan autentikasi API menggunakan token JWT. Baca selengkapnya di sini!

Bagikan Artikel ini