Giới thiệu
Ghi nhật ký và giám sát bảo mật là các thành phần thiết yếu của bất kỳ ứng dụng web nào để đảm bảo tính an toàn, ổn định và hiệu suất của ứng dụng đó. Trong thế giới của các ứng dụng Node.js Express, việc triển khai các thành phần này một cách hiệu quả có thể là một nhiệm vụ đầy thách thức. Trong bài viết này, chúng ta sẽ đi sâu vào tầm quan trọng của việc giám sát và ghi nhật ký bảo mật, các công cụ và kỹ thuật có sẵn cho Node.js Express, đồng thời cung cấp các ví dụ thực tế về cách triển khai các biện pháp này trong ứng dụng của bạn.
Tầm quan trọng của việc ghi nhật ký và giám sát bảo mật
Xác định các mối đe dọa bảo mật
Ghi nhật ký và giám sát bảo mật giúp các nhà phát triển và quản trị viên xác định các mối đe dọa bảo mật tiềm ẩn đối với ứng dụng của họ. Bằng cách thu thập và phân tích nhật ký, bạn có thể phát hiện hoạt động đáng ngờ, chẳng hạn như nỗ lực truy cập trái phép, vi phạm dữ liệu hoặc tấn công từ chối dịch vụ phân tán (DDoS). Việc xác định sớm các mối đe dọa này cho phép bạn thực hiện các biện pháp đối phó cần thiết để bảo vệ ứng dụng và người dùng của mình.
Gỡ lỗi và khắc phục sự cố
Nhật ký cung cấp thông tin có giá trị để gỡ lỗi và khắc phục sự cố có thể phát sinh trong quá trình phát triển và vận hành ứng dụng của bạn. Họ có thể giúp bạn xác định nguyên nhân cốt lõi của vấn đề và tiết kiệm thời gian quý báu khi cố gắng giải quyết vấn đề đó.
Tuân thủ và Trách nhiệm giải trình
Đối với nhiều tổ chức, đặc biệt là những tổ chức xử lý dữ liệu nhạy cảm, việc tuân thủ các tiêu chuẩn và quy định của ngành là điều bắt buộc. Ghi nhật ký và giám sát bảo mật đóng một vai trò quan trọng trong việc đảm bảo tuân thủ, vì chúng giúp bạn chứng minh rằng ứng dụng của bạn đáp ứng các tiêu chuẩn bảo mật bắt buộc. Ngoài ra, nhật ký có thể dùng làm bằng chứng trong trường hợp xảy ra sự cố bảo mật hoặc kiểm tra.
Đăng nhập Node.js Express
Ghi nhật ký bảng điều khiển
Ghi nhật ký bảng điều khiển là hình thức ghi nhật ký cơ bản nhất có sẵn trong các ứng dụng Node.js Express. Các phương thức console.log , console.warn và console.error thường được sử dụng để xuất thông báo ra bàn điều khiển.
1 2 3 4 | console <span class="token punctuation">.</span> <span class="token function">log</span> <span class="token punctuation">(</span> <span class="token string">"Info: Application started"</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> console <span class="token punctuation">.</span> <span class="token function">warn</span> <span class="token punctuation">(</span> <span class="token string">"Warning: Deprecated API in use"</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> console <span class="token punctuation">.</span> <span class="token function">error</span> <span class="token punctuation">(</span> <span class="token string">"Error: Failed to connect to the database"</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> |
Mặc dù ghi nhật ký bảng điều khiển có thể hữu ích để gỡ lỗi đơn giản trong quá trình phát triển, nhưng nó không được khuyến nghị cho môi trường sản xuất do các tính năng hạn chế và thiếu tính bền bỉ.
Sử dụng Winston để ghi nhật ký nâng cao
Winston là thư viện ghi nhật ký linh hoạt, phổ biến dành cho Node.js, cung cấp các tính năng mạnh mẽ để quản lý nhật ký, bao gồm nhiều cấp độ ghi nhật ký, định dạng nhật ký và các tùy chọn truyền tải nhật ký. Để bắt đầu với Winston, trước tiên hãy cài đặt nó dưới dạng phần phụ thuộc:
1 2 | <span class="token function">npm</span> <span class="token function">install</span> winston |
Sau đó, tạo một phiên bản trình ghi nhật ký và định cấu hình nếu cần:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | <span class="token keyword">const</span> winston <span class="token operator">=</span> <span class="token function">require</span> <span class="token punctuation">(</span> <span class="token string">"winston"</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> <span class="token keyword">const</span> logger <span class="token operator">=</span> winston <span class="token punctuation">.</span> <span class="token function">createLogger</span> <span class="token punctuation">(</span> <span class="token punctuation">{</span> level <span class="token operator">:</span> <span class="token string">"info"</span> <span class="token punctuation">,</span> format <span class="token operator">:</span> winston <span class="token punctuation">.</span> format <span class="token punctuation">.</span> <span class="token function">combine</span> <span class="token punctuation">(</span> winston <span class="token punctuation">.</span> format <span class="token punctuation">.</span> <span class="token function">timestamp</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">,</span> winston <span class="token punctuation">.</span> format <span class="token punctuation">.</span> <span class="token function">json</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">)</span> <span class="token punctuation">,</span> transports <span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token keyword">new</span> <span class="token class-name">winston <span class="token punctuation">.</span> transports <span class="token punctuation">.</span> Console</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">,</span> <span class="token keyword">new</span> <span class="token class-name">winston <span class="token punctuation">.</span> transports <span class="token punctuation">.</span> File</span> <span class="token punctuation">(</span> <span class="token punctuation">{</span> filename <span class="token operator">:</span> <span class="token string">"application.log"</span> <span class="token punctuation">}</span> <span class="token punctuation">)</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> logger <span class="token punctuation">.</span> <span class="token function">info</span> <span class="token punctuation">(</span> <span class="token string">"Info: Application started"</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> logger <span class="token punctuation">.</span> <span class="token function">warn</span> <span class="token punctuation">(</span> <span class="token string">"Warning: Deprecated API in use"</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> logger <span class="token punctuation">.</span> <span class="token function">error</span> <span class="token punctuation">(</span> <span class="token string">"Error: Failed to connect to the database"</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> |
Trong ví dụ này, trình ghi nhật ký được định cấu hình để xuất nhật ký ở định dạng JSON với dấu thời gian và lưu trữ cả trong bảng điều khiển và tệp có tên application.log .
Giám sát trong Node.js Express
Sử dụng Middleware để ghi nhật ký yêu cầu
Các chức năng của phần mềm trung gian là một tính năng mạnh mẽ của Express cho phép bạn chặn và sửa đổi các yêu cầu cũng như phản hồi. Bạn có thể sử dụng phần mềm trung gian để ghi nhật ký chi tiết về các yêu cầu đến, chẳng hạn như phương thức yêu cầu, URL và trạng thái phản hồi.
Đây là một ví dụ về một phần mềm trung gian ghi nhật ký yêu cầu đơn giản:
1 2 3 4 5 6 7 8 9 10 11 12 | <span class="token keyword">const</span> <span class="token function-variable function">requestLogger</span> <span class="token operator">=</span> <span class="token punctuation">(</span> <span class="token parameter">req <span class="token punctuation">,</span> res <span class="token punctuation">,</span> next</span> <span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token punctuation">{</span> <span class="token keyword">const</span> startTime <span class="token operator">=</span> Date <span class="token punctuation">.</span> <span class="token function">now</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> res <span class="token punctuation">.</span> <span class="token function">on</span> <span class="token punctuation">(</span> <span class="token string">"finish"</span> <span class="token punctuation">,</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token punctuation">{</span> <span class="token keyword">const</span> duration <span class="token operator">=</span> Date <span class="token punctuation">.</span> <span class="token function">now</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token operator">-</span> startTime <span class="token punctuation">;</span> logger <span class="token punctuation">.</span> <span class="token function">info</span> <span class="token punctuation">(</span> <span class="token template-string"><span class="token template-punctuation string">`</span> <span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span> req <span class="token punctuation">.</span> method <span class="token interpolation-punctuation punctuation">}</span></span> <span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span> req <span class="token punctuation">.</span> originalUrl <span class="token interpolation-punctuation punctuation">}</span></span><span class="token string"> - </span><span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span> res <span class="token punctuation">.</span> statusCode <span class="token interpolation-punctuation punctuation">}</span></span><span class="token string"> - </span><span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span> duration <span class="token interpolation-punctuation punctuation">}</span></span> <span class="token string">ms</span> <span class="token template-punctuation string">`</span></span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token punctuation">;</span> app <span class="token punctuation">.</span> <span class="token function">use</span> <span class="token punctuation">(</span> requestLogger <span class="token punctuation">)</span> <span class="token punctuation">;</span> |
Trong ví dụ này, phần mềm trung gian requestLogger ghi lại phương thức yêu cầu, URL, mã trạng thái phản hồi và thời gian xử lý yêu cầu. Đảm bảo thêm phần mềm trung gian vào ứng dụng Express của bạn bằng phương thức app.use() .
Giám sát hiệu suất với móc hiệu suất
Node.js cung cấp một mô-đun tích hợp có tên là perf_hooks cho phép bạn đo lường hiệu suất của các phần khác nhau trong ứng dụng của mình. Lớp PerformanceObserver có thể được sử dụng để thu thập các mục hiệu suất và phân tích chúng.
Đây là một ví dụ đo thời gian thực hiện của một chức năng:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | <span class="token keyword">const</span> <span class="token punctuation">{</span> performance <span class="token punctuation">,</span> PerformanceObserver <span class="token punctuation">}</span> <span class="token operator">=</span> <span class="token function">require</span> <span class="token punctuation">(</span> <span class="token string">"perf_hooks"</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> <span class="token keyword">const</span> performanceObserver <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">PerformanceObserver</span> <span class="token punctuation">(</span> <span class="token punctuation">(</span> <span class="token parameter">list</span> <span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token punctuation">{</span> <span class="token keyword">const</span> entry <span class="token operator">=</span> list <span class="token punctuation">.</span> <span class="token function">getEntries</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">[</span> <span class="token number">0</span> <span class="token punctuation">]</span> <span class="token punctuation">;</span> logger <span class="token punctuation">.</span> <span class="token function">info</span> <span class="token punctuation">(</span> <span class="token template-string"><span class="token template-punctuation string">`</span> <span class="token string">Function </span><span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span> entry <span class="token punctuation">.</span> name <span class="token interpolation-punctuation punctuation">}</span></span><span class="token string"> took </span><span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span> entry <span class="token punctuation">.</span> duration <span class="token punctuation">.</span> <span class="token function">toFixed</span> <span class="token punctuation">(</span> <span class="token number">2</span> <span class="token punctuation">)</span> <span class="token interpolation-punctuation punctuation">}</span></span> <span class="token string">ms</span> <span class="token template-punctuation string">`</span></span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> performanceObserver <span class="token punctuation">.</span> <span class="token function">observe</span> <span class="token punctuation">(</span> <span class="token punctuation">{</span> entryTypes <span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token string">"measure"</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> <span class="token keyword">function</span> <span class="token function">exampleFunction</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">{</span> performance <span class="token punctuation">.</span> <span class="token function">mark</span> <span class="token punctuation">(</span> <span class="token string">"exampleFunction-start"</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> <span class="token comment">// Some code here...</span> performance <span class="token punctuation">.</span> <span class="token function">mark</span> <span class="token punctuation">(</span> <span class="token string">"exampleFunction-end"</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> performance <span class="token punctuation">.</span> <span class="token function">measure</span> <span class="token punctuation">(</span> <span class="token string">"exampleFunction"</span> <span class="token punctuation">,</span> <span class="token string">"exampleFunction-start"</span> <span class="token punctuation">,</span> <span class="token string">"exampleFunction-end"</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token function">exampleFunction</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> |
Trong ví dụ này, phương thức performance.mark() được sử dụng để đặt dấu thời gian bắt đầu và kết thúc cho exampleFunction . Sau đó, phương thức performance.measure() tính toán khoảng thời gian giữa hai dấu thời gian này và PerformanceObserver ghi lại kết quả.
Theo dõi tình trạng ứng dụng với Kiểm tra tình trạng
Thực hiện kiểm tra sức khỏe là rất quan trọng để đảm bảo tính khả dụng và độ tin cậy của ứng dụng của bạn. Kiểm tra tình trạng có thể được sử dụng bởi các công cụ giám sát, bộ cân bằng tải hoặc bộ điều phối vùng chứa để xác định trạng thái ứng dụng của bạn và thực hiện các hành động thích hợp, chẳng hạn như khởi động lại ứng dụng hoặc chuyển hướng lưu lượng truy cập đến các phiên bản lành mạnh.
Dưới đây là ví dụ về điểm cuối kiểm tra tình trạng đơn giản trong ứng dụng Express:
1 2 3 4 | app <span class="token punctuation">.</span> <span class="token function">get</span> <span class="token punctuation">(</span> <span class="token string">"/health"</span> <span class="token punctuation">,</span> <span class="token punctuation">(</span> <span class="token parameter">req <span class="token punctuation">,</span> res</span> <span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token punctuation">{</span> res <span class="token punctuation">.</span> <span class="token function">status</span> <span class="token punctuation">(</span> <span class="token number">200</span> <span class="token punctuation">)</span> <span class="token punctuation">.</span> <span class="token function">json</span> <span class="token punctuation">(</span> <span class="token punctuation">{</span> status <span class="token operator">:</span> <span class="token string">"ok"</span> <span class="token punctuation">}</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> |
Điểm cuối kiểm tra tình trạng này trả về phản hồi 200 OK với tải trọng JSON cho biết rằng ứng dụng vẫn hoạt động bình thường. Bạn có thể mở rộng kiểm tra tình trạng này để bao gồm các kiểm tra chi tiết hơn, chẳng hạn như kiểm tra tính khả dụng của các dịch vụ bên ngoài hoặc trạng thái cơ sở dữ liệu của bạn.
Nhật ký tập trung với các giải pháp quản lý nhật ký
Khi chạy ứng dụng của bạn trong môi trường sản xuất, đặc biệt là khi được triển khai trên nhiều phiên bản, việc tập trung nhật ký trở nên rất quan trọng. Các giải pháp quản lý nhật ký, chẳng hạn như Loggly, Elastic Stack hoặc LogDNA, có thể giúp bạn thu thập, lưu trữ và phân tích nhật ký từ nhiều nguồn tại một nơi.
Để tích hợp ứng dụng Node.js Express của bạn với giải pháp quản lý nhật ký, bạn thường cần cài đặt SDK hoặc thư viện do giải pháp cung cấp và định cấu hình để gửi nhật ký đến nền tảng trung tâm.
Ví dụ: để tích hợp ứng dụng của bạn với Loggly, hãy cài đặt vận chuyển winston-loggly-bulk :
1 2 | <span class="token function">npm</span> <span class="token function">install</span> winston-loggly-bulk |
Sau đó, thêm vận chuyển Loggly vào cấu hình bộ ghi Winston của bạn:
1 2 3 4 5 6 7 8 9 | <span class="token keyword">const</span> <span class="token punctuation">{</span> Loggly <span class="token punctuation">}</span> <span class="token operator">=</span> <span class="token function">require</span> <span class="token punctuation">(</span> <span class="token string">"winston-loggly-bulk"</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> logger <span class="token punctuation">.</span> <span class="token function">add</span> <span class="token punctuation">(</span> <span class="token keyword">new</span> <span class="token class-name">Loggly</span> <span class="token punctuation">(</span> <span class="token punctuation">{</span> token <span class="token operator">:</span> <span class="token string">"your-loggly-token"</span> <span class="token punctuation">,</span> subdomain <span class="token operator">:</span> <span class="token string">"your-loggly-subdomain"</span> <span class="token punctuation">,</span> tags <span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token string">"Nodejs"</span> <span class="token punctuation">,</span> <span class="token string">"Express"</span> <span class="token punctuation">]</span> <span class="token punctuation">,</span> json <span class="token operator">:</span> <span class="token boolean">true</span> <span class="token punctuation">}</span> <span class="token punctuation">)</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span> |
Với cấu hình này, nhật ký của bạn sẽ được gửi tới Loggly để lưu trữ và phân tích tập trung.
Phần kết luận
Trong bài viết này, chúng ta đã khám phá tầm quan trọng của việc giám sát và ghi nhật ký bảo mật trong các ứng dụng Node.js Express và thảo luận về các kỹ thuật khác nhau để triển khai các thành phần này một cách hiệu quả. Bằng cách sử dụng các công cụ mạnh mẽ như Winston để ghi nhật ký, phần mềm trung gian để ghi nhật ký yêu cầu, móc hiệu suất để theo dõi hiệu suất và kiểm tra tình trạng của ứng dụng, bạn có thể cải thiện đáng kể tính bảo mật, tính ổn định và hiệu suất của ứng dụng của mình. Đừng quên tập trung nhật ký của bạn bằng các giải pháp quản lý nhật ký.
Và cuối cùng
Như mọi khi, tôi hy vọng bạn thích bài viết này và có một cái gì đó mới. Xin cảm ơn và hẹn gặp lại các bạn trong những bài viết tiếp theo!
Nếu các bạn thích bài viết này thì hãy cho mình 1 like và subscribe để ủng hộ mình nhé. Cảm ơn.