Log format customization in Nginx - Practice Problems & Coding Challenges

Challenge - 5 Problems

💻 Command Output

intermediate

What is the output of this custom log format directive?

Given the following nginx log_format directive, what will be the logged output for a request with remote_addr 192.168.1.10, request_method GET, and request_uri /home?

Nginx

log_format custom '$remote_addr - $request_method "$request_uri"';
access_log /var/log/nginx/access.log custom;

A 192.168.1.10 GET /home

B 192.168.1.10 - GET /home

C 192.168.1.10 - GET "/home"

D 192.168.1.10 - "GET" "/home"

💡 Hint

Look carefully at the quotes and dashes in the log_format string.

The log_format directive uses single quotes around the whole format and double quotes around $request_uri. The dash and spaces are literal. So the output includes the dash and quotes exactly as specified.

❓ Configuration

intermediate

Which log_format directive correctly logs the request time in seconds with millisecond precision?

You want to log the request processing time in seconds with millisecond precision using the variable $request_time. Which of the following log_format directives achieves this?

A log_format timed '$remote_addr - $request_time';

B log_format timed '$remote_addr - $request_time ms';

C log_format timed '$remote_addr - $request_time seconds';

D log_format timed '$remote_addr - $request_time'; # $request_time is in seconds with milliseconds

💡 Hint

Remember that $request_time already includes seconds with milliseconds as a decimal number.

The variable $request_time in nginx logs the request processing time in seconds with millisecond precision as a decimal number. Adding units like 'ms' or 'seconds' as text is optional but must be consistent with the value meaning.

❓ Troubleshoot

advanced

Why does this custom log format cause nginx to fail to start?

Consider this nginx configuration snippet: log_format broken '$remote_addr - $request_method $request_uri; access_log /var/log/nginx/access.log broken; Why does nginx fail to start with this configuration?

Nginx

log_format broken '$remote_addr - $request_method $request_uri;
access_log /var/log/nginx/access.log broken;

A The variable $request_uri is invalid in log_format and causes failure.

B Missing closing single quote in the log_format directive causes a syntax error.

C The access_log path is incorrect and prevents nginx from starting.

D The log_format name 'broken' is a reserved keyword and cannot be used.

💡 Hint

Check the quotes carefully in the log_format directive.

The log_format directive string is missing the closing single quote at the end, causing nginx to fail parsing the configuration.

🔀 Workflow

advanced

What is the correct sequence to apply a new custom log format without downtime?

You created a new log_format named 'detailed' in nginx.conf. What is the correct workflow to apply this change without dropping active connections?

A 3,1,2,4

B 1,3,2,4

C 3,2,1,4

D 1,2,3,4

💡 Hint

You must edit config before testing syntax.

First edit the config to add the new log_format and update access_log. Then test syntax with 'nginx -t'. If syntax is OK, reload nginx with 'nginx -s reload' to apply changes without downtime. Finally, verify logs.

✅ Best Practice

expert

Which custom log format best balances detailed info and log file size?

You want a custom nginx log format that logs client IP, request method, URI, status code, and request time, but avoids logging headers or cookies to keep log size manageable. Which option is best?

A log_format balanced '$remote_addr - $request_method "$request_uri" $status $request_time';

B log_format balanced '$remote_addr - $request_method "$request_uri" $status $request_time "$http_user_agent" "$http_cookie"';

C log_format balanced '$remote_addr - $request_method "$request_uri" $status $request_time $request_length';

D log_format balanced '$remote_addr - $request_method "$request_uri" $status $request_time "$http_referer"';

💡 Hint

Avoid logging headers or cookies to reduce log size.

Option A logs essential info without extra headers or cookies, keeping logs concise. Options B and C add headers/cookies increasing size. Option A adds request_length which may not be necessary.

Practice

1. What is the purpose of the log_format directive in nginx?

easy

A. To define a custom format for access logs

B. To specify the location of error logs

C. To enable SSL encryption for logs

D. To set the maximum size of log files

Solution

1. Step 1: Understand the role of log_format

   The log_format directive lets you create a custom pattern for how nginx records access logs.

2. Step 2: Differentiate from other logging directives

   Other directives like error_log set error log location, not format. log_format is specifically for access log formatting.

3. Final Answer:

   To define a custom format for access logs -> Option A

4. Quick Check:

   log_format = custom access log format [OK]

Hint: log_format sets how access logs look, not location [OK]

Common Mistakes:

• Confusing log_format with error_log
• Thinking log_format sets log file size
• Assuming log_format enables encryption

2. Which of the following is the correct syntax to define a custom log format named myformat that logs the client IP and request URI?

easy

A. log_format myformat = '$remote_addr $request_uri';

B. log_format myformat '$remote_addr $request_uri';

C. log_format myformat { $remote_addr $request_uri };

D. log_format myformat: '$remote_addr $request_uri';

Solution

1. Step 1: Recall correct log_format syntax

   The correct syntax uses log_format name 'format_string'; with single quotes around variables.

2. Step 2: Identify correct option

   log_format myformat '$remote_addr $request_uri'; matches this syntax exactly. Other options use invalid braces, equals, or colons.

3. Final Answer:

   log_format myformat '$remote_addr $request_uri'; -> Option B

4. Quick Check:

   Correct syntax uses single quotes and semicolon [OK]

Hint: Use single quotes and semicolon for log_format [OK]

Common Mistakes:

• Using braces {} instead of quotes
• Adding equals sign = incorrectly
• Using colon : after format name

3. Given this nginx configuration snippet:

log_format custom '$remote_addr - $remote_user [$time_local] "$request" $status';
access_log /var/log/nginx/access.log custom;

What will be the output format of each log entry?

medium

A. Status code - Client IP [time] "request" user

B. User - Client IP [time] "request" status code

C. Client IP - user [time] "request" status code

D. Request - Client IP [time] "user" status code

Solution

1. Step 1: Analyze the log_format string

   The format is: $remote_addr - $remote_user [$time_local] "$request" $status. This means client IP, dash, user, time, request, and status code in order.

2. Step 2: Match format to options

   Client IP - user [time] "request" status code correctly describes the order and content of the log entry.

3. Final Answer:

   Client IP - user [time] "request" status code -> Option C

4. Quick Check:

   Variables order matches Client IP - user [time] "request" status code [OK]

Hint: Match variables order exactly to format string [OK]

Common Mistakes:

• Mixing order of variables
• Confusing $remote_user with $remote_addr
• Ignoring quotes around $request

4. You wrote this configuration:

log_format mylog $remote_addr - $request_uri

But nginx fails to start. What is the error?

medium

A. Missing semicolon at the end

B. Missing quotes around the log format string

C. Incorrect variable name $request_uri

D. log_format directive cannot be used in http block

Solution

1. Step 1: Check syntax requirements for log_format

   The log_format directive must end with a semicolon (;).

2. Step 2: Identify the error in given config

   The string lacks the terminating semicolon, causing a syntax error.

3. Final Answer:

   Missing semicolon at the end -> Option A

4. Quick Check:

   Semicolon terminates the directive [OK]

Hint: Every nginx directive ends with semicolon [OK]

Common Mistakes:

• Forgetting quotes around format string
• Using wrong variable names
• Omitting semicolon

5. You want to log the client IP, request method, and response time in seconds with 3 decimal places. Which custom log_format definition achieves this?

hard

A. log_format timed '$remote_addr $request_method $request_time';
access_log /var/log/nginx/timed.log timed if=$request_time;

B. log_format timed '$remote_addr $request_method $request_time sec';

C. log_format timed '$remote_addr $request_method $request_time';

D. log_format timed '$remote_addr $request_method $request_time';
access_log /var/log/nginx/timed.log timed;

Solution

1. Step 1: Define log_format with required variables

   Use $remote_addr for client IP, $request_method for method, and $request_time for response time with decimals.

2. Step 2: Apply the custom format in access_log

   To activate the format, use access_log with the format name and log file path.

3. Final Answer:

   log_format timed '$remote_addr $request_method $request_time'; access_log /var/log/nginx/timed.log timed; -> Option D

4. Quick Check:

   Define format and apply with access_log [OK]

Hint: Define format then apply with access_log [OK]

Common Mistakes:

• Not applying log_format with access_log
• Adding unnecessary text inside format
• Using invalid if condition in access_log