beenull/sftpgo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
sftpgo/docs/metrics.md
Jon Bendtsen 6b555cf0d8 metrics only available in telemetry server 
I do not know which version removed /metrics from the HTTP server, but it does not seem to be available in 2.4.2, so I updated the metrics documentation to reflect this. Replaced with links to telemetry configuration.

Signed-off-by: Jon Bendtsen <github@jonb.dk>
2023-01-03 10:27:15 +01:00

1.1 KiB
Raw Blame History

Metrics

SFTPGo exposes Prometheus metrics at the /metrics HTTP endpoint of the telemetry server. 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
  • Total HTTP requests served and totals for response code
  • Go's runtime details about GC, number of goroutines and OS threads
  • Process information like CPU, memory, file descriptor usage and start time

Please check the /metrics page for more details.

The telemetry server is disabled by default in the released sftpgo.json. To enable look in docs/full-configuration.md for configuration details.