Documentation Edit this page

Documentation

GitHub release GitHub contributors License: MIT

Here is the official documentation for our PoliGraf project. You’ll find on the left menu all the documentation pages, grouped by category

Web Admin

What we wanted to achieve was to make an appliance as easy to use as possible. Therefore we developed some tools to make your life easier using PoliGraf. First, the Home page let you monitor the health of your appliance thanks to collectd. Every tools are available through the web interface thanks to predefined dashboards like PoliGraf Web Admin or PoliGraf VI Offline Inventory. Just navigate to your PoliGraf web-ui with your favorite browser and select one of these dashboards. You will have access then to the tool grid which let you select what you want to access to. As we will add more features to PoliGraf, we may also add other web tools in this section, so it may evolve in the future.

VMware VSAN

The metrics used in the various vSAN dashboards are collected every minutes using to the QueryVsanStatistics API method of HostVsanInternalSystem. With some json ticks, it is possible to access any metrics from the vSAN cluster. And guess what! We’re already working on other cool SexiPanels for VSAN…

VMware vSphere

Fast. Very fast. That’s what we had in mind when we designed PoliGraf. When you need vSphere metrics, the obvious way is the PerformanceManager, but we need something faster so we choosed managed object properties and quickstats like ResourcePoolQuickStats. If we have no other choice, we failback to the PerformanceManager but we only query the last 15 samples of the RealTime samplingPeriod since we pull vSphere metrics every 5 minutes.

FreeNAS

Starting from version 9.10, FreeNAS allows users to set a “Remote Graphite Server” target to send all the metrics harvested by Collectd. Guess what would make a nice Graphite target! The FreeNAS SexiPanel (Available in PoliGraf 0.99c) let you monitor (one of) your FreeNAS server(s) in a “single pane of glass” experience. The “partition” and “interface” drop down menus let you select one, some or all of the ZFS datasets and network interfaces, including LACP LAGG. The ARC row let you check the ZFS Adaptive Replacement Cache usage and hit ratio. The HD row is a stacked histogram of the disks IOs. Say goodbye to the oldish RRD style reporting tabs, just set the ip address of your PoliGraf appliance as Graphite target and reboot your FreeNAS to apply 😉

Windows

Leveraging the built-in Graphite listener of PoliGraf, we introduced Windows support in version 0.99c with basic cpu-ram-hdd metrics. To push the metrics we chose to use the recommended Windows version of collectd, SSC Serv. After instaling the lightweight agent, just add your PoliGraf appliance IP address with “SSC.” as prefix and you’re good to go. Now you can monitor your VEEAM proxies, like a boss!

S.M.A.R.T.

Since the first release we wanted to add a SMART counters dashboard because we were so inspired by the Backblaze reports. But we never found a proper way to get those stats from any kind of NAS so we decided to rely on a custom script that pushes the data to graphite using netcat 😉

pfSense

Because we love and use pfSense very much since the m0n0wall fork, we decided to make a great dashboard with system metrics, interface statistics but most importantly the pfinfo data which let you monitor the packet filtering service of the firewall.