Skip to content

Commit

Permalink
fixup! Refactor config and get rid of some dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
laura-zelenku committed Dec 30, 2024
1 parent 1992610 commit 3458dd4
Showing 1 changed file with 16 additions and 23 deletions.
39 changes: 16 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,34 @@
# IPsec Prometheus Exporter
# 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._
_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.
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.

```
# server port where the collected metrics are available
--server-port=8079
# logging level
--log-level=INFO
# Vici network scheme - tcp, udp or unix
--vici-network=tcp
# Vici address is the ip-address or hostname with port or unix socket path.
# IPv6 is supported. Use address in format of "[fd12:3456:789a::1]:4502".
--vici-address=localhost:4502
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. |
| 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:
Expand All @@ -45,7 +38,7 @@ 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]
./ipsec-prometheus-exporter [--server-port=8079] [--log-level=info] [--vici-network=tcp] [--vici-address=localhost:4502]
```

## Docker image
Expand Down

0 comments on commit 3458dd4

Please sign in to comment.