Skip to content

autumnjolitz/pfstatsd

Repository files navigation

Pfstatsd

Gather traffic statistics from PF and ingest into graphite/grafana.

Rewrite into Python 3 using asyncio.

Goal is to establish visibility of bandwidth usage by client (using pfctl -s state -v), upload bandwith QoS (pfctl -s queue -v).

Supports

  • Autoreconnects to Graphite ✅
  • PF
    • ALTQ counters ✅
      • pkts/pkt bytes, queue length
    • Number of connection states per internal client ❌
    • Packet count to an internal client ❌
  • ICMP
    • Latency ✅
    • Sent/Recv ✅
    • Lost packets ⚠️ (doesn't handle blackholes correctly yet)

Plans

  • rethink the ping resolve strat - it doesn't react well to DNS updates
    • Pings need to retry when they die due to outages, at least after 5 minutes
  • redo the main entry point - it really should be the arbiter of timeouts. And break on any future loss.

Quickstart

  1. Spin up a docker graphite image. Or provide your own graphite.
  2. Figure out how you're going to gather the data from pf. You can:
    • run pfstatsd as a user with group or other read access to /dev/pf.
    • run pfstatsd as a user that has special passwordless sudo access to just pfctl -s queue -v command
      • requires use_sudo: true in a config or --sudo argument
    • run pfstatsd as root lol
  3. Run a config python -m pfstatsd from config/example.yml or python -m pfstatsd --sudo run -t 5 127.0.0.1:2004 yahoo.com google.com

Issues

No ALTQ support in kernel

You're not going to get any data from the PF part. That's for sure.

About

Python3/Asyncio Graphite Bandwidth Health

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages