sftpgo-mirror/docs/metrics.md

# Metrics

SFTPGo supports [Prometheus](https://prometheus.io/) 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](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.
Refactor docs 2020-03-04 22:10:58 +00:00			`# Metrics`

move IP/Network lists to the data provider this is a backward incompatible change, all previous file based IP/network lists will not work anymore Signed-off-by: Nicola Murino <nicola.murino@gmail.com> 2023-02-09 08:33:33 +00:00			SFTPGo supports [Prometheus](https://prometheus.io/) metrics at the `/metrics` HTTP endpoint of the telemetry server.
Refactor docs 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`
add support for partial authentication Multi-step authentication is activated disabling all single-step auth methods for a given user 2020-04-09 21:32:42 +00:00			`- Total successful and failed logins using password, public key, keyboard interactive authentication or supported multi-step authentications`
Refactor docs 2020-03-04 22:10:58 +00:00			`- Total HTTP requests served and totals for response code`
Updating typos in openapi/swagger documentation as well as various markdown documentation files (#816) Signed-off-by: Dylan Legendre <dylanlegendre09@gmail.com> 2022-05-05 16:26:22 +00:00			`- Go's runtime details about GC, number of goroutines and OS threads`
Refactor docs 2020-03-04 22:10:58 +00:00			`- Process information like CPU, memory, file descriptor usage and start time`

docs: fix markdown lint warnings 2020-06-15 21:46:11 +00:00			Please check the `/metrics` page for more details.
telemetry server: add optional https and authentication 2020-12-18 15:04:42 +00:00
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 09:12:53 +00:00			`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.`