Log format customization in Nginx - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of customizing log formats in nginx?

Customizing log formats in nginx helps you record exactly the information you need about requests, making it easier to analyze traffic, debug issues, and monitor performance.

beginner

Which nginx directive is used to define a custom log format?

The log_format directive is used to define a custom log format in nginx.

intermediate

How do you apply a custom log format to an access log in nginx?

You apply a custom log format by specifying its name in the access_log directive, like access_log /path/to/log custom_format_name;.

beginner

What does the variable $remote_addr represent in nginx log formats?

$remote_addr represents the IP address of the client making the request.

intermediate

Give an example of a simple custom log format that logs client IP, request method, and request URI.

Example:
log_format simple '$remote_addr - $request_method $request_uri';

Which directive defines a custom log format in nginx?

A log_format

B access_log

C error_log

D server_name

The log_format directive is used to create custom log formats.

How do you tell nginx to use a custom log format for access logs?

A By naming the format in the access_log directive

B By setting error_log to the format name

C By using the server_name directive

D By editing the nginx.conf file header

You specify the custom format name in the access_log directive.

What does $request_uri log in nginx?

A The HTTP response status code

B The full original request URI including arguments

C The client's IP address

D The server's hostname

$request_uri logs the full URI requested by the client.

Which variable logs the client's IP address in nginx logs?

A $request_method

B $server_addr

C $host

D $remote_addr

$remote_addr holds the client's IP address.

If you want to log the HTTP method used by the client, which variable do you use?

A $body_bytes_sent

B $status

C $request_method

D $remote_user

$request_method logs the HTTP method like GET or POST.

Explain how to create and apply a custom log format in nginx.

Think about defining the format first, then telling nginx to use it.

List common nginx variables used in custom log formats and what they represent.

Focus on variables that describe the request and response.

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