Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 1.75 KB

README.md

File metadata and controls

54 lines (37 loc) · 1.75 KB
Raw

fastd-exporter

This is a prometheus exporter for the fastd VPN daemon.

It queries information from fastd by relying on its status socket, that exposes metadata in the JSON format.

We are happy to discuss the fastd-exporter with you on IRC and Matrix

Install

Download the latest release artifact or build it yourself:

go get git.darmstadt.ccc.de/ffda/infra/fastd-exporter

Usage

The exporter supports multiple fastd instances, that must be passed as arguments. Instances are currently expected to have their configuration file at /etc/fastd/<instance>/fastd.conf.

./fastd_exporter domain1 domain2 domain3

The exporter requires read access to both the fastd.conf and the status socket that is configured within it.

Additional flags exist:

Usage of ./fastd-exporter:
  -web.listen-address string
    	Address on which to expose metrics and web interface. (default ":9281")
  -web.telemetry-path string
    	Path under which to expose metrics. (default "/metrics")

By default the metrics webserver will listen on :9281, which can be changed through the --web.listen-address parameter.

Metrics

The exporter exposes both interface and peer metrics. Both include various interface counters. Per peer metrics expose the name and public key of the peer, as well as the interface its packets arrive on.