Logging with structured formats in Node.js - Step-by-Step Execution

Concept Flow - Logging with structured formats

Start Application

↓

Create Logger

↓

Generate Log Message

↓

Format Log as JSON

↓

Output to Console/File

↓

Log Stored in Structured Format

The app starts, creates a logger, formats messages as JSON, and outputs them for easy reading and searching.

Execution Sample

Node.js

const log = (level, message, meta = {}) => {
  const entry = { level, message, timestamp: new Date().toISOString(), ...meta };
  console.log(JSON.stringify(entry));
};

log('info', 'User login', { userId: 123 });

This code logs a message with level, text, timestamp, and extra info as a JSON string.

Execution Table

Step	Action	Input	Output	Notes
1	Call log function	level='info', message='User login', meta={userId:123}	entry object created	Combines inputs into one object with timestamp
2	Create timestamp	new Date().toISOString()	"2024-06-01T12:00:00.000Z"	Current time in ISO format
3	Merge all fields	level, message, timestamp, meta	{"level":"info","message":"User login","timestamp":"2024-06-01T12:00:00.000Z","userId":123}	Final structured log entry
4	Convert to JSON string	entry object	"{\"level\":\"info\",\"message\":\"User login\",\"timestamp\":\"2024-06-01T12:00:00.000Z\",\"userId\":123}"	Ready for output
5	Output to console	JSON string	Printed JSON log line	Visible in console or log file
6	End	-	-	Logging complete

💡 Logging function completes after outputting the structured JSON log line

Variable Tracker

Variable	Start	After Step 1	After Step 3	Final
level	undefined	info	info	info
message	undefined	User login	User login	User login
meta	undefined	{userId:123}	{userId:123}	{userId:123}
timestamp	undefined	undefined	2024-06-01T12:00:00.000Z	2024-06-01T12:00:00.000Z
entry	undefined	partial object	{"level":"info","message":"User login","timestamp":"2024-06-01T12:00:00.000Z","userId":123}	final object

Key Moments - 3 Insights

Why do we use JSON.stringify before outputting the log?

Because the log entry is an object, and console.log prints objects differently. JSON.stringify converts it to a single-line string that is easy to read and parse, as shown in step 4 of the execution_table.

What is the purpose of the timestamp in the log entry?

The timestamp shows when the log happened. It helps track events over time. In the execution_table, step 2 creates this timestamp in a standard ISO format.

Why do we merge meta fields into the main log entry?

Merging meta fields adds extra details to the log without losing the main message or level. This is shown in step 3 where meta is combined with level, message, and timestamp.

Visual Quiz - 3 Questions

Look at the execution_table at step 3, what does the 'entry' object contain?

A Just the timestamp field

B Only level and message fields

C Level, message, timestamp, and meta fields merged

D A plain string message

💡 Hint

Check the 'Output' column in step 3 of the execution_table for the full object contents.

At which step is the log entry converted into a JSON string?

A Step 4

B Step 2

C Step 3

D Step 5

💡 Hint

Look at the 'Action' column for the step mentioning JSON string conversion.

If we remove the meta parameter, what changes in the variable_tracker for 'entry'?

A The level field will be missing

B The entry object will not have meta fields

C The timestamp will be missing

D The message field will be empty

💡 Hint

Refer to the 'meta' and 'entry' rows in variable_tracker to see how meta affects the final object.

Concept Snapshot

Logging with structured formats in Node.js:
- Create a log object with level, message, timestamp, and extra data
- Use JSON.stringify to convert the object to a string
- Output the JSON string to console or file
- Structured logs are easy to search and analyze
- Always include timestamp for event tracking

Full Transcript

This visual execution shows how to log messages in Node.js using structured JSON format. The process starts by calling a log function with level, message, and optional meta data. A timestamp is created in ISO format. All fields are merged into one object. Then JSON.stringify converts this object into a string. Finally, the string is printed to the console. This method helps keep logs consistent and easy to read or parse by tools. Key points include why JSON.stringify is needed, the role of timestamp, and how meta data is merged into the log entry.