The IPSec Prometheus exporter subscribes to the strongSwan via Vici API and exposes Security Associations (SAs) metrics.
Collected metrics (together with application metrics) are exposed on /metrics
endpoint. Prometheus target is then configured with this endpoint and port e.g. http://localhost:8079/metrics
.
IPSec Prometheus exporter is configured via command-line arguments. If not provided, the default values are used.
If the default value match with your choice you can omit it.
Options and default values:
--server-port=8079 Application port where the collected metrics are available
--log-level=info Logging level (debug, info, warn, error)
--vici-network=tcp Vici network scheme (tcp, udp, unix)
--vici-address=localhost:4502 IP address or hostname with a port or unix socket path
IPv6 is supported. Use address in format of "[fd12:3456:789a::1]:4502"
Metric | Value | Description |
---|---|---|
strongswan_*_status | 0 | The tunnel is installed and is up and running. |
strongswan_*_status | 1 | The connection is established. |
strongswan_*_status | 2 | The tunnel or connection is down. |
strongswan_*_status | 3 | The tunnel or connection status is not recognized. |
To build the binary run:
make build
Run the binary with optional arguments provided:
./ipsec-prometheus-exporter [--server-port=8079] [--log-level=info] [--vici-network=tcp] [--vici-address=localhost:4502]
Public docker image is available for multiple platforms: https://hub.docker.com/r/torilabs/ipsec-prometheus-exporter
docker run -it -p 8079:8079 --rm torilabs/ipsec-prometheus-exporter:latest --server-port=8079