JavaScript

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.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

var success = false;

var ftp = new CkFtp2();

ftp.Hostname = "ftp.example.com";
ftp.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.Password = "myPassword";

//  Keep an in-memory log of the FTP protocol conversation for troubleshooting.  Passwords are
//  not recorded in it.
ftp.KeepSessionLog = true;

success = ftp.Connect();
if (success == false) {
    console.log(ftp.LastErrorText);
    return;
}

success = ftp.ChangeRemoteDir("public_html");
if (success == false) {
    console.log(ftp.LastErrorText);
    return;
}

//  The SessionLog contains the protocol commands and server replies collected so far.
console.log(ftp.SessionLog);

success = ftp.Disconnect();
if (success == false) {
    console.log(ftp.LastErrorText);
    return;
}