Azure General Troubleshooting

Quick Summary

SFTP Gateway is built from the Ubuntu 18 LTS image, and uses the default OpenSSH implementation. This article covers some general troubleshooting that you can do.

Logs

SFTP Gateway stores its application-specific logs in the following location:

/var/log/sftpgw/

Here are a few log files of interest located in this folder:

• movetos3.log: Logs file events and file copies to Blob. (Ignore the use of s3 in the name.) Use this to troubleshoot stuck files in the uploads folder.
• sftpgw-admin-api.log: Logs events of the Admin API Java backend. Check this log if the sftpgw.sh CLI or web admin interface are producing errors.
• s3sync.log: Logs events related to AzCopy sync operations for the downloads and shared folders.
• usersetup.log: Logs events related to user login.

Another useful log is:

/var/log/auth.log

This log contains events related to user authentication.

It's often useful to tail a log while an issue is happening. For example, you can run the command:

tail -f /var/log/auth.log

Hit enter a few times, and then try logging in via SFTP. You should see events specifically related to your login attempt.

Services

There are two main services used in SFTP Gateway:

• sftpgw-admin-api: This is the Java backend that supports the web admin backend and the SFTP Gateway CLI.
• incron: This is a file event service that SFTP Gateway uses to detect when a file is ready to upload to Blob.

To check on the status of a service, run the command:

systemctl status sftpgw-admin-api

If a service is down, you can restart it:

systemctl restart sftpgw-admin-api

General server health

You can check the remaining disk space with this command:

df -h

You will see the following output (there is 27 GB available):

Filesystem      Size  Used Avail Use% Mounted on
/dev/sda1        29G  2.8G   27G  10% /