{"id":24756329,"url":"https://github.com/dalance/softether_exporter","last_synced_at":"2025-04-06T22:09:33.136Z","repository":{"id":28419706,"uuid":"118236412","full_name":"dalance/softether_exporter","owner":"dalance","description":"Prometheus Exporter of SoftEther VPN Server","archived":false,"fork":false,"pushed_at":"2025-03-10T20:44:09.000Z","size":699,"stargazers_count":34,"open_issues_count":4,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-30T21:07:45.805Z","etag":null,"topics":["prometheus-exporter","rust"],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dalance.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"dalance"}},"created_at":"2018-01-20T11:24:49.000Z","updated_at":"2025-03-10T20:44:06.000Z","dependencies_parsed_at":"2023-11-07T03:11:49.575Z","dependency_job_id":"1f778b98-4ea2-40d9-8524-da469340fb2d","html_url":"https://github.com/dalance/softether_exporter","commit_stats":{"total_commits":193,"total_committers":3,"mean_commits":64.33333333333333,"dds":0.5025906735751295,"last_synced_commit":"ccc0c88d625aa1459a6d4bee9267d2ade1d2907e"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dalance%2Fsoftether_exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dalance%2Fsoftether_exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dalance%2Fsoftether_exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dalance%2Fsoftether_exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dalance","download_url":"https://codeload.github.com/dalance/softether_exporter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247557767,"owners_count":20958047,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["prometheus-exporter","rust"],"created_at":"2025-01-28T13:50:51.714Z","updated_at":"2025-04-06T22:09:33.117Z","avatar_url":"https://github.com/dalance.png","language":"Rust","funding_links":["https://github.com/sponsors/dalance"],"categories":[],"sub_categories":[],"readme":"# softether_exporter\n[Prometheus](https://prometheus.io) exporter for [SoftEther VPN server](http://www.softether.org)\n\n[![Actions Status](https://github.com/dalance/softether_exporter/workflows/Regression/badge.svg)](https://github.com/dalance/softether_exporter/actions)\n[![Crates.io](https://img.shields.io/crates/v/softether_exporter.svg)](https://crates.io/crates/softether_exporter)\n\n![screenshot](./grafana/screenshot.png)\n\n## Exported Metrics\n\n| metric                               | description                            | labels                         |\n| ------------------------------------ | -------------------------------------- | ------------------------------ |\n| softether_up                         | The last query is successful           | hub                            |\n| softether_online                     | Hub is online                          | hub                            |\n| softether_sessions                   | Number of sessions                     | hub                            |\n| softether_sessions_client            | Number of client sessions              | hub                            |\n| softether_sessions_bridge            | Number of bridge sessions              | hub                            |\n| softether_users                      | Number of users                        | hub                            |\n| softether_groups                     | Number of groups                       | hub                            |\n| softether_mac_tables                 | Number of entries in MAC table         | hub                            |\n| softether_ip_tables                  | Number of entries in IP table          | hub                            |\n| softether_logins                     | Number of logins                       | hub                            |\n| softether_outgoing_unicast_packets   | Outgoing unicast transfer in packets   | hub                            |\n| softether_outgoing_unicast_bytes     | Outgoing unicast transfer in bytes     | hub                            |\n| softether_outgoing_broadcast_packets | Outgoing broadcast transfer in packets | hub                            |\n| softether_outgoing_broadcast_bytes   | Outgoing broadcast transfer in bytes   | hub                            |\n| softether_incoming_unicast_packets   | Incoming unicast transfer in packets   | hub                            |\n| softether_incoming_unicast_bytes     | Incoming unicast transfer in bytes     | hub                            |\n| softether_incoming_broadcast_packets | Incoming broadcast transfer in packets | hub                            |\n| softether_incoming_broadcast_bytes   | Incoming broadcast transfer in bytes   | hub                            |\n| softether_build_info                 | softether_exporter Build information   | version, revision, rustversion |\n| softether_user_transfer_packets      | User transfer in packets               | hub, user                      |\n| softether_user_transfer_bytes        | User transfer in bytes                 | hub, user                      |\n\n## Query Example\n\nOutgoing unicast packet rate of HUB1 is below.\n\n```\nrate(softether_outgoing_unicast_packets{hub=\"HUB1\"}[1m])\n```\n\n## Grafana Dashboard\n\n[SoftEther VPN](https://grafana.com/grafana/dashboards/12053)\n\n## Install\nDownload from [release page](https://github.com/dalance/softether_exporter/releases/latest), and extract to any directory ( e.g. `/usr/local/bin` ).\nSee the example files in `example` directory as below.\n\n| File                               | Description                    |\n| ---------------------------------- | ------------------------------ |\n| example/softether_exporter.service | systemd unit file              |\n| example/config.toml                | softether_exporter config file |\n\n\nIf the release build doesn't fit your environment, you can build and install from source code.\n\n```\ncargo install softether_exporter\n```\n\n## Requirement\n\nsoftether_exporter uses `vpncmd` or `vpncmd.exe` to access SoftEther VPN server.\nThe binary can be got from [SoftEther VPN Download](http://www.softether-download.com/?product=softether).\n\n## Usage\n\n```\nsoftether_exporter 0.1.5\n\nUSAGE:\n    softether_exporter [FLAGS] [OPTIONS] --config.file \u003cconfig\u003e\n\nFLAGS:\n    -v, --verbose    Show verbose message\n    -h, --help       Prints help information\n    -V, --version    Prints version information\n\nOPTIONS:\n        --web.listen-address \u003clisten-address\u003e\n            Address on which to expose metrics and web interface [default: :9411]\n\n        --config.file \u003cconfig\u003e                   Config file\n```\n\nThe format of `\u003cconfig\u003e` is below.\n\n```\nvpncmd = \"/usr/local/bin/vpncmd\" # path to vpncmd binary\nserver = \"localhost:8888\"        # address:port of SoftEther VPN server\n\n[[hubs]]\nname     = \"HUB1\" # HUB name\npassword = \"xxx\"  # HUB password\n\n[[hubs]]\nname     = \"HUB2\"\npassword = \"yyy\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdalance%2Fsoftether_exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdalance%2Fsoftether_exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdalance%2Fsoftether_exporter/lists"}