SFTP Monitor

Introduction

The implementation of SFTP Monitoring aims to track the availability, performance, and health of SFTP services that are critical for secure file transfers in the organization. This includes monitoring the uptime, latency, errors, and other key performance indicators (KPIs) of the SFTP servers. The monitoring is done through synthetic execution of various sftp operations against the SFTP Servers.

Getting Started

Compatibility

The SFTP Monitor is compatible with environments that support Secure File Transfer Protocol (SFTP) and can be accessed via SSH-based authentication methods, including password and private key authentication.

Data Collection Method

The SFTP Monitor utilizes the vuSmartMaps internal agent to collect metrics from remote SFTP servers. The agent performs synthetic transactions by establishing an SFTP connection to the target server, executing authentication, and measuring key performance indicators (KPIs) such as connection time, login time, response time, upload/download speed, and transfer rates.

Prerequisites

Dependent Configuration

To configure this O11ySource, create a 'credential' of type 'ssh' under the 'Definition' tab.

Inputs for Configuring Data Source

• SFTP Server: The SFTP Server's IP address/FQDN
• SFTP Port: The port to connect to the SFTP server
• Credential: Username,password or key to authenticate the SFTP server
• SFTP Path: The destination path where synthetic file upload and download operations will be performed.
• Interval (in seconds): Time interval for polling data from the SFTP Server. Period should be between 60 seconds – 3000 seconds.

Firewall Requirement

To collect data from this O11ySource, ensure the following ports are opened:

Source IP	Destination IP	Destination Port	Protocol	Direction
vuSmartMaps IP	SFTP IP	22*	TCP	Outbound

*Before providing the firewall requirements, please update the port based on the customer environment.

Configuring the Target

The SFTP Monitor connects to remote SFTP servers without requiring additional configurations on the target system, as long as the following prerequisites are met:

• A valid SFTP user account with appropriate permissions to authenticate and perform file operations.
• Either password-based authentication or key-based authentication enabled.
• The configured user must have read/write access to the specified remote directory for synthetic file transfers.

Configuration Steps

• Enable the O11ySource.
• Select the sources tab and press the + button to add a new instance that has to be monitored.
• Provide the required configurations:
• *SFTP Server
• *SFTP Port
• *Credential
• *SFTP Path
• *Interval (in seconds)
• Click Save to close the data source window.

Metrics Collected

Name	Description	Data Type
timestamp	Precise timestamp of the agent with milliseconds	DateTime64(3)
connection_time_seconds	Time taken to establish SFTP connection.	Float32
login_time_seconds	Time taken to authenticate after connection.	Float32
upload_time_seconds	Time taken to upload the test file.	Float32
download_time_seconds	Time taken to download the test file.	Float32
upload_rate_bytes_per_second	Upload speed in bytes per second.	Float32
download_rate_bytes_per_second	Download speed in bytes per second.	Float32
size_in_bytes	Size of the test file transferred.	Float32
status	Overall connection status (OK, Warning, Critical).	String
message	The Message when there is an error with the connection	String
response_time_seconds	The overall response time	Float32
total_transfer_rate_bytes_per_second	The combined speed of data transferred in both directions.	Float32
target	The SFTP Server	String
port	The SFTP Port	String
ftp_file_operation_status	The status of the synthetic file operations(OK, Warning, Critical).	String
ftp_file_operation_message	The status message of the synthetic file operations	String