Logging and monitoring in Ruby on Rails - Cheat Sheet & Quick Revision

Recall & Review

beginner

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

Logging records important events and errors in the application to help developers understand what happened and diagnose issues.

beginner

Name two common types of logs generated by Rails.

1. Development logs - show detailed info during development.
2. Production logs - show important events and errors in live apps.

beginner

What is monitoring in the context of a Rails app?

Monitoring means watching the app’s health and performance over time to catch problems early and keep it running smoothly.

beginner

How can you view Rails logs in development mode?

You can see logs in the terminal where you run the Rails server or check the log/development.log file.

beginner

Why is it important to monitor error rates in a Rails app?

Because a sudden increase in errors can mean something is broken, so you can fix it quickly before users are affected.

Where are Rails logs stored by default?

A config/ directory

B log/ directory

C app/ directory

D public/ directory

Rails saves logs in the log/ directory, like log/development.log or log/production.log.

Which Rails component helps you write logs in your code?

A ActiveRecord

B ActionController

C ActionMailer

D Rails.logger

Rails.logger is used to write messages to the log files.

What does monitoring NOT typically include?

A Writing new features

B Watching error rates

C Tracking app performance

D Checking server health

Writing new features is development, not monitoring.

Which log level shows the most detailed information?

A DEBUG

B INFO

C ERROR

D WARN

DEBUG level logs show the most detailed info useful during development.

Why should production logs be less detailed than development logs?

A Because production logs are not important

B Because errors never happen in production

C To save disk space and improve performance

D To confuse attackers

Less detail in production logs helps save space and keeps the app fast.

Explain how logging and monitoring work together to keep a Rails app healthy.

Think about how logs are like a diary and monitoring is like a doctor checking the app’s health.

Describe how you would check for errors in a Rails app running in production.

Consider both manual log checking and automated monitoring.

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