From 04b7e0a7721b8949916c0a0927c876ce428380a8 Mon Sep 17 00:00:00 2001 From: Nick Babcock Date: Thu, 26 Jul 2018 20:41:02 -0500 Subject: [PATCH] Update readme to mention prometheus configuration --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 713a7f2..24ef684 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # OhmGraphite -OhmGraphite takes the hard work of extracting hardware sensors from [Open Hardware Monitor](http://openhardwaremonitor.org/) (technically [LibreHardwareMonitor](https://github.com/LibreHardwareMonitor/LibreHardwareMonitor) for most up to date hardware) and exports the data in a [graphite](https://graphiteapp.org/) (or [InfluxdDB](https://www.influxdata.com/)) compatible format. OhmGraphite is for those missing any of the following in [Grafana](https://grafana.com/) or (other time series UI): +OhmGraphite takes the hard work of extracting hardware sensors from [Open Hardware Monitor](http://openhardwaremonitor.org/) (technically [LibreHardwareMonitor](https://github.com/LibreHardwareMonitor/LibreHardwareMonitor) for most up to date hardware) and exports the data in a [graphite](https://graphiteapp.org/) (or [InfluxdDB](https://www.influxdata.com/) / [Prometheus](https://prometheus.io/)) compatible format. OhmGraphite is for those missing any of the following in [Grafana](https://grafana.com/) or (other time series UI): - Breakdown of GPU utilization - Fan speed @@ -11,7 +11,7 @@ OhmGraphite takes the hard work of extracting hardware sensors from [Open Hardwa ## Who's this for? -- People who are familiar with Graphite / InfluxDB / Grafana and may have an instance running on their home or cloud server. If you're not familiar with those applications, it may be overwhelming to setup and maintain them. If you're just looking for a UI for hardware sensors, I'd recommend [HWINFO](https://www.hwinfo.com/) +- People who are familiar with Graphite (or InfluxDB / Prometheus) / Grafana and may have an instance running on their home or cloud server. If you're not familiar with those applications, it may be overwhelming to setup and maintain them. If you're just looking for a UI for hardware sensors, I'd recommend [HWINFO](https://www.hwinfo.com/) - People who know how to execute commands on Windows Command Prompt or other terminal - People who like lightweight (8MB of RAM and neglible CPU usage), portable (can run off usb), and straightforward applications @@ -89,6 +89,21 @@ Graphite is the default export style, but if you're an InfluxDB user you can cha ``` +### Prometheus Configuration + +The Prometheus will create a server that listens on `prometheus_port`. The Prometheus configuration does not routinely poll the sensor instead it only polls them when a Prometheus server requests data. + +```xml + + + + + + + + +``` + ### Upgrades - Stop OhmGraphite service `.\OhmGraphite.exe stop`