ncareau/pfsense-to-influxdb repository overview

⁠pfSense-to-InfluxDB

This program is built to collect information from pfSense and send it to InfluxDB. The eventual goal in creating this program was to provide pfSense metrics and alerts to Grafana. The program uses FauxAPI to call the native PHP functions pfSense uses to create widgets on its dashboard.

Note: pfSense-to-InfluxDB is not intended to be installed on pfSense since pfSense doesn't ship with python3 installed. Installing on your InfluxDB host or another host is recommended.

⁠Installation

1. Install and configure FauxAPI⁠ on your pfSense router. Remember to add a new user to /etc/fauxapi/credentials.ini with permissions: config_get, function_call

• Then add the following lines to /etc/fauxapi/pfsense_function_calls.txt:

gwlb.inc:function return_gateways_status($byname = false)
util.inc:function get_configured_interface_with_descr($only_opt = false, $with disabled = false)
pfsense-utils.inc:function get_interface_info($ifdescr)
openvpn.inc:function openvpn_get_active_clients()
openvpn.inc:function openvpn_get_active_servers($type="multipoint")
service-utils.inc:function get_services()
service-utils.inc:function get_service_status($service)

1. Install latest release of pfSense-to-InfluxDB.

• Using git:

git clone https://github.com/ArmaanT/pfsense-to-influxdb.git --branch v1.1.0
cd pfsense-to-influxdb

• Or download directly:

wget -O pfsense-to-influxdb.tar.gz "https://github.com/ArmaanT/pfsense-to-influxdb/archive/v1.1.0.tar.gz"
tar -xf pfsense-to-influxdb.tar.gz
mv pfsense-to-influxdb-* pfsense-to-influxdb
rm pfsense-to-influxdb.tar.gz
cd pfsense-to-influxdb

1. Install requirements:

pip3 install -r requirements.txt

⁠Docker

You can use docker to run this application quickly.

docker run -v settings.conf:/app/config/settings.conf ncareau/pfsense-to-influxdb:latest

⁠Configuration

Rename settings.sample.conf to settings.conf and add your desired settings:

⁠General

⁠FauxAPI

⁠InfluxDB

⁠Modules

⁠Start at boot

A sample systemd service file, pfsense_influx_collector.service, is included to automatically run pfSense-to-InfluxDB on boot. Open the file to change the following lines to reflect your user and path to pfSenseInfluxCollector.py:

User=CHANGEME
ExecStart=/usr/bin/python3 /path/to/pfSenseInfluxCollector.py

Then install, enable, and start pfsense_influx_collector.service:

sudo cp pfsense_influx_collector.service /etc/systemd/system/pfsense_influx_collector.service
sudo systemctl enable pfsense_influx_collector.service
sudo systemctl start pfsense_influx_collector.service

⁠Grafana

A sample pfsense_dashboard.json is provided. First, add your pfsense InfluxDB database as a Grafana Data Source. Then to import the dashboard: hover over the create dashboard button (the plus sign) in Grafana, click "Import" and upload the dashboard.json file or paste the contents of the file in the text box and click "Load".

⁠Updating

• Using git:

cd /path/to/pfsense-to-influxdb
git pull origin v1.1.0

• Downloading directly

cd /tmp/
wget -O pfsense-to-influxdb.tar.gz "https://github.com/ArmaanT/pfsense-to-influxdb/archive/v1.1.0.tar.gz"
tar -xf pfsense-to-influxdb.tar.gz
mv pfsense-to-influxdb-*/* /path/to/previously-installed/pfsense-to-influxdb/
rm pfsense-to-influxdb.tar.gz
rm -r pfsense-to-influxdb-*

⁠InfluxDB Schema

⁠Measurement: gateway_status

⁠Measurement: interface_statistics

⁠Measurement: interface_status

⁠Measurement: openvpn_client_status

⁠Measurement: openvpn_connected_clients

⁠Measurement: services_status

⁠License

Licensed under the terms of the MIT license. See LICENSE.md⁠