sftpgo/docs/metrics.md

21 lines
1.1 KiB
Markdown
Raw Normal View History

2020-03-04 22:10:58 +00:00
# Metrics
SFTPGo supports [Prometheus](https://prometheus.io/) metrics at the `/metrics` HTTP endpoint of the telemetry server.
2020-03-04 22:10:58 +00:00
Several counters and gauges are available, for example:
- Total uploads and downloads
- Total upload and download size
- Total upload and download errors
- Total executed SSH commands
- Total SSH command errors
- Number of active connections
- Data provider availability
- Total successful and failed logins using password, public key, keyboard interactive authentication or supported multi-step authentications
2020-03-04 22:10:58 +00:00
- Total HTTP requests served and totals for response code
- Go's runtime details about GC, number of goroutines and OS threads
2020-03-04 22:10:58 +00:00
- Process information like CPU, memory, file descriptor usage and start time
2020-06-15 21:46:11 +00:00
Please check the `/metrics` page for more details.
The telemetry server is disabled by default in the released [sftpgo.json](https://raw.githubusercontent.com/drakkan/sftpgo/main/sftpgo.json). To enable look in [docs/full-configuration.md](https://raw.githubusercontent.com/drakkan/sftpgo/main/docs/full-configuration.md) for configuration details.