Merge pull request #178 from berkeley-cdss/more-logging

Reconfigure logging for clarity

Author: cycomachead

.env.example

@@ -10,9 +10,6 @@ ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY=
 ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT=
 ACTION_MAILER_DELIVERY_METHOD='sendmail' # or 'smtp'
 
-# Set to enabled/true on Heroku
-RAILS_LOG_TO_STDOUT=enabled
-
 APP_HOST=flextensions.eecs.cloud
 APP_PORT=80
 # Canvas Configuration

app/services/email_service.rb

@@ -1,7 +1,6 @@
-# app/services/email_service.rb
-##########################################################################################
-# if you want to use Letter Opener Web make sure to set ENV[ENABLE_EMAIL_SENDING] to false
-##########################################################################################
+# frozen_string_literal: true
+
+# A class for sending templated emails, using basic `{{variable}}` substitution.
 class EmailService
   class << self
     # Given a subject_template and body_template (both strings
@@ -12,7 +11,7 @@ def render_templates(subject_template, body_template, mapping)
       mapping.each_with_object(
         { subject: subject_template.dup, body: body_template.dup }
       ) do |(key, val), memo|
-        placeholder = "{{#{key}}}"
+        placeholder = /{{\s*#{key}\s*}}/i
         memo[:subject].gsub!(placeholder, val.to_s)
         memo[:body].gsub!(placeholder, val.to_s)
       end

config/environments/development.rb

@@ -95,4 +95,10 @@
   config.active_record.encryption.primary_key = 'dev-primary-key-1234567890abcdef'
   config.active_record.encryption.deterministic_key = 'dev-deterministic-key-1234567890abcdef'
   config.active_record.encryption.key_derivation_salt = 'dev-salt-1234567890abcdef'
+
+  # Setup logging with Lograge [https://github.com/roidrage/lograge]
+  # See config/initializers/lograge.rb for more details.
+  # This should normally be false in development, but set it to true to
+  # test log formatting during development.
+  config.lograge.enabled = false
 end

config/environments/production.rb

@@ -53,21 +53,23 @@
   #config.force_ssl = true
 
   # Setup logging with Lograge [https://github.com/roidrage/lograge]
+  # See config/initializers/lograge.rb for more details.
   config.lograge.enabled = true
 
-  # config.logger = ActiveSupport::Logger.new(log_dest)
+  # "info" includes generic and useful information about system operation, but avoids logging too much
+  # information to avoid inadvertent exposure of personally identifiable information (PII). If you
+  # want to log everything, set the level to "debug".
+  config.log_level = ENV.fetch("RAILS_LOG_LEVEL", "info")
+
+  # Disable query logging
+  # config.active_record.logger = nil
+  # config.logger = ActiveSupport::Logger.new(STDOUT)
   #   .tap  { |logger| logger.formatter = ::Logger::Formatter.new }
   #   .then { |logger| ActiveSupport::TaggedLogging.new(logger) }
 
-
   # # Prepend all log lines with the following tags.
   # config.log_tags = [ :request_id ]
 
-  # "info" includes generic and useful information about system operation, but avoids logging too much
-  # information to avoid inadvertent exposure of personally identifiable information (PII). If you
-  # want to log everything, set the level to "debug".
-  config.log_level = ENV.fetch("RAILS_LOG_LEVEL", "info")
-
   # Use a different cache store in production.
   # config.cache_store = :mem_cache_store
 

config/initializers/lograge.rb

@@ -1,25 +1,36 @@
-if Rails.application.config.lograge.enabled
-
-  # Log to ENVIRONMENT.rb
-  if ENV["RAILS_LOG_TO_STDOUT"] == "true"
-    log_dest = STDOUT
-  else
+Rails.application.configure do
+  log_dest = STDOUT
+  if ENV["RAILS_LOG_TO_FILE"].present?
+    # Log to environment.rb
     log_dest = Rails.root.join("log", "#{Rails.env}.log")
   end
 
-  Rails.application.configure do
+  # Basic config moved from production.rb
+  config.log_level = (ENV["LOG_LEVEL"] || "info").downcase.to_sym
+
+  if !Rails.application.config.lograge.enabled
     config.logger = ActiveSupport::Logger.new(log_dest)
+      .tap { |logger| logger.formatter = ::Logger::Formatter.new }
+      .then { |logger| ActiveSupport::TaggedLogging.new(logger) }
+
+    config.log_tags = [:request_id]
+  else
+    # This should be set before the logger is created
     config.lograge.formatter = Lograge::Formatters::Json.new
+    config.logger = ActiveSupport::Logger.new(log_dest)
     config.colorize_logging = false
-    config.lograge.ignore_actions = [ 'Rails::HealthController#show',
-      'StatusController#health_check']
+    config.lograge.ignore_actions = [
+      'Rails::HealthController#show',
+      'StatusController#health_check'
+    ]
 
     config.lograge.custom_payload do |controller|
       {
         request_id: controller.request.uuid,
         user_id: controller.current_user.try(:id)
       }
     end
+
     config.lograge.custom_options = lambda do |event|
       exceptions = %w(controller action format id)
       options = {
@@ -37,7 +48,7 @@
         options[:exception_backtrace] = event.payload[:exception_object].backtrace.join("\n")
       end
       options
-  end
+    end
 
     ActionDispatch::DebugExceptions.register_interceptor do |request, exception|
       case exception