https://github.com/nukedev/pfsense-custom-telegraf-plugins
Custom metrics plugins for Telegraf using pfSense
https://github.com/nukedev/pfsense-custom-telegraf-plugins
grafana influxdb metrics pfsense telegraf
Last synced: about 1 month ago
JSON representation
Custom metrics plugins for Telegraf using pfSense
- Host: GitHub
- URL: https://github.com/nukedev/pfsense-custom-telegraf-plugins
- Owner: NukeDev
- License: gpl-3.0
- Created: 2023-06-21T10:32:33.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-06T22:32:38.000Z (5 months ago)
- Last Synced: 2025-03-25T04:57:27.839Z (about 2 months ago)
- Topics: grafana, influxdb, metrics, pfsense, telegraf
- Language: PHP
- Homepage:
- Size: 62.5 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Install
These plugins are used to add custom metrics, which can be sent with Telegraf to an influx db. These metrics are usually displayed later with Grafana.
There are currently 3 plugins:
- **telegraf_pfifgw.php**: Collects additional information about network cards, including gateway, packet loss and ping.
- **telegraf_temperature.sh**: Collects system and CPU temperatures.
- **telegraf_pinger_ploss.sh**: Allows collecting the ping in ms and packet loss in percentage, of some hosts that can be configured within it.
- **telegraf_old_gateways.py (for pfSense < 2.4.5)**: Collects additional information gateway, rtt, rttsd and loss.
- **telegraf_new_gateways.py (for pfSense >= 2.4.5)**: Collects additional information gateway, rtt, rttsd and loss.
Plugins can be added on pfSense using the "Filer" package.
Files created must have permissions **0755**
Next, the advanced configuration of Telegraf, again on pfSense, must be modified by importing the previously created files with the correct path.
# Additional configuration for Telegraf
### pfSense < 2.4.5
```
[[inputs.exec]]
commands = [
"/usr/local/libexec/telegraf/telegraf_old_gateways.py",
"/usr/local/bin/telegraf_pfifgw.php",
"sh /usr/local/bin/telegraf_temperature.sh",
"sh /usr/local/bin/telegraf_pinger_ploss.sh"
]
timeout = "10s"
data_format = "influx"
```
### pfSense >= 2.4.5
```
[[inputs.exec]]
commands = [
"/usr/local/libexec/telegraf/telegraf_new_gateways.py",
"/usr/local/bin/telegraf_pfifgw.php",
"sh /usr/local/bin/telegraf_temperature.sh",
"sh /usr/local/bin/telegraf_pinger_ploss.sh"
]
timeout = "10s"
data_format = "influx"
```
## Grafana Dashboard
- **grafana-dashboard.json**: This is my personal grafana dashboard, you can download it and import into yours.