Class/Module Index [+]

Quicksearch

OpenShift::UserActionLog

Attributes

logger[RW]

Public Class Methods

action(action, status=nil, success=true, description=nil, args={}, detailed_description=nil) click to toggle source
# File lib/openshift/user_action_log.rb, line 14
def self.action(action, status=nil, success=true, description=nil, args={}, detailed_description=nil)
  return unless logger

  result = success ? "SUCCESS" : "FAILURE"
  status = status.nil? ? "unknown" : status.to_s
  description = (description || "").strip
  detailed_description = (detailed_description || "").strip
  time_obj = Time.new
  date = time_obj.strftime("%Y-%m-%d")
  time = time_obj.strftime("%H:%M:%S")
  timestamp = time_obj.to_i.to_s

  message = "RESULT=#{result} STATUS=#{status} TIMESTAMP=#{timestamp} DATE=#{date} TIME=#{time} ACTION=#{action} REQ_ID=#{Thread.current[:user_action_log_uuid]}"
  auth = " USER_ID=#{Thread.current[:user_action_log_user_id]} LOGIN=#{Thread.current[:user_action_log_identity_id]}"
  extra = args.map{|k,v| " #{k}=#{v}"}.join

  # The description has the potential to be a multi-line stack trace
  # So, we are including only the first line
  # Either ways, the reference/request ID can be used to look up the error details in the broker Rails logs 
  description = description.to_s.lines.first.strip if description.to_s.lines.count > 1

  logger.info("#{message}#{auth}#{extra} #{description}")

  unless Rails.env.production?
    # Using a block prevents the message in the block from being executed 
    # if the log_level is lower than the one set for the logger
    Rails.logger.add(Logger::DEBUG){ "  #{result} ACTION=#{action}#{auth}#{extra} #{description} #{detailed_description}" }
  end
end
begin_request(request) click to toggle source
# File lib/openshift/user_action_log.rb, line 3
def self.begin_request(request)
  Thread.current[:user_action_log_uuid] = request ? request.uuid : nil
end
end_request() click to toggle source
# File lib/openshift/user_action_log.rb, line 6
def self.end_request
  # Does not reset vars so that rescue_from handlers have access to the current log context
end
with_user(id, login) click to toggle source
# File lib/openshift/user_action_log.rb, line 9
def self.with_user(id, login)
  Thread.current[:user_action_log_user_id] = id
  Thread.current[:user_action_log_identity_id] = login
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.