Logging with structured formats in Node.js

Introduction

Logging with structured formats helps you save information in a clear, organized way. This makes it easier to find and understand what happened in your app.

When you want to track errors and events in your Node.js app clearly.

When you need to send logs to tools that analyze data automatically.

When you want to keep logs readable by both humans and machines.

When you want to include extra details like time, user ID, or request info in logs.

When debugging problems in production or development environments.

Syntax

Node.js

const logger = require('pino')();
logger.info({ key: 'value' }, 'message');

Use a logging library like pino or winston for structured logs.

Logs are usually JSON objects with keys and values for easy parsing.

Examples

This logs an info message with user and action details in JSON format.

Node.js

const pino = require('pino');
const logger = pino();
logger.info({ user: 'alice', action: 'login' }, 'User action');

This logs an error message with error code and message details.

Node.js

const pino = require('pino');
const logger = pino();
logger.error({ errorCode: 500, errorMsg: 'Server error' }, 'Error occurred');

Sample Program

This program logs three messages with structured data: info, warning, and error.

Node.js

const pino = require('pino');
const logger = pino();

logger.info({ event: 'server_start', port: 3000 }, 'Server started');
logger.warn({ memoryUsage: 'high' }, 'Memory usage warning');
logger.error({ error: 'connection_failed', retry: true }, 'Failed to connect');

Important Notes

Structured logs are usually in JSON format, which is easy for machines to read.

Use consistent keys in your logs to make searching and filtering easier.

Include timestamps and other context like process ID or hostname for better traceability.

Summary

Structured logging saves data in clear, organized JSON format.

It helps both humans and tools understand logs quickly.

Use libraries like pino in Node.js to create structured logs easily.

Practice

1. What is the main benefit of using structured logging in Node.js applications?

easy

A. Logs are stored as plain text without any format.

B. Logs are only saved in memory and not written to files.

C. Logs are encrypted automatically for security.

D. Logs are saved in a clear, organized JSON format for easy reading and processing.

Solution

1. Step 1: Understand structured logging

   Structured logging means saving logs in a format like JSON that is easy to read and parse.

2. Step 2: Identify the benefit

   This format helps both humans and tools quickly understand log data.

3. Final Answer:

   Logs are saved in a clear, organized JSON format for easy reading and processing. -> Option D

4. Quick Check:

   Structured logging = JSON format logs [OK]

Hint: Structured logs use JSON for clarity and easy parsing [OK]

Common Mistakes:

• Thinking logs are encrypted by default
• Confusing plain text logs with structured logs
• Assuming logs are only stored in memory

2. Which of the following is the correct way to create a logger using the pino library in Node.js?

easy

A. const logger = require('pino')();

B. const logger = new pino.Logger();

C. const logger = pino.create();

D. const logger = require('pino').createLogger();

Solution

1. Step 1: Recall pino import syntax

   The pino library is imported using require('pino'), which returns a function.

2. Step 2: Create logger instance

   Calling this function with () creates the logger instance: require('pino')()

3. Final Answer:

   const logger = require('pino')(); -> Option A

4. Quick Check:

   pino logger created by calling require('pino')() [OK]

Hint: Use require('pino')() to create logger instance [OK]

Common Mistakes:

• Using createLogger() which does not exist
• Trying to use new keyword with pino
• Calling pino.create() which is invalid

3. What will be the output of the following Node.js code using pino?

const pino = require('pino');
const logger = pino();
logger.info({ user: 'alice', action: 'login' }, 'User action');

medium

A. User action: user=alice, action=login

B. {"level":30,"time":<timestamp>,"msg":"User action","user":"alice","action":"login"}

C. {"message":"User action","user":"alice","action":"login"}

D. Error: Missing log level

Solution

1. Step 1: Understand pino.info() output format

   pino logs messages as JSON with fields like level, time, msg, and any extra data.

2. Step 2: Analyze given code

   Calling logger.info with an object and message logs JSON with level 30 (info), timestamp, msg, and object keys.

3. Final Answer:

   {"level":30,"time":<timestamp>,"msg":"User action","user":"alice","action":"login"} -> Option B

4. Quick Check:

   pino logs JSON with level and message [OK]

Hint: pino logs JSON with level, time, msg, and extra data [OK]

Common Mistakes:

• Expecting plain text output instead of JSON
• Confusing message key name
• Thinking log level is missing

4. Identify the error in this code snippet using pino for structured logging:

const pino = require('pino');
const logger = pino();
logger.info('User logged in', { user: 'bob' });

medium

A. The order of arguments is incorrect; the object should come first.

B. Missing semicolon after require statement.

C. pino() must be called with configuration object.

D. logger.info cannot accept two arguments.

Solution

1. Step 1: Check pino.info argument order

   pino expects the first argument as an object with extra data, second as message string.

2. Step 2: Analyze given code

   The code passes message string first, then object, which is reversed and causes wrong output.

3. Final Answer:

   The order of arguments is incorrect; the object should come first. -> Option A

4. Quick Check:

   pino.info(object, message) argument order [OK]

Hint: Pass object first, then message string to logger.info [OK]

Common Mistakes:

• Swapping message and object arguments
• Thinking semicolon is mandatory for correctness
• Assuming pino() needs config always

5. You want to log user events with structured logs including user ID, event type, and timestamp using pino. Which code snippet correctly logs this data ensuring timestamp is included in the JSON output?

hard

A. logger.info({ userId: 123, event: 'click' }, 'User event at ' + new Date());

B. logger.info('User event', { userId: 123, event: 'click', timestamp: Date.now() });

C. logger.info({ userId: 123, event: 'click', time: new Date().toISOString() }, 'User event');

D. logger.info({ userId: 123, event: 'click', timestamp: Date.now() });

Solution

1. Step 1: Ensure correct argument order and timestamp format

   pino expects object first, then message string. Timestamp should be ISO string for readability.

2. Step 2: Check each option

   logger.info({ userId: 123, event: 'click', time: new Date().toISOString() }, 'User event'); passes object with userId, event, and ISO timestamp, then message string. This is correct.

3. Final Answer:

   logger.info({ userId: 123, event: 'click', time: new Date().toISOString() }, 'User event'); -> Option C

4. Quick Check:

   Object first with ISO timestamp, then message [OK]

Hint: Pass object with ISO timestamp first, then message string [OK]

Common Mistakes:

• Swapping message and object arguments
• Using Date.now() without formatting
• Concatenating message and timestamp in string