softether_exporter

Prometheus exporter of SoftEther VPN server

Description

softether_exporter is a prometheus exporter for SoftEther VPN server. The provided metrics are below.

softether_online softether_sessions_total softether_sessions_client_total softether_sessions_bridge_total softether_users_total softether_groups_total softether_mac_tables_total softether_ip_tables_total softether_logins_total softether_outgoing_unicast_packets softether_outgoing_unicast_bytes softether_outgoing_broadcast_packets softether_outgoing_broadcast_bytes softether_incoming_unicast_packets softether_incoming_unicast_bytes softether_incoming_broadcast_packets softether_incoming_broadcast_bytes

Each metrics has hub label. For example, outgoing unicast packet rate of HUB1 is below.

rate(softether_outgoing_unicast_packets{hub="HUB1"}[1m])

Install

Download from release page, and extract to any directory ( e.g. /usr/local/bin ). See the example files: example/softether_exporter.service and example/config.toml

If the release build doesn't fit your environment, you can build and install from source code.

cargo install softether_exporter

Requirement

softether_exporter uses vpncmd or vpncmd.exe to access SoftEther VPN server. The binary can be got from SoftEther VPN Download.

Usage

softether_exporter [config_file]

The format of config_file is below.

``` listenport = 9411 # listenport of expoter ( 9411 is the default port of softether_exporter ) vpncmd = "/usr/local/bin/vpncmd" # path to vpncmd binary server = "localhost:8888" # address:port of SoftEther VPN server

[[hubs]] name = "HUB1" # HUB name password = "xxx" # HUB password

[[hubs]] name = "HUB2" password = "yyy" ```