Why Structured logging with JSON in Express? - Purpose & Use Cases

The Big Idea

What if your logs could talk to you clearly instead of whispering secrets in a jumble?

The Scenario

Imagine you run a busy web server using Express. You write plain text logs by hand to track errors and requests. When something goes wrong, you have to dig through long, messy text files to find clues.

The Problem

Manual text logs are hard to read and search. They mix different info in one line, making it easy to miss important details. When your app grows, logs become huge and confusing, slowing down troubleshooting.

The Solution

Structured logging with JSON organizes log data into clear, consistent fields. Each log entry is a neat JSON object, making it easy to search, filter, and analyze automatically. This saves time and reduces mistakes.

Before vs After

✗ Before

console.log('User login failed at 10:05 PM for userId=123');

✓ After

console.log(JSON.stringify({ event: 'login_failed', time: '22:05', userId: 123 }));

What It Enables

Structured JSON logs let you quickly find and fix issues by searching specific fields, even in huge log files.

Real Life Example

A developer notices many login failures. With JSON logs, they filter all 'login_failed' events and spot a pattern causing the problem fast.

Key Takeaways

Manual logs are messy and hard to search.

JSON structured logs organize data clearly.

This makes debugging faster and more reliable.

Practice

1. What is the main benefit of using structured logging with JSON in an Express app?

easy

A. It makes logs easy to read and parse by both humans and machines.

B. It hides all log messages from users.

C. It automatically fixes bugs in the code.

D. It slows down the server to improve security.

Solution

1. Step 1: Understand structured logging purpose

   Structured logging formats logs in a clear, consistent way using JSON.

2. Step 2: Identify benefits of JSON logs

   JSON logs are easy for both humans and machines to read and analyze quickly.

3. Final Answer:

   It makes logs easy to read and parse by both humans and machines. -> Option A

4. Quick Check:

   Structured logging = clear, readable logs [OK]

Hint: Think: JSON logs help both people and tools read logs fast [OK]

Common Mistakes:

• Confusing structured logging with hiding logs
• Assuming it fixes code bugs automatically
• Thinking it slows server for security

2. Which of the following is the correct way to log a JSON object with level and message in Express using console.log?

easy

A. console.log('{ level: "info", message: "Server started" }');

B. console.log({ level: 'info', message: 'Server started' });

C. console.log('level: info, message: Server started');

D. console.log(level = 'info', message = 'Server started');

Solution

1. Step 1: Check JSON object syntax in JavaScript

   JSON objects in JS use curly braces with key-value pairs, keys as strings or identifiers, values as strings or variables.

2. Step 2: Identify correct console.log usage

   console.log accepts an object directly to print it as JSON-like output, so console.log({ level: 'info', message: 'Server started' }); is correct.

3. Final Answer:

   console.log({ level: 'info', message: 'Server started' }); -> Option B

4. Quick Check:

   Use object syntax inside console.log [OK]

Hint: Use curly braces {} for objects inside console.log [OK]

Common Mistakes:

• Passing JSON as a string instead of object
• Using incorrect syntax with equals inside console.log
• Logging plain strings without JSON structure

3. Given the code snippet:

const log = (level, message) => {
  console.log(JSON.stringify({ level, message, timestamp: new Date().toISOString() }));
};
log('error', 'Failed to connect');

What will be the output format?

medium

A. Error: Failed to connect

B. level: error, message: Failed to connect, timestamp: 2024-06-01T12:00:00.000Z

C. [error] Failed to connect at 2024-06-01T12:00:00.000Z

D. {"level":"error","message":"Failed to connect","timestamp":"2024-06-01T12:00:00.000Z"}

Solution

1. Step 1: Understand JSON.stringify output

   JSON.stringify converts the object into a JSON string with keys and values in double quotes.

2. Step 2: Analyze the log function output

   The log function prints a JSON string with keys level, message, and timestamp in ISO format.

3. Final Answer:

   {"level":"error","message":"Failed to connect","timestamp":"2024-06-01T12:00:00.000Z"} -> Option D

4. Quick Check:

   JSON.stringify outputs JSON string [OK]

Hint: JSON.stringify outputs double-quoted JSON string [OK]

Common Mistakes:

• Expecting plain text instead of JSON string
• Confusing JSON string with object literal
• Ignoring timestamp format

4. You wrote this code to log JSON in Express:

console.log(JSON.stringify(level: 'info', message: 'Started'));

What is the error and how to fix it?

medium

A. TypeError because console.log cannot print JSON strings; fix by removing JSON.stringify.

B. No error; code logs JSON correctly.

C. SyntaxError due to incorrect JSON.stringify argument; fix by passing an object inside curly braces.

D. ReferenceError because level and message are undefined variables.

Solution

1. Step 1: Identify JSON.stringify argument syntax

   JSON.stringify expects a single object or value; here, the argument uses invalid syntax without braces.

2. Step 2: Correct the argument to an object

   Wrap the key-value pairs inside curly braces to form a valid object: { level: 'info', message: 'Started' }.

3. Final Answer:

   SyntaxError due to incorrect JSON.stringify argument; fix by passing an object inside curly braces. -> Option C

4. Quick Check:

   JSON.stringify needs an object argument [OK]

Hint: Always pass an object inside {} to JSON.stringify [OK]

Common Mistakes:

• Passing key-value pairs without braces
• Assuming JSON.stringify accepts multiple arguments
• Ignoring syntax errors in object literals

5. You want to add structured logging in Express that includes level, message, timestamp, and requestId from middleware. Which code snippet correctly logs this info?

hard

A. app.use((req, res, next) => {
console.log(JSON.stringify({ level: 'info', message: 'Request received', timestamp: new Date().toISOString(), requestId: req.id }));
next();
});

B. app.use((req, res, next) => {
console.log({ level: 'info', message: 'Request received', timestamp: new Date(), requestId: req.id });
next();
});

C. app.use((req, res, next) => {
console.log('Request received at ' + new Date() + ' with id ' + req.id);
next();
});

D. app.use((req, res, next) => {
console.log(JSON.stringify(level: 'info', message: 'Request received', timestamp: new Date().toISOString(), requestId: req.id));
next();
});

Solution

1. Step 1: Check correct JSON object syntax inside JSON.stringify

   app.use((req, res, next) => { console.log(JSON.stringify({ level: 'info', message: 'Request received', timestamp: new Date().toISOString(), requestId: req.id })); next(); }); correctly passes an object with keys and values inside curly braces to JSON.stringify.

2. Step 2: Verify inclusion of all required fields and middleware usage

   app.use((req, res, next) => { console.log(JSON.stringify({ level: 'info', message: 'Request received', timestamp: new Date().toISOString(), requestId: req.id })); next(); }); includes level, message, timestamp (ISO string), and requestId from req.id, then calls next() properly.

3. Final Answer:

   app.use((req, res, next) => { console.log(JSON.stringify({ level: 'info', message: 'Request received', timestamp: new Date().toISOString(), requestId: req.id })); next(); }); -> Option A

4. Quick Check:

   Middleware logs JSON object with all fields [OK]

Hint: Use JSON.stringify with object including all fields inside middleware [OK]

Common Mistakes:

• Passing invalid syntax to JSON.stringify
• Logging plain strings instead of JSON
• Forgetting to call next() in middleware