Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arunvelsriram/sftp-exporter
Prometheus Exporter for SFTP server
https://github.com/arunvelsriram/sftp-exporter
grafana grafana-dashboard prometheus-exporter sftp
Last synced: 21 days ago
JSON representation
Prometheus Exporter for SFTP server
- Host: GitHub
- URL: https://github.com/arunvelsriram/sftp-exporter
- Owner: arunvelsriram
- Created: 2020-08-12T18:31:29.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-25T15:59:32.000Z (3 months ago)
- Last Synced: 2024-07-25T20:58:27.094Z (3 months ago)
- Topics: grafana, grafana-dashboard, prometheus-exporter, sftp
- Language: Go
- Homepage:
- Size: 538 KB
- Stars: 15
- Watchers: 4
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sftp-exporter
[Prometheus Exporter](https://prometheus.io/docs/instrumenting/exporters/) for [SFTP](https://www.ssh.com/ssh/sftp/) server.
[](https://app.travis-ci.com/arunvelsriram/sftp-exporter)
## Docker Image
[arunvelsriram/sftp-exporter](https://hub.docker.com/r/arunvelsriram/sftp-exporter)
```shell
docker pull arunvelsriram/sftp-exporter
```
## Configurations
Configurations can be provided in various ways.
### Command-line Flags
```
Prometheus Exporter for SFTP.
Usage:
sftp-exporter [flags]
sftp-exporter [command]
Available Commands:
help Help about any command
version Prints the current version
Flags:
--bind-address string exporter bind address (default "127.0.0.1")
-c, --config-file string exporter config file (default "sftp-exporter.yaml")
-h, --help help for sftp-exporter
--log-level string log level [panic | fatal | error | warning | info | debug | trace] (default "info")
--port int exporter port (default 8080)
--sftp-host string SFTP host (default "localhost")
--sftp-key string SFTP key (base64 encoded)
--sftp-key-passphrase string SFTP key passphrase
--sftp-password string SFTP password
--sftp-paths strings SFTP paths (default [/])
--sftp-port int SFTP port (default 22)
--sftp-user string SFTP user
Use "sftp-exporter [command] --help" for more information about a command.
```
### Environment Variables
Configs can be passed using environment variables. For example:
```
$ SFTP_HOST=example.com SFTP_PORT=22 SFTP_USER=example SFTP_PASSWORD=password ./sftp-exporter
```
### Config File
Sample config file: [`sftp-exporter.yaml`](sftp-exporter.yaml)
By default `sftp-exporter` looks for a config file named `sftp-exporter.yaml` in the PWD. Custom config file can be provided using `--config-file` flag.
>Order of precedence: Flags > Environment variables > Config file
## Metrics
```
# HELP sftp_filesystem_free_space_bytes Free space in the filesystem containing the path
# TYPE sftp_filesystem_free_space_bytes gauge
sftp_filesystem_free_space_bytes{path="/upload1"} 7.370901504e+10
sftp_filesystem_free_space_bytes{path="/upload2"} 7.370901504e+10
# HELP sftp_filesystem_total_space_bytes Total space in the filesystem containing the path
# TYPE sftp_filesystem_total_space_bytes gauge
sftp_filesystem_total_space_bytes{path="/upload1"} 8.4281810944e+10
sftp_filesystem_total_space_bytes{path="/upload2"} 8.4281810944e+10
# HELP sftp_objects_available Number of objects in the path
# TYPE sftp_objects_available gauge
sftp_objects_available{path="/upload1"} 1
sftp_objects_available{path="/upload2"} 3
# HELP sftp_objects_total_size_bytes Total size of all the objects in the path
# TYPE sftp_objects_total_size_bytes gauge
sftp_objects_total_size_bytes{path="/upload1"} 312
sftp_objects_total_size_bytes{path="/upload2"} 2337
# HELP sftp_up Tells if exporter is able to connect to SFTP
# TYPE sftp_up gauge
sftp_up 1
```
## Grafana Dashboard
[Grafana Dashoard](https://grafana.com/grafana/dashboards/12828)
## Contributing
### Development Setup
Starts sftp-servers, prometheus, grafana and sftp-exporter:
```shell
cd playground
docker-compose up
```
| App | URL | Credentials |
|---------------------------|----------------------------|-----------------------------------------------------------------------------------------------------|
| Grafana | http://localhost:3000 | **User:** admin **Password:** password |
| Prometheus | http://localhost:9090 | NA |
| SFTP Basic Auth | localhost:2220 | **User:** foo **Password:** password |
| SFTP Key Auth | localhost:2221 | **Private Key:** [key_with_passphrase](./playground/ssh/key_with_passphrase) / [key_without_passphrase](./playground/ssh/key_without_passphrase) |
| SFTP Basic and Key Auth | localhost:2222 | **Private Key:** [key_with_passphrase](./playground/ssh/key_with_passphrase) / [key_without_passphrase](./playground/ssh/key_without_passphrase) |
| SFTP Exporter | http://localhost:8081 | **User:** foo **Password:** password **Private Key:** [key_with_passphrase](./playground/ssh/key_with_passphrase) / [key_without_passphrase](./playground/ssh/key_without_passphrase) |