Method: OpenC3.write_exception_file

Defined in:

lib/openc3/top_level.rb

.write_exception_file(exception, filename = 'exception', log_dir = nil) ⇒ String|nil

Writes a log file with information about the current configuration including the Ruby version, OpenC3 version, whether you are on Windows, the OpenC3 path, and the Ruby path along with the exception that is passed in.

Parameters:

• filename (String) (defaults to: 'exception') —

  String to append to the exception log filename. The filename will start with a date/time stamp.

• log_dir (String) (defaults to: nil) —

  By default this method will write to the OpenC3 default log directory. By setting this parameter you can override the directory the log will be written to.

Returns:

• (String|nil) —

  The fully pathed log filename or nil if there was an error creating the log file.

# File 'lib/openc3/top_level.rb', line 286

def self.write_exception_file(exception, filename = 'exception', log_dir = nil)
  log_file = create_log_file(filename, log_dir) do |file|
    file.puts "Exception:"
    if exception
      file.puts exception.formatted
      file.puts
    else
      file.puts "No Exception Given"
      file.puts caller.join("\n")
      file.puts
    end
    file.puts "Caller Backtrace:"
    file.puts caller().join("\n")
    file.puts

    file.puts "Ruby Version: ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE} patchlevel #{RUBY_PATCHLEVEL}) [#{RUBY_PLATFORM}]"
    file.puts "Rubygems Version: #{Gem::VERSION}"
    file.puts "OpenC3 Version: #{OpenC3::VERSION}"
    file.puts "OpenC3::PATH: #{OpenC3::PATH}"
    file.puts ""
    file.puts "Environment:"
    file.puts "RUBYOPT: #{ENV['RUBYOPT']}"
    file.puts "RUBYLIB: #{ENV['RUBYLIB']}"
    file.puts "GEM_PATH: #{ENV['GEM_PATH']}"
    file.puts "GEMRC: #{ENV['GEMRC']}"
    file.puts "RI_DEVKIT: #{ENV['RI_DEVKIT']}"
    file.puts "GEM_HOME: #{ENV['GEM_HOME']}"
    file.puts "PATH: #{ENV['PATH']}"
    file.puts ""
    file.puts "Ruby Path:\n  #{$:.join("\n  ")}\n\n"
    file.puts "Gems:"
    Gem.loaded_specs.values.map { |x| file.puts "#{x.name} #{x.version} #{x.platform}" }
    file.puts ""
    file.puts "All Threads Backtraces:"
    Thread.list.each do |thread|
      file.puts thread.backtrace.join("\n")
      file.puts
    end
    file.puts ""
    file.puts ""
  ensure
    file.close
  end
  return log_file
end