Pembalakan dan Pemantauan dalam Node.js: Amalan Terbaik

Pengelogan dan pemantauan yang berkesan adalah penting untuk mengekalkan kesihatan aplikasi, mengenal pasti isu dengan cepat dan meningkatkan prestasi. Dalam artikel ini, kami akan menyelami pengelogan dan pemantauan untuk aplikasi Node.js, meliputi topik utama seperti memilih tahap pengelogan, menyediakan log berstruktur, menyepadukan dengan alatan pemantauan dan amalan terbaik untuk menggunakan Winston dan Elasticsearch.

Pengenalan kepada Pembalakan dan Pemantauan

Pengelogan membantu menangkap peristiwa masa nyata, ralat dan maklumat penting lain daripada aplikasi, manakala pemantauan melibatkan penjejakan metrik prestasi aplikasi dari semasa ke semasa. Bersama-sama, mereka memberikan cerapan kritikal tentang kesihatan aplikasi, membolehkan penyelesaian isu proaktif.

Menyediakan Pengelogan Asas dalam Node.js

Objek konsol terbina dalam menyediakan fungsi pengelogan yang mudah, tetapi perpustakaan pengelogan khusus lebih mantap untuk aplikasi pengeluaran.

Pengelogan Konsol Asas

console.log("Server started on port 3000");
console.warn("This is a warning");
console.error("Error occurred while processing request");

Walau bagaimanapun, pengelogan konsol mempunyai had dalam aplikasi yang kompleks, seperti kekurangan kawalan tahap log dan tiada ketekunan log.

Memperkenalkan Winston

Winston ialah perpustakaan pembalakan popular untuk Node.js yang menawarkan berbilang peringkat log, pengangkutan (destinasi log) dan pembalakan berstruktur.

1. Pasang Winston:

   npm install winston

1. Menyediakan Winston

   const winston = require("winston");

   // Configure logger
   const logger = winston.createLogger({
       level: "info",
       format: winston.format.combine(
           winston.format.timestamp(),
           winston.format.json()
       ),
       transports: [
           new winston.transports.Console(),
           new winston.transports.File({ filename: "app.log" })
       ]
   });

   // Logging examples
   logger.info("Server started on port 3000");
   logger.error("Database connection failed");

Memilih Tahap Log yang Sesuai

Tahap log mengkategorikan mesej log berdasarkan kepentingannya. Tahap log biasa ialah:

• Ralat: Isu kritikal yang memerlukan perhatian segera, seperti kegagalan pangkalan data atau pelayan.
• Amaran: Isu tidak kritikal, seperti API yang ditamatkan.
• Maklumat: Maklumat aplikasi umum, seperti permulaan atau penutupan pelayan.
• Nyahpepijat: Maklumat terperinci berguna semasa pembangunan, seperti nilai berubah.

Mengkonfigurasi Tahap Log dalam Winston

logger.level = "debug"; // Sets the minimum log level to debug, capturing all messages.

Dalam pengeluaran, adalah lebih baik untuk mengekalkan tahap log pada maklumat atau memberi amaran untuk mengelakkan data log yang tidak diperlukan.

Pembalakan Berstruktur untuk Kekonsistenan

Pengelogan berstruktur menjadikannya lebih mudah untuk menapis dan menganalisis log dengan mengekalkan format yang konsisten.

Menambah Metadata pada Log

Metadata seperti user_id atau request_id boleh membantu menjejaki tindakan tertentu dalam log:

logger.info("User login successful", { user_id: "12345" });
logger.error("Failed to fetch user data", { user_id: "12345", error: "Database unavailable" });

Mengintegrasikan dengan Elasticsearch untuk Pembalakan Berpusat

Elasticsearch digunakan secara meluas untuk pengurusan log terpusat dan keupayaan carian.

1. Pasang Elasticsearch dan Pengangkutan Elasticsearch

console.log("Server started on port 3000");
console.warn("This is a warning");
console.error("Error occurred while processing request");

1. Konfigurasikan Pengangkutan Elasticsearch

   npm install winston

Persediaan ini akan menghantar log ke Elasticsearch, membolehkan anda menggunakan Kibana untuk carian dan analisis log masa nyata.

Metrik Aplikasi Pemantauan dengan Prometheus dan Grafana

Pemantauan menjejaki metrik prestasi aplikasi seperti penggunaan CPU, memori dan masa tindak balas, membantu memastikan aplikasi yang stabil.

Menyediakan Prometheus dengan Node.js

1. Pasang Perpustakaan Pelanggan Prometheus

   const winston = require("winston");

   // Configure logger
   const logger = winston.createLogger({
       level: "info",
       format: winston.format.combine(
           winston.format.timestamp(),
           winston.format.json()
       ),
       transports: [
           new winston.transports.Console(),
           new winston.transports.File({ filename: "app.log" })
       ]
   });

   // Logging examples
   logger.info("Server started on port 3000");
   logger.error("Database connection failed");

1. Buat dan Eksport Metrik

logger.level = "debug"; // Sets the minimum log level to debug, capturing all messages.

1. Dedahkan Titik Tamat Metrik

logger.info("User login successful", { user_id: "12345" });
logger.error("Failed to fetch user data", { user_id: "12345", error: "Database unavailable" });

Visualisasi dengan Grafana

Grafana ialah alat yang berkuasa untuk mencipta papan pemuka daripada metrik Prometheus. Sepadukan Prometheus sebagai sumber data dalam Grafana, kemudian gambarkan metrik seperti masa tindak balas dan kadar ralat.

Kes Penggunaan Dunia Sebenar: Pembalakan dan Pemantauan dalam E-dagang

Pertimbangkan platform e-dagang di mana pengelogan dan pemantauan adalah penting untuk mengekalkan prestasi tinggi dan kebolehpercayaan.

1. Log Semua Transaksi: Tangkap pesanan dan peristiwa pembayaran dengan log berstruktur, termasuk metadata seperti order_id dan user_id.
2. Penjejakan Ralat: Gunakan Winston untuk mengelog ralat seperti kegagalan pembayaran, bersama-sama dengan surih tindanan dan metadata untuk penyahpepijatan yang lebih pantas.
3. Pantau Kesihatan Pelayan: Sediakan Prometheus untuk memantau masa tindak balas dan kiraan permintaan, digambarkan dalam Grafana untuk cerapan masa nyata.
4. Tetapkan Makluman: Konfigurasikan makluman berdasarkan metrik. Contohnya, jika tempoh permintaan melebihi ambang, hantar makluman kepada pentadbir.

Persediaan ini memberikan pandangan menyeluruh tentang kesihatan aplikasi, membolehkan pengesanan dan penyelesaian isu proaktif.

Kesimpulan

Melaksanakan pengelogan dan pemantauan yang teguh dalam Node.js adalah penting untuk mengekalkan kebolehpercayaan dan memastikan penyelesaian masalah yang cepat. Menggunakan alatan seperti Winston, Elasticsearch, Prometheus dan Grafana, anda boleh menangkap log berstruktur, memusatkannya dan memantau metrik prestasi kritikal dengan berkesan.

Atas ialah kandungan terperinci Pembalakan dan Pemantauan dalam Node.js: Amalan Terbaik. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!