How to Do Socket.IO Logging and Its Features

While developing real-time applications, the Socket.IO Logging feature plays a critical role in monitoring your application's behaviors and quickly detecting errors. Socket.IO, although a popular WebSocket library especially in the Node.js environment, is not fully known by most developers in terms of its logging capabilities. In this article, we explain how to enable, configure, and customize Socket.IO Logging with example code.

Socket.IO Logging Features and Usage

Starting from version 4.x, Socket.IO has integrated its default logging system with the debug module to offer more detailed and manageable logs. Through logging, connection flows, error messages, and event tracking become easier. Logging is indispensable for seeing what works in which part of your application and for quickly solving problems.

How to Enable Logging in Socket.IO?

The official way to enable logging in Socket.IO is to set the DEBUG environment variable in your environment. You can specify the log levels provided by Socket.IO in the terminal or command line as in the following example:

DEBUG=socket.io:* node app.js

This command ensures that all Socket.IO Logging outputs are displayed in the terminal when starting your app.js file. You can select specific areas instead of the asterisk character to determine the level of detail.

Code Example: Using Logs in Socket.IO

Below, you can see how to enable logging in a simple Socket.IO server:

const { Server } = require("socket.io");
const io = new Server(3000);

io.on("connection", (socket) => {
  console.log("User connected: " + socket.id);
  socket.on("disconnect", () => {
    console.log("User disconnected: " + socket.id);
  });
});

In the code above, standard console.log is used. However, for Socket.IO Logging, targeted logs can be obtained with the debug module.

Detailed Logging with the Debug Module

It can be used in the following way for more controlled logging:

const debug = require("debug")("socket.io:server");
debug("Server starting...");

// Other Socket.IO code here

In this way, you only get Socket.IO Logging outputs for specific areas you define.

Conclusion: Project Management with Socket.IO Logging

In summary, Socket.IO Logging is a highly effective tool for catching errors and monitoring processes in your application. By configuring logging correctly, you can reduce maintenance costs and produce quick error solutions. Thanks to its customizable structure, Socket.IO Logging offers flexibility to developers and provides a professional monitoring capability for real-time applications.