Logging and monitoring in Ruby on Rails - Step-by-Step Execution

Concept Flow - Logging and monitoring

Start Rails app

↓

Generate log entry

↓

Write log to file or stdout

↓

Monitoring tool reads logs

↓

Analyze logs for errors or metrics

↓

Alert or dashboard update

↓

Developer or Ops team takes action

Rails app creates logs during execution, which monitoring tools read to track app health and alert teams.

Execution Sample

Ruby on Rails

Rails.logger.info "User signed in: #{user.id}"
Rails.logger.error "Payment failed: #{error.message}"
# Logs are written to log/development.log by default

This code logs info and error messages to Rails log files for monitoring app events.

Execution Table

Step	Action	Log Level	Message	Log Destination	Monitoring Reaction
1	User signs in	INFO	User signed in: 42	log/development.log	Log stored, no alert
2	Payment fails	ERROR	Payment failed: Card declined	log/development.log	Error detected, alert triggered
3	Monitoring reads logs	-	-	-	Dashboard updated with error count
4	Developer reviews alert	-	-	-	Issue diagnosed and fixed
5	Normal operation resumes	INFO	User signed in: 43	log/development.log	No alerts, system healthy

💡 Logging continues as app runs; monitoring alerts on errors to prompt action

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	After Step 4	Final
Log File	Empty	Contains info log	Contains info + error logs	Read by monitoring	Reviewed by developer	Updated with new logs
Alerts	None	None	Error alert active	Alert acknowledged	Alert resolved	No active alerts

Key Moments - 3 Insights

Why does the monitoring tool trigger an alert only after an ERROR log?

Because the monitoring tool scans logs and only triggers alerts on ERROR level messages as shown in step 2 of the execution_table.

Where are the logs stored by default in a Rails app?

Logs are stored in the log/development.log file by default, as seen in the Log Destination column in the execution_table.

What happens after the developer reviews the alert?

The developer diagnoses and fixes the issue, which stops alerts and returns the system to normal operation, shown in steps 4 and 5.

Visual Quiz - 3 Questions

Look at the execution_table, what is the log level when the payment fails?

A INFO

B ERROR

C WARN

D DEBUG

💡 Hint

Check Step 2 in the execution_table under the Log Level column.

At which step does the monitoring tool update the dashboard?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Look at the Monitoring Reaction column in the execution_table for Step 3.

If the developer fixes the issue, what happens to the alerts according to variable_tracker?

A Alerts are resolved

B Alerts increase

C Alerts remain active

D Alerts are ignored

💡 Hint

See the Alerts row in variable_tracker after Step 4 and Final.

Concept Snapshot

Rails logs events with Rails.logger at levels like INFO and ERROR.
Logs are saved in log/development.log by default.
Monitoring tools read logs to detect errors and update dashboards.
Alerts notify teams to fix issues quickly.
Logging and monitoring keep apps healthy and reliable.

Full Transcript

In Rails, logging means writing messages about app events to files like log/development.log. For example, when a user signs in, Rails.logger.info records it. If a payment fails, Rails.logger.error logs the error. Monitoring tools read these logs to find problems. When an error log appears, the tool alerts the team and updates dashboards. The team then fixes the issue, stopping alerts. This cycle helps keep the app running smoothly by tracking important events and problems.

Practice

1. What is the main purpose of logging in a Rails application?

easy

A. To record events and errors for later review

B. To monitor real-time server performance

C. To deploy the application automatically

D. To manage database migrations

Solution

1. Step 1: Understand logging purpose

   Logging captures events and errors that happen in the app so developers can check them later.

2. Step 2: Differentiate from monitoring

   Monitoring is about watching app health live, not storing past events.

3. Final Answer:

   To record events and errors for later review -> Option A

4. Quick Check:

   Logging = record events/errors [OK]

Hint: Logging saves past events; monitoring watches live [OK]

Common Mistakes:

• Confusing logging with monitoring
• Thinking logging deploys apps
• Mixing logging with database tasks

2. Which of the following is the correct way to write a log message in Rails?

easy

A. logger.write("User signed in")

B. Rails.log('info', 'User signed in')

C. log.info('User signed in')

D. Rails.logger.info "User signed in"

Solution

1. Step 1: Recall Rails logging syntax

   Rails uses Rails.logger with methods like info, error, debug to write logs.

2. Step 2: Check each option

   Only Rails.logger.info "User signed in" uses correct Rails.logger.info syntax.

3. Final Answer:

   Rails.logger.info "User signed in" -> Option D

4. Quick Check:

   Rails.logger.info is correct syntax [OK]

Hint: Use Rails.logger.method("message") for logging [OK]

Common Mistakes:

• Using undefined logger object
• Wrong method names like write or log
• Incorrect method call syntax

3. Given this Rails code snippet, what will be the log level of the message?

Rails.logger.warn "Disk space low"

medium

A. Info

B. Warn

C. Error

D. Debug

Solution

1. Step 1: Identify the logging method used

   The method called is warn, which sets the log level to warning.

2. Step 2: Match method to log level

   Rails.logger.warn writes a warning level message.

3. Final Answer:

   Warn -> Option B

4. Quick Check:

   Rails.logger.warn = Warn level [OK]

Hint: Method name matches log level (warn = Warn) [OK]

Common Mistakes:

• Confusing warn with info or error
• Assuming default log level is info
• Mixing debug and warn levels

4. You added this line in a Rails controller but no log appears:

logger.error "Payment failed"

What is the most likely reason?

medium

A. The log level is set higher than error

B. Rails.logger must be used instead of logger

C. The logger object is not defined in controllers

D. Logging is disabled by default in Rails

Solution

1. Step 1: Understand logger availability in controllers

   In Rails controllers, logger is available as a shortcut to Rails.logger.

2. Step 2: Check log level settings

   If the log level is set higher than error (like fatal), error messages won't show.

3. Final Answer:

   The log level is set higher than error -> Option A

4. Quick Check:

   Log level filters out lower severity logs [OK]

Hint: Check log level filters if logs don't appear [OK]

Common Mistakes:

• Assuming logger is undefined in controllers
• Thinking Rails.logger must be used always
• Believing logging is off by default

5. You want to monitor your Rails app's performance in production. Which approach is best?

hard

A. Use Rails built-in logger to track all performance metrics

B. Add custom puts statements in code to watch performance

C. Integrate an external monitoring tool like New Relic or Datadog

D. Rely on Rails console logs only

Solution

1. Step 1: Understand Rails logging limits

   Rails logging records events but does not provide detailed real-time performance monitoring.

2. Step 2: Identify best monitoring practice

   External tools like New Relic or Datadog specialize in monitoring app health and performance live.

3. Final Answer:

   Integrate an external monitoring tool like New Relic or Datadog -> Option C

4. Quick Check:

   Use external tools for monitoring, not just logs [OK]

Hint: Use specialized tools for monitoring, not just logs [OK]

Common Mistakes:

• Expecting Rails logger to monitor performance live
• Using puts for monitoring which is not scalable
• Ignoring external monitoring solutions