Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: ArthurMitchell42 <[email protected]>
  • Loading branch information
ArthurMitchell42 authored Jan 19, 2024
1 parent a3538f5 commit ebd26c1
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,14 @@
<h2 id="introduction">A Network UPS Tools (NUT) and APC daemon exporter to pass data to Prometheus and any JSON compatible applications</h2>
<h3 id="key-features">Key features</h3>
<h4>
<ul>
<li>Supports pulling data from a NUT server and formatting the UPS status for the <a href="https://prometheus.io/">Prometheus</a> logging system</li> as text
<li>Supports pulling data from both <b>NUT and APC daemon servers</b> and formatting the UPS status to JSON</li>
<li>JSON formatting is compatible with the beautiful <a href="https://gethomepage.dev">HomePage</a> app.</li>
<li>The JSON output can be used with <a href="https://github.com/louislam/uptime-kuma">Uptime Kuma</a> and other reporting, alarming and monitoring apps.</li>
<li>Provides diagnostic information and usage information.</li>
</ul>
</h4>

* A graphic interface showing key data over time with diagnostic information. <img src="https://img.shields.io/badge/New_in_V0.3.0_Beta_1-8A2BE2">
* Supports pulling data from NUT and APC servers and formatting the UPS status for the [Prometheus](https://prometheus.io/) logging system
* Supports formatting the UPS status as JSON for use with the beautiful [HomePage](https://gethomepage.dev/) app.
* The JSON output can be used with [Uptime Kuma](https://github.com/louislam/uptime-kuma) and other reporting, alarming and monitoring apps.
* Provides diagnostic information and usage information.
* Supports APC apcupsd servers for graphic display **and** metric scraping - **Use one Prometheus and Grafana dashboard for all servers.**
* Supports filtering of JSON elements to support simple monitoring apps. See [Filtering the JSON](https://github.com/ArthurMitchell42/nutcase/wiki/Using-the-JSON-returned-by-NUTCase#filtering-the-json-) <img src="https://img.shields.io/badge/New_in_V0.3.0_Beta_4-8A2BE2">

### How It Works

Expand Down

0 comments on commit ebd26c1

Please sign in to comment.