https://github.com/torilabs/ipsec-prometheus-exporter
Prometheus exporter for strongSwan IPsec
https://github.com/torilabs/ipsec-prometheus-exporter
Last synced: 3 months ago
JSON representation
Prometheus exporter for strongSwan IPsec
- Host: GitHub
- URL: https://github.com/torilabs/ipsec-prometheus-exporter
- Owner: torilabs
- License: mit
- Created: 2024-01-05T20:22:15.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-03T15:52:01.000Z (8 months ago)
- Last Synced: 2024-11-03T16:27:27.630Z (8 months ago)
- Language: Go
- Homepage:
- Size: 59.6 KB
- Stars: 5
- Watchers: 1
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IPSec Prometheus Exporter
_The IPSec Prometheus exporter subscribes to the strongSwan via Vici API and exposes [Security Associations](https://github.com/strongswan/strongswan/blob/master/src/libcharon/plugins/vici/README.md#list-sa) (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`.
## Configuration
IPSec Prometheus exporter is configured via command-line arguments. If not provided, the default values are used.
### Command-line arguments
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"
```
## Value Definition
| 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. |
## Build & Run
To build the binary run:
```bash
make build
```
Run the binary with optional arguments provided:
```bash
./ipsec-prometheus-exporter [--server-port=8079] [--log-level=info] [--vici-network=tcp] [--vici-address=localhost:4502]
```
## Docker image
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
```