Ruby

Capture the FTP Session Log

Demonstrates the SessionLog property (with KeepSessionLog), which holds the in-memory FTP protocol conversation — commands and server replies — collected during the session.

Background: When an FTP operation fails for a non-obvious reason, the exact command/reply exchange is the most useful diagnostic there is, and SessionLog captures it verbatim once KeepSessionLog is enabled. Passwords are omitted, so it is safe to log or attach to a bug report. Over a long session it grows without bound; clear it with ClearSessionLog to bound memory or to isolate the log for one operation.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

ftp = Chilkat::CkFtp2.new()

ftp.put_Hostname("ftp.example.com")
ftp.put_Username("myFtpLogin")

#  Normally you would not hard-code the password in source.  You should instead obtain it
#  from an interactive prompt, environment variable, or a secrets vault.
ftp.put_Password("myPassword")

#  Keep an in-memory log of the FTP protocol conversation for troubleshooting.  Passwords are
#  not recorded in it.
ftp.put_KeepSessionLog(true)

success = ftp.Connect()
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end

success = ftp.ChangeRemoteDir("public_html")
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end

#  The SessionLog contains the protocol commands and server replies collected so far.
print ftp.sessionLog() + "\n";

success = ftp.Disconnect()
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end